API reference¶

Reference for the Management API of Adverity Connect: every operation, its parameters, request and response bodies, and request examples to fill in with your instance and key. It is generated from the API’s OpenAPI spec.

Authentication

The Management API uses Connect API keys to authenticate requests. You create and manage keys in Adverity. See Creating a Connect API key.

Send the key as a Bearer token in the Authorization header of every request:

Authorization: Bearer {{KEY}}

For example, to list your datastreams, replace {{INSTANCE}} with your instance host name and {{KEY}} with your key:

curl --request GET 'https://{{INSTANCE}}/api/datastreams/' \
  --header 'Authorization: Bearer {{KEY}}'

A key is assigned to one workspace and reaches only that workspace and its child workspaces. It can only do what the permissions you gave it allow, and each operation in this reference that needs a permission names it. Requests that need a permission the key does not have are rejected, and so is every request made with an expired key. See Expiry of a Connect API key.

To see which workspace and permissions a key has, call GET /api/v1/auth/keys/introspect/. See Checking the status of a Connect API key.

Keep your keys secret. Do not put them in client-side code or commit them to a repository. Store them in your platform’s secrets manager or in environment variables, and make all requests over HTTPS.

Resources

Adverity Connect API

Download OpenAPI spec

226 operations in 19 resource groups.