v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13134345498.3 KB
organizations

Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. Note: Not supported for Apigee hybrid.

post/v1/{+parent}/instances

Path parameters

parentstring required

Required. Name of the organization. Use the following structure in your request: organizations/{org}.

Request body

diskEncryptionKeyNamestring

Optional. Customer Managed Encryption Key (CMEK) used for disk and volume encryption. If not specified, a Google-Managed encryption key will be used. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)

peeringCidrRange'CIDR_RANGE_UNSPECIFIED' | 'SLASH_16' | 'SLASH_17' | 'SLASH_18' | 'SLASH_19' | 'SLASH_20' | 'SLASH_22' | 'SLASH_23'

Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support SLASH_16 to SLASH_20 and defaults to SLASH_16. Evaluation organizations support only SLASH_23.

locationstring

Required. Compute Engine location where the instance resides.

portstring

Output only. Port number of the exposed Apigee endpoint.

displayNamestring

Optional. Display name for the instance.

runtimeVersionstring

Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments.

serviceAttachmentstring

Output only. Resource name of the service attachment created for the instance in the format: projects/*/regions/*/serviceAttachments/* Apigee customers can privately forward traffic to this service attachment using the PSC endpoints.

isVersionLockedboolean

Output only. Indicates whether the instance is version locked. If true, the instance will not be updated by automated runtime rollouts. This is only supported for Apigee X instances.

createdAtstring int64

Output only. Time the instance was created in milliseconds since epoch.

lastModifiedAtstring int64

Output only. Time the instance was last modified in milliseconds since epoch.

namestring

Required. Resource ID of the instance. Values must match the regular expression ^a-z{0,30}[a-z\d]$.

hoststring

Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'DELETING' | 'UPDATING'

Output only. State of the instance. Values other than ACTIVE means the resource is not ready to use.

ipRangestring

Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: a.b.c.d/22 or e.f.g.h/28 or a.b.c.d/22,e.f.g.h/28

consumerAcceptListstring[]

Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list.

descriptionstring

Optional. Description of the instance.

Response

Successful response