Skip to main content

Using the Vendor API v3

This topic describes how to use Replicated Vendor API authentication tokens to make API calls.

About the Vendor API

The Vendor API is the API for the Vendor Portal. This API can be used to complete tasks programmatically, including all tasks for packaging and managing applications, and managing artifacts such as teams and license files.

API Token Requirement

To use the Vendor API v3, you need a token for authorization. You provide the token as the value of the Authorization header of Vendor API calls. For example, to pass a token as the authorization header in a request:

curl --request GET \
--url https://api.replicated.com/vendor/v3/customers \
--header 'Accept: application/json' \
--header 'Authorization: my-token'

Generate a service account or user API token in the Vendor Portal. The token must have Read/Write access to create new releases. See Generating API Tokens.

Vendor API v3 Documentation

For Vendor API documentation and an interactive API console, see Vendor API v3 Reference.

For the Vendor API swagger specification, see vendor-api-v3.json.

vendor api documentation page

View a larger version of this image