Skip to main content

apiproducts

Creates, updates, deletes, gets or lists an apiproducts resource.

Overview​

Nameapiproducts
TypeResource
Idgoogle.apigee.apiproducts

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringInternal name of the API product. Characters you can use in the name are restricted to: A-Z0-9._\-$ %. Note: The internal name cannot be edited when updating the API product.
apiResourcesarrayComma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the proxy.pathsuffix variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the apiResources element is defined to be /forecastrss and the base path defined for the API proxy is /weather, then only requests to /weather/forecastrss are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - /**: Indicates that all sub-URIs are included. - /* : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is /v1/weatherapikey, then the API product supports requests to /v1/weatherapikey and to any sub-URIs, such as /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, and so on. For more information, see Managing API products.
approvalTypestringFlag that specifies how API keys are approved to access the APIs defined by the API product. If set to manual, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to auto, the consumer key is generated and returned in "approved" state and can be used immediately. Note: Typically, auto is used to provide access to free or trial API products that provide limited quota or capabilities.
attributesarrayArray of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either public, private, or internal. Only products marked public are available to developers in the Apigee developer portal. For example, you can set a product to internal while it is in development and then change access to public when it is ready to release on the portal. API products marked as private do not appear on the portal, but can be accessed by external developers.
createdAtstring (int64)Response only. Creation time of this environment as milliseconds since epoch.
descriptionstringDescription of the API product. Include key information about the API product that is not captured by other fields.
displayNamestringName displayed in the UI or developer portal to developers registering for API access.
environmentsarrayComma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in prod from being accessed by API proxies deployed in test.
graphqlOperationGroupobjectConfiguration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type. (id: GoogleCloudApigeeV1GraphQLOperationGroup)
grpcOperationGroupobjectOptional. Configuration used to group Apigee proxies with gRPC services and method names. This grouping allows us to set quota for a particular proxy with the gRPC service name and method. If a method name is not set, this implies quota and authorization are applied to all gRPC methods implemented by that proxy for that particular gRPC service. (id: GoogleCloudApigeeV1GrpcOperationGroup)
lastModifiedAtstring (int64)Response only. Modified time of this environment as milliseconds since epoch.
operationGroupobjectConfiguration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the quota setting). Note: The api_resources setting cannot be specified for both the API product and operation group; otherwise the call will fail. (id: GoogleCloudApigeeV1OperationGroup)
proxiesarrayComma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. Note: The API proxy names must already exist in the specified environment as they will be validated upon creation.
quotastringNumber of request messages permitted per app by this API product for the specified quotaInterval and quotaTimeUnit. For example, a quota of 50, for a quotaInterval of 12 and a quotaTimeUnit of hours means 50 requests are allowed every 12 hours.
quotaCounterScopestringScope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.
quotaIntervalstringTime interval over which the number of request messages is calculated.
quotaTimeUnitstringTime unit defined for the quotaInterval. Valid values include minute, hour, day, or month.
scopesarrayComma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.
spacestringOptional. The resource ID of the parent Space. If not set, the parent resource will be the Organization. To learn how Spaces can be used to manage resources, read the Apigee Spaces Overview.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
organizations_apiproducts_getselectorganizationsId, apiproductsIdGets configuration details for an API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.
organizations_apiproducts_listselectorganizationsIdattributename, attributevalue, expand, startKey, count, spaceLists all API product names for an organization. Filter the list by passing an attributename and attibutevalue. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the startKey and count query parameters. If the resource has the space attribute set, the response may not return all resources. To learn more, read the Apigee Spaces Overview.
organizations_apiproducts_createinsertorganizationsIdCreates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on the fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer-grained API products, defining different sets of API resources for each API product. WARNING: - If you don't specify an API proxy in the request body, any app associated with the product can make calls to any API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see What is an API product?
organizations_apiproducts_updatereplaceorganizationsId, apiproductsIdUpdates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names.
organizations_appgroups_apps_keys_apiproducts_deletedeleteorganizationsId, appgroupsId, appsId, keysId, apiproductsIdRemoves an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. Note: The consumer key is not removed, only its association with the API product.
organizations_apiproducts_deletedeleteorganizationsId, apiproductsIdDeletes an API product from an organization. Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.
organizations_apiproducts_moveexecorganizationsId, apiproductsIdMoves an API product to a different space.
organizations_apiproducts_attributesexecorganizationsId, apiproductsIdUpdates or creates API product attributes. This API replaces the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.
organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_productexecorganizationsId, appgroupsId, appsId, keysId, apiproductsIdactionApproves or revokes the consumer key for an API product. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee checks the status of the consumer key and if set to revoked will not allow access to the API.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
apiproductsIdstring
appgroupsIdstring
appsIdstring
keysIdstring
organizationsIdstring
actionstring
attributenamestring
attributevaluestring
countstring (int64)
expandboolean
spacestring
startKeystring

SELECT examples​

Gets configuration details for an API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.

SELECT
name,
apiResources,
approvalType,
attributes,
createdAt,
description,
displayName,
environments,
graphqlOperationGroup,
grpcOperationGroup,
lastModifiedAt,
operationGroup,
proxies,
quota,
quotaCounterScope,
quotaInterval,
quotaTimeUnit,
scopes,
space
FROM google.apigee.apiproducts
WHERE organizationsId = '{{ organizationsId }}' -- required
AND apiproductsId = '{{ apiproductsId }}' -- required;

INSERT examples​

Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on the fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer-grained API products, defining different sets of API resources for each API product. WARNING: - If you don't specify an API proxy in the request body, any app associated with the product can make calls to any API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see What is an API product?

INSERT INTO google.apigee.apiproducts (
data__name,
data__displayName,
data__approvalType,
data__attributes,
data__description,
data__apiResources,
data__environments,
data__proxies,
data__quota,
data__quotaInterval,
data__quotaTimeUnit,
data__scopes,
data__createdAt,
data__lastModifiedAt,
data__operationGroup,
data__graphqlOperationGroup,
data__grpcOperationGroup,
data__quotaCounterScope,
data__space,
organizationsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ approvalType }}',
'{{ attributes }}',
'{{ description }}',
'{{ apiResources }}',
'{{ environments }}',
'{{ proxies }}',
'{{ quota }}',
'{{ quotaInterval }}',
'{{ quotaTimeUnit }}',
'{{ scopes }}',
'{{ createdAt }}',
'{{ lastModifiedAt }}',
'{{ operationGroup }}',
'{{ graphqlOperationGroup }}',
'{{ grpcOperationGroup }}',
'{{ quotaCounterScope }}',
'{{ space }}',
'{{ organizationsId }}'
RETURNING
name,
apiResources,
approvalType,
attributes,
createdAt,
description,
displayName,
environments,
graphqlOperationGroup,
grpcOperationGroup,
lastModifiedAt,
operationGroup,
proxies,
quota,
quotaCounterScope,
quotaInterval,
quotaTimeUnit,
scopes,
space
;

REPLACE examples​

Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names.

REPLACE google.apigee.apiproducts
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__approvalType = '{{ approvalType }}',
data__attributes = '{{ attributes }}',
data__description = '{{ description }}',
data__apiResources = '{{ apiResources }}',
data__environments = '{{ environments }}',
data__proxies = '{{ proxies }}',
data__quota = '{{ quota }}',
data__quotaInterval = '{{ quotaInterval }}',
data__quotaTimeUnit = '{{ quotaTimeUnit }}',
data__scopes = '{{ scopes }}',
data__createdAt = '{{ createdAt }}',
data__lastModifiedAt = '{{ lastModifiedAt }}',
data__operationGroup = '{{ operationGroup }}',
data__graphqlOperationGroup = '{{ graphqlOperationGroup }}',
data__grpcOperationGroup = '{{ grpcOperationGroup }}',
data__quotaCounterScope = '{{ quotaCounterScope }}',
data__space = '{{ space }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND apiproductsId = '{{ apiproductsId }}' --required
RETURNING
name,
apiResources,
approvalType,
attributes,
createdAt,
description,
displayName,
environments,
graphqlOperationGroup,
grpcOperationGroup,
lastModifiedAt,
operationGroup,
proxies,
quota,
quotaCounterScope,
quotaInterval,
quotaTimeUnit,
scopes,
space;

DELETE examples​

Removes an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. Note: The consumer key is not removed, only its association with the API product.

DELETE FROM google.apigee.apiproducts
WHERE organizationsId = '{{ organizationsId }}' --required
AND appgroupsId = '{{ appgroupsId }}' --required
AND appsId = '{{ appsId }}' --required
AND keysId = '{{ keysId }}' --required
AND apiproductsId = '{{ apiproductsId }}' --required;

Lifecycle Methods​

Moves an API product to a different space.

EXEC google.apigee.apiproducts.organizations_apiproducts_move 
@organizationsId='{{ organizationsId }}' --required, 
@apiproductsId='{{ apiproductsId }}' --required 
@@json=
'{
"space": "{{ space }}"
}';