Apigee · Schema

ApiProxy

Metadata about an API proxy.

Advanced API SecurityAgentic AIAnalyticsAPI GatewayAPI GovernanceAPI HubAPI ManagementDeveloper PortalEnterpriseGenerative AIHybridIntegrationMicroservicesMCPMonetization

Properties

Name	Type	Description
name	string	Output only. Name of the API proxy.
revision	array	Output only. List of revisions defined for the API proxy.
latestRevisionId	string	Output only. The ID of the most recently created revision.
metaData	object
labels	object	User-defined labels for organizing API proxies.
readOnly	boolean	Output only. Whether this proxy is read-only.
apiProxyType	string	Type of the API proxy.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiProxy",
  "title": "ApiProxy",
  "type": "object",
  "description": "Metadata about an API proxy.",
  "properties": {
    "name": {
      "type": "string",
      "description": "Output only. Name of the API proxy.",
      "readOnly": true
    },
    "revision": {
      "type": "array",
      "description": "Output only. List of revisions defined for the API proxy.",
      "readOnly": true,
      "items": {
        "type": "string"
      }
    },
    "latestRevisionId": {
      "type": "string",
      "description": "Output only. The ID of the most recently created revision.",
      "readOnly": true
    },
    "metaData": {
      "$ref": "#/components/schemas/EntityMetadata"
    },
    "labels": {
      "type": "object",
      "description": "User-defined labels for organizing API proxies.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "readOnly": {
      "type": "boolean",
      "description": "Output only. Whether this proxy is read-only.",
      "readOnly": true
    },
    "apiProxyType": {
      "type": "string",
      "description": "Type of the API proxy.",
      "enum": [
        "API_PROXY_TYPE_UNSPECIFIED",
        "PROGRAMMABLE",
        "CONFIGURABLE"
      ]
    }
  }
}