--- title: "POST /v1/{+parent}/apiproducts" method: POST path: "/v1/{+parent}/apiproducts" tags: ["organizations"] --- # POST /v1/{+parent}/apiproducts `POST /v1/{+parent}/apiproducts` 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? ## Path parameters - `parent` string, required ## Request body - GoogleCloudApigeeV1ApiProduct - `description` string — Description of the API product. Include key information about the API product that is not captured by other fields. - `proxies` string[] — 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. - `quotaInterval` string — Time interval over which the number of request messages is calculated. - `graphqlOperationGroup` GoogleCloudApigeeV1GraphQLOperationGroup — List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. - `operationConfigs` GoogleCloudApigeeV1GraphQLOperationConfig[] — Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product. - `apiSource` string — Required. Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated. - `operations` GoogleCloudApigeeV1GraphQLOperation[] — Required. List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. **Note**: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail. - `operationTypes` string[] — Required. GraphQL operation types. Valid values include `query` or `mutation`. **Note**: Apigee does not currently support `subscription` types. - `operation` string — GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload. - `attributes` GoogleCloudApigeeV1Attribute[] — Custom attributes associated with the operation. - `name` string — API key of the attribute. - `value` string — Value of the attribute. - `quota` GoogleCloudApigeeV1Quota — Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. - `timeUnit` string — Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null. - `interval` string — Required. Time interval over which the number of request messages is calculated. - `limit` string — Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected. - `operationConfigType` string — Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product. - `llmOperationGroup` GoogleCloudApigeeV1LlmOperationGroup — List of LLM operation configuration details associated with Apigee API proxies. - `operationConfigs` GoogleCloudApigeeV1LlmOperationConfig[] — Required. List of LLM operation configurations for either Apigee API proxies that are associated with this API product. - `apiSource` string — Required. Name of the API proxy or remote service with which the resources, methods, and quota are associated. - `llmOperations` GoogleCloudApigeeV1LlmOperation[] — Required. List of resource/method/model for the API proxy to which quota will applied. **Note**: Currently, you can specify only a single resource/method/model mapping. The call will fail if more than one resource/method/model mappings are provided. - `methods` string[] — Optional. methods refers to the REST verbs as in https://httpwg.org/specs/rfc9110.html For example: GET, POST, PUT, DELETE, etc. They need to be in uppercase. When none specified, all verb types are allowed. - `resource` string — Required. REST resource path associated with the API proxy or remote service. - `model` string — Required. LLM model name associated with the API proxy - `attributes` GoogleCloudApigeeV1Attribute[] — Optional. Custom attributes associated with the operation. - `name` string — API key of the attribute. - `value` string — Value of the attribute. - `llmTokenQuota` GoogleCloudApigeeV1LlmTokenQuota — LLM Token Quota contains the essential parameters needed that can be applied on the resources, methods, models, API source combination associated with this API product. While LLM Token Quota is optional, setting it prevents requests from exceeding the provisioned parameters. - `timeUnit` string — Optional. Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null. - `interval` string — Required. Time interval over which the number of request messages is calculated. - `limit` string — Required. Upper limit of LLM tokens allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected. - `name` string — Internal 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. - `lastModifiedAt` string, int64 — Response only. Modified time of this environment as milliseconds since epoch. - `createdAt` string, int64 — Response only. Creation time of this environment as milliseconds since epoch. - `llmQuotaInterval` string — Optional. Time interval over which the number of tokens from LLM responses is calculated. - `llmQuota` string — Optional. Number of LLM tokens permitted per app by this API product for the specified `llm_quota_interval` and `llm_quota_time_unit`. For example, an `llm_quota` of 50,000, for an `llm_quota_interval` of 12 and an `llm_quota_time_unit` of hours means 50,000 llm tokens are allowed to be used every 12 hours. - `approvalType` string — Flag 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. - `llmQuotaTimeUnit` string — Optional. Time unit defined for the `llm_quota_interval`. Valid values include `minute`, `hour`, `day`, or `month`. - `displayName` string — Name displayed in the UI or developer portal to developers registering for API access. - `quotaTimeUnit` string — Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`. - `scopes` string[] — 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. - `operationGroup` GoogleCloudApigeeV1OperationGroup — List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. - `operationConfigType` string — Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product. - `operationConfigs` GoogleCloudApigeeV1OperationConfig[] — Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product. - `quota` GoogleCloudApigeeV1Quota — Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. - `timeUnit` string — Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null. - `interval` string — Required. Time interval over which the number of request messages is calculated. - `limit` string — Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected. - `attributes` GoogleCloudApigeeV1Attribute[] — Custom attributes associated with the operation. - `name` string — API key of the attribute. - `value` string — Value of the attribute. - `apiSource` string — Required. Name of the API proxy or remote service with which the resources, methods, and quota are associated. - `operations` GoogleCloudApigeeV1Operation[] — List of resource/method pairs for the API proxy or remote service to 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. - `resource` string — Required. REST resource path associated with the API proxy or remote service. - `methods` string[] — 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. - `space` string — Optional. 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](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). - `payloadOperationGroup` GoogleCloudApigeeV1PayloadOperationGroup — List of payload operation configuration details associated with Apigee API proxies. Payload operations enable governance of protocols where operations are embedded in the request body (such as JSON-RPC) rather than defined by the URL path. - `operationConfigs` GoogleCloudApigeeV1PayloadOperationConfig[] — Required. List of payload operation configurations for Apigee API proxies that are associated with this API product. - `quota` GoogleCloudApigeeV1Quota — Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. - `timeUnit` string — Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null. - `interval` string — Required. Time interval over which the number of request messages is calculated. - `limit` string — Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected. - `apiSource` string — Required. Name of the API proxy with which the payload operations and quota are associated. - `operations` GoogleCloudApigeeV1PayloadOperation[] — Required. List of payload operations for the API proxy to which quota will be applied. - `operation` string — Required. The operation name extracted from the request payload at runtime by the ParsePayload policy. For example, for MCP protocol requests, this could be `"tools/list"` or `"tools/call/get_weather"`. Wildcards are not supported. - `attributes` GoogleCloudApigeeV1Attribute[] — Optional. Custom attributes associated with the operation. - `name` string — API key of the attribute. - `value` string — Value of the attribute. - `environments` string[] — 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 `prod` from being accessed by API proxies deployed in `test`. - `attributes` GoogleCloudApigeeV1Attribute[] — 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 `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. - `name` string — API key of the attribute. - `value` string — Value of the attribute. - `apiResources` string[] — Comma-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. - `grpcOperationGroup` GoogleCloudApigeeV1GrpcOperationGroup — List of gRPC operation configuration details associated with Apigee API proxies. - `operationConfigs` GoogleCloudApigeeV1GrpcOperationConfig[] — Required. List of operation configurations for either Apigee API proxies that are associated with this API product. - `methods` string[] — List of unqualified gRPC method names for the proxy to which quota will be applied. If this field is empty, the Quota will apply to all operations on the gRPC service defined on the proxy. Example: Given a proxy that is configured to serve com.petstore.PetService, the methods com.petstore.PetService.ListPets and com.petstore.PetService.GetPet would be specified here as simply ["ListPets", "GetPet"]. - `service` string — Required. gRPC Service name associated to be associated with the API proxy, on which quota rules can be applied upon. - `attributes` GoogleCloudApigeeV1Attribute[] — Custom attributes associated with the operation. - `name` string — API key of the attribute. - `value` string — Value of the attribute. - `apiSource` string — Required. Name of the API proxy with which the gRPC operation and quota are associated. - `quota` GoogleCloudApigeeV1Quota — Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. While Quota is optional, setting it prevents requests from exceeding the provisioned parameters. - `timeUnit` string — Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null. - `interval` string — Required. Time interval over which the number of request messages is calculated. - `limit` string — Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected. - `quota` string — Number 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. - `quotaCounterScope` 'QUOTA_COUNTER_SCOPE_UNSPECIFIED' | 'PROXY' | 'OPERATION' | 'PRODUCT' — Scope 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. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/apigee.md) · [All operations](https://skmtc.net/google/apis/apigee/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/apigee/versions/6e272fa448a7/schema)