You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com. For cross-site search, click Search all in the search results.

Updates all API Product Attributes

Resource Summary

Security

Content Type

application/json, text/xml

Category

API Product,

updateProdAllAttributes

POST

Updates all API Product Attributes

Updates or creates API product attributes.


This API replaces the current list of attributes with the attributes specified in the request body. This lets you update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body.


Apigee Edge for Public Cloud only: 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 these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.

 

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/apiproducts/{apiproduct_name}/attributes

Header Parameters

Name Values Description
Content-Type
(required)

Specify Content Type as application/json or text/xml.

Request Body

Name Description Default Required?
attribute Arbitrary name/value pairs.

Note: With Apigee Edge for Public Cloud, the custom attribute limit is 18.


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's in development and then change access to public when it's 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 example:

       "attributes": [
        {
          "name": "access",
          "value": "public"
        }
      ]
For monetization, you can use the attributes field to specify transaction success criteria. For example:

       "attributes": [
        {
          "name": "MINT_TRANSACTION_SUCCESS_CRITERIA",
          "value": "txProviderStatus == 'OK'"
        }
      ]
In addition, for monetization you can use the attributes field to specify custom attributes on which you base rate plan charges. For example:

       "attributes": [
        {
          "name": "MINT_CUSTOM_ATTRIBUTE_1",
          "value": "test1"
        }
      ]
N/A Yes

org_name Mention the organization name true

apiproduct_name Mention the API Product name true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)