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

Response for instances.list .

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

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
Design a Mobile Site
View Site in Mobile | Classic
Share by: