- Resource: ApiProduct
- OperationGroup
- OperationConfig
- Operation
- Quota
- GraphQLOperationGroup
- GraphQLOperationConfig
- GraphQLOperation
- Methods
Resource: ApiProduct
JSON representation | |
---|---|
{ "name": string, "displayName": string, "approvalType": string, "attributes": [ { object ( |
Fields | |
---|---|
name |
Internal name of the API product. Characters you can use in the name are restricted to: Note: The internal name cannot be edited when updating the API product. |
displayName |
Name displayed in the UI or developer portal to developers registering for API access. |
approvalType |
Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to If set to Note: Typically, |
attributes[] |
Array 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 Only products marked API products marked as |
description |
Description of the API product. Include key information about the API product that is not captured by other fields. Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the You can select a specific path, or you can select all subpaths with the following wildcard:
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 |
apiResources[] |
|
environments[] |
Comma-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 |
proxies[] |
Comma-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. |
quota |
Number of request messages permitted per app by this API product for the specified For example, a |
quotaInterval |
Time interval over which the number of request messages is calculated. |
quotaTimeUnit |
Time unit defined for the |
scopes[] |
Comma-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. |
createdAt |
Response only. Creation time of this environment as milliseconds since epoch. |
lastModifiedAt |
Response only. Modified time of this environment as milliseconds since epoch. |
operationGroup |
Configuration 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 Note: The |
graphqlOperationGroup |
Configuration 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. |
OperationGroup
List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy.
JSON representation | |
---|---|
{
"operationConfigs": [
{
object ( |
Fields | |
---|---|
operationConfigs[] |
Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product. |
operationConfigType |
Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values are |
OperationConfig
OperationConfig binds the resources in a proxy or remote service with the allowed REST methods and its associated quota enforcement.
JSON representation | |
---|---|
{ "apiSource": string, "operations": [ { object ( |
Fields | |
---|---|
apiSource |
Required. API proxy or remote service name with which the resources, methods, and quota are associated. |
operations[] |
List of resource/method pairs for the proxy/remote service, upon which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided. |
quota |
Quota parameters to be enforced for the resources, methods, apiSource combination. If none are specified, quota enforcement will not be done. |
attributes[] |
Custom attributes associated with the operation. |
Operation
Operation represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.
JSON representation | |
---|---|
{ "resource": string, "methods": [ string ] } |
Fields | |
---|---|
resource |
Required. resource represents REST resource path associated with the proxy/remote service. |
methods[] |
methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed. |
Quota
Quota contains the essential parameters needed that can be applied on a proxy/remote service, resources and methods combination associated with this API product. While setting of Quota is optional, setting it prevents requests from exceeding the provisioned parameters.
JSON representation | |
---|---|
{ "limit": string, "interval": string, "timeUnit": string } |
Fields | |
---|---|
limit |
Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected. |
interval |
Required. Time interval over which the number of request messages is calculated. |
timeUnit |
Time unit defined for the |
GraphQLOperationGroup
List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy.
JSON representation | |
---|---|
{
"operationConfigs": [
{
object ( |
Fields | |
---|---|
operationConfigs[] |
Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product. |
operationConfigType |
Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values are |
GraphQLOperationConfig
GraphQLOperationConfig binds the resources in a proxy or remote service with the graphQL operation and its associated quota enforcement.
JSON representation | |
---|---|
{ "apiSource": string, "operations": [ { object ( |
Fields | |
---|---|
apiSource |
Required. API proxy endpoint or remote service name with which the graphQL operation, and quota are associated. |
operations[] |
Required. List of graphQL name/Operation type pairs for the proxy/remote service, upon which quota will be applied. If GraphQLOperation operation has only the operation type(s), that would imply that quota will be applied on all graphQL requests irrespective of the graphQL name. Note: Currently, we can specify only a single GraphQLOperation. Specifying more than one will result in failure of the operation. |
quota |
Quota parameters to be enforced for the resources, methods, apiSource combination. If none are specified, quota enforcement will not be done. |
attributes[] |
Custom attributes associated with the operation. |
GraphQLOperation
GraphQLOperation represents the pairing of graphQL operation types and the graphQL operation name.
JSON representation | |
---|---|
{ "operationType": [ string ], "operation": string } |
Fields | |
---|---|
operationType[] |
Required. |
operation |
GraphQL operation name, along with operation type which will be used to associate quotas with. If no name is specified, the quota will be applied to all graphQL operations irrespective of their operation names in the payload. |
Methods |
|
---|---|
|
Updates or creates API product attributes. |
|
Creates an API product in an organization. |
|
Deletes an API product from an organization. |
|
Gets configuration details for an API product. |
|
Lists all API product names for an organization. |
|
Updates an existing API product. |