Downloading a Catalog item with the API

The download API call allows you to download a Catalog item.

Note

The API calls are authenticated using organization keys. Make sure you use a key that has the Download Catalog versions permission and add it to the HTTP request in a header called Ocp-Apim-Subscription-Key. The API calls use the following rate limiting policy:

• Partition key: IP address or host name of connection
• Burst limit: 100 requests
• Long-term sustained request rate: 1 request every 36 seconds (100 request per hour)
• No queueing for extra requests beyond the token bucket

API Definition

For a complete definition of the API, go to Key Catalog API Swagger.

This page also provides a quick way to execute the call: Expand the "/api/key-catalog/v2-0/{catalogId}/versions/{versionId}/download" item, and click the Try it out button.

Important

Clicking the Try it out button will execute the download call on the production Catalog.

The Swagger.json can be used by e.g. Swagger CodeGen or AutoRest to generate client code.

HTTP method

GET

Route parameters

• Route parameter "catalogId" is the ID of the Catalog item that will be downloaded, which is the same as the ID used to register the Catalog item. This must be a valid GUID.

  To obtain this ID for an existing Catalog item, navigate to its details page in the Catalog. The ID is the last part of the URL.

• Route parameter "versionId" is the version number of the Catalog item that will be downloaded.