• Dark
    • PDF

    Edge DX API

    • Dark
    • PDF

    Article Summary

    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.


    You can authenticate API requests in two ways:

    • By signing in with the /user/auth endpoint 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 sign in and authenticate each time you want to use the API.
    • With an API key that you enter as a header value with 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.

    Both API authentication methods require that you use a non-SSO Edge DX user. To sign in with a non-SSO user, you need to directly access your tenant URL (for example, https://<tenant-name>.sip.controlup.com), instead of accessing Edge DX through Solve. If you do not have a non-SSO user, you can add one or edit an existing user. For details, see Users.

    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. Do not access Edge DX through Solve.
    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.


    Access to specific API endpoints is restricted based on user permissions. API permissions are controlled in the same way as regular Edge DX user permissions. To learn more, see Roles.

    If you are authenticating API requests by signing in with a user, then you have the same permissions as the user. If you are authentication API requests with an API key, then you have the same permissions as the user that created the API key.

    Was this article helpful?

    What's Next