Authorization

All requests must be authenticated with a Partner API key. Create one in the Partner Portal under Integrations → API Keys by selecting Add Key. You can optionally restrict the key to one or more IPv4 ranges in CIDR notation (for example 203.0.113.0/24, or 203.0.113.10/32 for a single address) and set an expiry date.

The key is shown only once, when you create it, so store it securely straight away. A key has full access to your partner account through the API: keep it secret and never expose it in client-side code. If Integrations → API Keys is not available to you, ask your Clym account manager.

Include the key in the Authorization header of every request as a bearer token:

Authorization: Bearer {YOUR_API_KEY}

The Bearer prefix is optional. If you include it, write it exactly as Bearer followed by a single space.

Example

curl --request GET \
  --url https://partners.clym.io/api/portal/domains \
  --header 'Authorization: Bearer {YOUR_API_KEY}'

A request returns 401 with the code AUTH.API_KEY when the key is missing, invalid, deactivated or expired, or when the request comes from an IP address outside the key's allowed ranges. A valid key used on a feature that is not enabled for your partner account returns 403.

You can deactivate a key at any time from Integrations → API Keys. Requests made with it are rejected from then on.