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.

Update a Collection

Resource Summary

Security

Content Type

application/json, text/plain

Category

API Monitoring Collections,

UpdateaCollection

PATCH

Update a Collection

Update a collection by its UUID. On an update, you must specify the organization in the JSON payload but all other properties are optional.

 

Note: You cannot change the organization, environment, or collection type when updating the collection.

 

Note: Edge imposes a quota on this API. You can call this API at most six times per minute.

 

Use the Get Collections API to get all collection UUIDs.

 

For more information and examples of this API, see Manage collections using the API.

Resource URL

https://apimonitoring.enterprise.apigee.com /collections/{collection_id}

Header Parameters

Name Values Description
Authorization
(required)

OAuth token. Replace $TOKEN with your access token. See Get the tokens.

Request Body

Name Description Default Required?
organization The name of the Edge organization. N/A Yes
environment The name of the Edge environment. N/A No
name The name of the collection. N/A No
description A description of the collection. N/A No
type The type of the collection as either proxy, target, or developerApp. N/A No
members The members of the collection, seperated by commas. N/A No

collection_id Mention the collection instance ID 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?)