Collections API

Collections enable you to group API proxies, targets, or developer apps and set up appropriate threshold values for all members of the group to diagnose issues faster. For more information, see Manage collections using the API.

Resource Types

URIs are relative to https://apimonitoring.enterprise.apigee.com, unless otherwise noted.

Collection

For more information, see Collection.
MethodEndpointDescription
get/collections

Lists collections in an organization. You can filter the list of returned collections by the Edge environment, collection type, collection name, and collection members.

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

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

post/collections

Creates a collection.

Notes:

  • You can add a maximum of 20 items to a collection.
  • Edge imposes a quota on this API. You can call this API at most six times per minute.

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

get/collections/{collection_id}

Gets a collection.

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

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

patch/collections/{collection_id}

Updates a collection. You must specify the organization in the JSON payload but all other properties are optional.

Notes:

  • You cannot change the organization, environment, or collection type when updating the collection.
  • Edge imposes a quota on this API. You can call this API at most six times per minute.
  • This API cannot be executed using the Try this API panel.

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

Collections

For more information, see Collections.
MethodEndpointDescription
get/collections

Lists collections in an organization. You can filter the list of returned collections by the Edge environment, collection type, collection name, and collection members.

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

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

Delete

For more information, see Delete.
MethodEndpointDescription
delete/collections/{collection_id}

Deletes a collection.

Notes:

  • Edge imposes a quota on this API. You can call this API at most six times per minute.
  • This API cannot be executed using the Try this API panel.

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

Error

For more information, see Error.
MethodEndpointDescription
post/collections

Creates a collection.

Notes:

  • You can add a maximum of 20 items to a collection.
  • Edge imposes a quota on this API. You can call this API at most six times per minute.

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

delete/collections/{collection_id}

Deletes a collection.

Notes:

  • Edge imposes a quota on this API. You can call this API at most six times per minute.
  • This API cannot be executed using the Try this API panel.

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

patch/collections/{collection_id}

Updates a collection. You must specify the organization in the JSON payload but all other properties are optional.

Notes:

  • You cannot change the organization, environment, or collection type when updating the collection.
  • Edge imposes a quota on this API. You can call this API at most six times per minute.
  • This API cannot be executed using the Try this API panel.

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