REST Resource: organizations.apiproducts

Resource: ApiProduct

JSON representation
{
  "name": string,
  "displayName": string,
  "approvalType": string,
  "attributes": [
    {
      object (Attribute)
    }
  ],
  "description": string,
  "apiResources": [
    string
  ],
  "environments": [
    string
  ],
  "proxies": [
    string
  ],
  "quota": string,
  "quotaInterval": string,
  "quotaTimeUnit": string,
  "scopes": [
    string
  ],
  "createdAt": string,
  "lastModifiedAt": string
}
Fields
name

string

The internal name of the API Product. Characters you can use in the name are restricted to: A-Z0-9._-$ %.

displayName

string

The name to be displayed in the UI or developer portal to developers registering for API access.

approvalType

string

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.

attributes[]

object (Attribute)

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.

For monetization, you can use the attributes field to:

description

string

An overview of the API product. Include key information about the API product that is not captured by other fields.

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:

environments[]

string

A 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'.

proxies[]

string

A 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.

Edge rejects requests to API proxies that are not listed.

quota

string

The 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.

quotaInterval

string

The time interval over which the number of request messages is calculated.

quotaTimeUnit

string

The time unit defined for the quotaInterval. Valid values include minute, hour, day, or month.

scopes[]

string

A comma-separated list of OAuth scopes that are validated at runtime. Edge validates that the scopes in any access token presented match the scopes defined in the OAuth policy assoicated with the API product.

createdAt

string (int64 format)

Response only. Creation time of this environment as milliseconds since epoch.

lastModifiedAt

string (int64 format)

Response only. Modified time of this environment as milliseconds since epoch.

Methods

attributes

Updates or creates API product attributes.

create

Creates an API product in an organization.

delete

Deletes an API product from an organization.

get

Gets configuration details for an API product.

list

Lists all API product names for an organization.

update

Updates an existing API product.