Apigee · Schema

Apigee API Proxy

Metadata about an API proxy in Apigee. API proxies act as facades for backend services, providing security, rate limiting, transformations, and other capabilities.

Advanced API SecurityAgentic AIAnalyticsAPI GatewayAPI GovernanceAPI HubAPI ManagementDeveloper PortalEnterpriseGenerative AIHybridIntegrationsMicroservicesMCPModel Context ProtocolMonetization

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

apigee-api-proxy-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/apigee/apigee-api-proxy-schema.json",
  "title": "Apigee API Proxy",
  "description": "Metadata about an API proxy in Apigee. API proxies act as facades for backend services, providing security, rate limiting, transformations, and other capabilities.",
  "type": "object",
  "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": "#/$defs/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"]
    }
  },
  "$defs": {
    "EntityMetadata": {
      "type": "object",
      "description": "Metadata common to Apigee entities.",
      "properties": {
        "createdAt": {
          "type": "string",
          "description": "Time the entity was created in milliseconds since epoch."
        },
        "lastModifiedAt": {
          "type": "string",
          "description": "Time the entity was last modified in milliseconds since epoch."
        },
        "subType": {
          "type": "string",
          "description": "Subtype of the entity."
        }
      }
    }
  }
}