Authentication

CloudOps API uses API tokens to authenticate your requests.

Create a API Token:

Note: API keys can be created and revoked by users with admin access rights.

• Log in to your CloudOps dashboard.
• In the top navigation, under "More", click "User Management."
• There is a tab here that lists all of your API tokens. Click "+Create API Token."

There are three fields for each API token

• Name your API token
• Days that it remains valid
• Groups that have access to the token (Read about Role based Access Control)

When you click "Create API Token" you will be able to copy the API Token.

Use of API Token

Authentication to the API is performed by supplying the X-CloudOps-API-Key header with API token as it's value.

Example of request to API:

{% code overflow="wrap" %}

curl --location --request GET 'https://dev.cloudops.io/v1alpha1/workflows' --header 'X-CloudOps-API-Key: <your-api-token>'

Revoke Token

Click the trash can next to the token to remove it from the CloudOps system. Once removed, it cannot be recovered.

Your API keys carry the privileges to execute workflows (runbooks) your team owns and view results of executions so be sure to keep them secure! Do not share your API tokens in publicly accessible areas such as GitHub, client-side code, etc. All API requests must be made over HTTPS. Any requests made over plain HTTP will fail. Requests without a valid API token will fail and return a 401 error.