NOTE: Some aspects of this product are in Beta. The hybrid installation options are GA. To join the Beta program, reach out to your Apigee representative.

Method: organizations.instances.list

Lists all Apigee runtime instances for the organization.

Note: Not supported for Apigee hybrid.

HTTP request

GET https://apigee.googleapis.com/v1/{parent=organizations/*}/instances

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
pageSize

integer

Maximum number of instances to return. Defaults to 25.

pageToken

string

Page token, returned from a previous instances.list call, that you can use to retrieve the next page of content.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response for instances.list.

JSON representation
{
  "instances": [
    {
      object (Instance)
    }
  ],
  "nextPageToken": string
}
Fields
instances[]

object (Instance)

Instances in the specified organization.

nextPageToken

string

Page token that you can include in a ListInstance request to retrieve the next page of content. If omitted, no subsequent pages exist.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform