2025-12-20
▼ ▲ apigee.organizations.apimServiceExtensions.create
Path : v1/{+parent}/apimServiceExtensions
Flat Path : v1/organizations/{organizationsId}/apimServiceExtensions
HTTP Method : POST
Parameters :
parent
Description : Required. Name of the organization in which the service extension will be created. Use the following structure in your request: `organizations/{org}`
Pattern : ^organizations/[^/]+$
Location : path
Required : Yes
Type : string
apimServiceExtensionId
Description : Optional. ID used to uniquely identify of the service extension. It must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an APIM ServiceExtension in an organization.
▼ ▲ apigee.organizations.apimServiceExtensions.get
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/apimServiceExtensions/{apimServiceExtensionsId}
HTTP Method : GET
Parameters :
name
Description : Required. Name of the service extension. Use the following structure in your request: `organizations/{org}/apimServiceExtensions/{extension_id}`
Pattern : ^organizations/[^/]+/apimServiceExtensions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets APIM service extension details.
▼ ▲ apigee.organizations.apimServiceExtensions.list
Path : v1/{+parent}/apimServiceExtensions
Flat Path : v1/organizations/{organizationsId}/apimServiceExtensions
HTTP Method : GET
Parameters :
parent
Description : Required. Name of the organization for which to list the service extension. Use the following structure in your request: `organizations/{org}/apimServiceExtensions`
Pattern : ^organizations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Maximum number of items to return. If unspecified, at most 25 service extension will be returned.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. Page token, returned from a previous `ListApimServiceExtensions` call, that you can use to retrieve the next page.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all APIM service extensions in an organization.
▼ ▲ apigee.organizations.apimServiceExtensions.patch
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/apimServiceExtensions/{apimServiceExtensionsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. unique name of the APIM service extension. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
Pattern : ^organizations/[^/]+/apimServiceExtensions/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
allowMissing
Description : Optional. If set to true, and the service extension is not found, a new service extension will be created. In this situation, `update_mask` is ignored.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an APIM service extension in an organization.
▼ ▲ apigee.organizations.apimServiceExtensions.delete
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/apimServiceExtensions/{apimServiceExtensionsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Name of the service extension. Use the following structure in your request: `organizations/{org}/apimServiceExtensions/{extension_id}`
Pattern : ^organizations/[^/]+/apimServiceExtensions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes APIM service extension from an organization.
▼ ▲ apigee.organizations.appgroups.getBalance
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/appgroups/{appgroupsId}/balance
HTTP Method : GET
Parameters :
name
Description : Required. Account balance for the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group}/balance`
Pattern : ^organizations/[^/]+/appgroups/[^/]+/balance$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the account balance for the AppGroup.
▼ ▲ apigee.organizations.appgroups.getMonetizationConfig
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/appgroups/{appgroupsId}/monetizationConfig
HTTP Method : GET
Parameters :
name
Description : Required. Monetization configuration for the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group}/monetizationConfig`
Pattern : ^organizations/[^/]+/appgroups/[^/]+/monetizationConfig$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the monetization configuration for the AppGroup.
▼ ▲ apigee.organizations.appgroups.updateMonetizationConfig
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/appgroups/{appgroupsId}/monetizationConfig
HTTP Method : PUT
Parameters :
name
Description : Required. Monetization configuration for the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group}/monetizationConfig`
Pattern : ^organizations/[^/]+/appgroups/[^/]+/monetizationConfig$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the monetization configuration for the AppGroup.
▼ ▲ apigee.organizations.appgroups.subscriptions.create
Path : v1/{+parent}/subscriptions
Flat Path : v1/organizations/{organizationsId}/appgroups/{appgroupsId}/subscriptions
HTTP Method : POST
Parameters :
parent
Description : Required. Name of the appgroup that is purchasing a subscription to the API product. Use the following structure in your request: `organizations/{org}/appgroups/{appgroup}`
Pattern : ^organizations/[^/]+/appgroups/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a subscription to an API product.
▼ ▲ apigee.organizations.appgroups.subscriptions.get
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/appgroups/{appgroupsId}/subscriptions/{subscriptionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the AppGroupSubscription to retrieve. Format: `organizations/{org}/appgroups/{appgroup}/subscriptions/{subscription}`
Pattern : ^organizations/[^/]+/appgroups/[^/]+/subscriptions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get an api product subscription for an appgroup.
▼ ▲ apigee.organizations.appgroups.subscriptions.list
Path : v1/{+parent}/subscriptions
Flat Path : v1/organizations/{organizationsId}/appgroups/{appgroupsId}/subscriptions
HTTP Method : GET
Parameters :
parent
Description : Required. Name of the appgroup. Use the following structure in your request: `organizations/{org}/appgroups/{appgroup}`
Pattern : ^organizations/[^/]+/appgroups/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 100 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListAppGroupSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAppGroupSubscriptions` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List all api product subscriptions for an appgroup.
▼ ▲ apigee.organizations.appgroups.subscriptions.expire
Path : v1/{+name}:expire
Flat Path : v1/organizations/{organizationsId}/appgroups/{appgroupsId}/subscriptions/{subscriptionsId}:expire
HTTP Method : POST
Parameters :
name
Description : Required. Name of the API product subscription. Use the following structure in your request: `organizations/{org}/appgroups/{appgroup}/subscriptions/{subscription}`
Pattern : ^organizations/[^/]+/appgroups/[^/]+/subscriptions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Expires an API product subscription immediately.
▼ ▲ apigee.organizations.appgroups.balance.credit
Path : v1/{+name}:credit
Flat Path : v1/organizations/{organizationsId}/appgroups/{appgroupsId}/balance:credit
HTTP Method : POST
Parameters :
name
Description : Required. Account balance for the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group}/balance`
Pattern : ^organizations/[^/]+/appgroups/[^/]+/balance$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Credits the account balance for the AppGroup.
▼ ▲ apigee.organizations.appgroups.balance.adjust
Path : v1/{+name}:adjust
Flat Path : v1/organizations/{organizationsId}/appgroups/{appgroupsId}/balance:adjust
HTTP Method : POST
Parameters :
name
Description : Required. Account balance for the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group}/balance`
Pattern : ^organizations/[^/]+/appgroups/[^/]+/balance$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Adjust the prepaid balance for the AppGroup. This API will be used in scenarios where the AppGroup has been under-charged or over-charged.