Method: organizations.apiproducts.update

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.

HTTP request

PUT https://apigee.googleapis.com/v1/{name=organizations/*/apiproducts/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. API product name of the form: organizations/{organizationId}/apiproducts/{api_product_name}

Request body

The request body contains an instance of UpdateApiProductBody.

Response body

If successful, the response body contains an instance of ApiProduct.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

UpdateApiProductBody

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

string

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

approvalType

string

manual or auto. If manual, consumer key is generated and returned in 'pending' state. If auto consumer key generated and returned in 'Approved' state.

attributes[]

object (ApiProductAttribute)

Arbitrary name/value pairs.

description

string

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

apiResources[]

string

A comma separated list of API resources to be bundled in the API Product.

environments[]

string

A comma-separated list of environment name in an organization. Requests to environments not listed are rejected

proxies[]

string

A comma-separated list of API proxy names in an organization.

quota

string

The number of request messages permitted by this API product for the specified quotaInterval and quotaTimeUnit.

quotaInterval

string

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

quotaTimeUnit

string

The time unit defined for the quotaInterval, as either: minute, hour, day, month.

scopes[]

string

A comma separated list of scopes. These must map to the scopes defined in an Oauth policy associated with the API Product.

name

string

Name of the api product.