Apigee · Schema

Apigee Environment

An environment in an Apigee organization. Environments provide a runtime execution context for API proxies, with separate settings for caches, target servers, keystores, and more.

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

Properties

Name	Type	Description
name	string	Required. Name of the environment.
displayName	string	Display name for the environment.
description	string	Description of the environment.
state	string	Output only. State of the environment.
createdAt	string	Output only. Creation time in milliseconds since epoch.
lastModifiedAt	string	Output only. Last modification time.
deploymentType	string	Deployment type of the environment.
apiProxyType	string	Type of API proxies deployed in this environment.
properties	object	A collection of key-value property pairs.
nodeConfig	object	Runtime node configuration for the environment.
forwardProxyUri	string	Optional forward proxy URI for the environment.
type	string	Type of the environment.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/apigee/apigee-environment-schema.json",
  "title": "Apigee Environment",
  "description": "An environment in an Apigee organization. Environments provide a runtime execution context for API proxies, with separate settings for caches, target servers, keystores, and more.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Required. Name of the environment."
    },
    "displayName": {
      "type": "string",
      "description": "Display name for the environment."
    },
    "description": {
      "type": "string",
      "description": "Description of the environment."
    },
    "state": {
      "type": "string",
      "description": "Output only. State of the environment.",
      "readOnly": true,
      "enum": ["STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "UPDATING"]
    },
    "createdAt": {
      "type": "string",
      "description": "Output only. Creation time in milliseconds since epoch.",
      "readOnly": true
    },
    "lastModifiedAt": {
      "type": "string",
      "description": "Output only. Last modification time.",
      "readOnly": true
    },
    "deploymentType": {
      "type": "string",
      "description": "Deployment type of the environment.",
      "enum": ["DEPLOYMENT_TYPE_UNSPECIFIED", "PROXY", "ARCHIVE"]
    },
    "apiProxyType": {
      "type": "string",
      "description": "Type of API proxies deployed in this environment.",
      "enum": ["API_PROXY_TYPE_UNSPECIFIED", "PROGRAMMABLE", "CONFIGURABLE"]
    },
    "properties": {
      "type": "object",
      "description": "A collection of key-value property pairs.",
      "properties": {
        "property": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": { "type": "string" },
              "value": { "type": "string" }
            }
          }
        }
      }
    },
    "nodeConfig": {
      "type": "object",
      "description": "Runtime node configuration for the environment.",
      "properties": {
        "minNodeCount": {
          "type": "string",
          "description": "Minimum number of gateway nodes."
        },
        "maxNodeCount": {
          "type": "string",
          "description": "Maximum number of gateway nodes."
        },
        "currentAggregateNodeCount": {
          "type": "string",
          "description": "Output only. Current total number of gateway nodes.",
          "readOnly": true
        }
      }
    },
    "forwardProxyUri": {
      "type": "string",
      "description": "Optional forward proxy URI for the environment."
    },
    "type": {
      "type": "string",
      "description": "Type of the environment.",
      "enum": ["ENVIRONMENT_TYPE_UNSPECIFIED", "BASE", "INTERMEDIATE", "COMPREHENSIVE"]
    }
  },
  "required": ["name"]
}