Edge DX API

You can use the Edge DX API to programmatically interact with your Edge DX organization.

Visit the Edge DX API reference to see the full details about the API endpoints.

Authentication

You can authenticate API requests using two methods:

• By using the /user/auth endpoint to sign in with an Edge DX user and obtaining an HttpOnly cookie user_access_token. You send this cookie on all subsequent requests using the Cookie header. The cookie expires, so you need to authenticate each time you want to use the API. If you authenticate using the /user/auth endpoint, your permission to access API endpoints depends on the permissions of the Edge DX user you used to authenticate.

• By using an API key that you enter as a header value with the key x-api-key. The API key does not expire, so you can automate API requests. Only some endpoints allow you to use API keys for authentication. If you authenticate API requests using an API key, your permission to access API endpoints depends on the permissions of the Edge DX user that created the API key. If you later update the permissions of the Edge DX user that created the API key, then the permissions associated with the API key are automatically updated as well. To learn how to create an API key, read Create an API Key below.

Both API authentication methods require that you use a non-SSO Edge DX user. A non-SSO Edge DX user is a user that can directly access your tenant URL (https://<tenant-name>.sip.controlup.com), instead of accessing Edge DX through Solve or DEX. We recommend that you create a dedicated non-SSO Edge DX for authenticating API requests and set the relevant permissions for that user. Learn how to create a non-SSO user.

Create an API Key

To create an API key:

1. Sign in directly to Edge DX using your tenant URL (https://<tenant-name>.sip.controlup.com) with a non-SSO user. The user must have the Manage API Keys permission.
2. Go to Configuration > Settings > API keys.
3. Click Add API Key.

After you create an API key, you can copy it to use in your API requests.