API Tokens

The API Tokens view displays a list of all tokens defined in the organization.

Tokens are keys used to identify operations and define what the operations can do.

Click Settings > API Tokens in the left-hand navigation.

API token types

API token types define the access level granted by the token.

• API Access - use this type to identify create, read, update, or delete operations for SolarWinds Observability SaaS entities, such as adding a website for monitoring using the public API.

  Only organization owners and admins can manage API Access tokens.

  Organization members can only see API Access token names in Settings. Organization members cannot create and manage API Access tokens.

  See User roles and access levels.

• Ingestion - use this type when you need to use a standard method to send large amounts of data into the system, such as logs, or metrics.

  All organization roles can create, rename, copy, and delete ingestion tokens.

Create a new or use an existing ingestion API token?

Creating new ingestion API tokens enhances security but more tokens generate a large number of extra logs that could hinder observability.

To use an existing ingestion token, copy it in Settings. You cannot retrieve API Access tokens from SolarWinds Observability SaaS.

Use existing API tokens

Consider using existing API tokens for low privileges and tailored access, preferably if the token is read-only for specific areas.

• Use an existing token to observe the same environment. For example, for reinstalling the same Network Collector or SolarWinds Observability Agent or for monitoring the same logs.

• Use an existing token for users who have access to the same entities or configurations.

• Use an existing token for entities with similar security concerns. Do not share tokens used by more sensitive entities with entities using lower security protocols.

Create new API tokens

Creating new API tokens is recommended for security reasons. When your API tokens have high privileges, create new tokens.

• Create new API tokens to make the monitored environment more secure. If you use one token for all areas and the token is compromised, the entire data ingestion pipeline is compromised and all entities configured with the same token are compromised.

• Create new API tokens for entities that have different security concerns, for example for security-sensitive entities and entities using lower security protocols.

Create API tokens

Only organization owners and admins can create API Access tokens. See User roles and access levels.

1. In SolarWinds Observability SaaS, click Settings > API Tokens.

2. Click Create API token.

3. Type a name and select an API token type.

4. Optional: If you want to apply tags to data associated with the token, click Add Tag, specify the key and value to be applied to the data.

5. Click Create API Token.

The API token is added to the table and it is displayed in a pop-up. You can copy the API token.

Copy ingestion API tokens

1. In SolarWinds Observability SaaS, click Settings > API Tokens.

2. Click the three dots next to the token, and select Copy Token.

The token is copied to the clipboard and is ready to be pasted.

You cannot copy API Access tokens.

Rename API tokens or edit tags

1. In SolarWinds Observability SaaS, click Settings > API Tokens.

2. Click the three dots next to the token, and select Edit.

3. Make your changes:

   • Adjust the API token name.
   • Add new tags to be applied to data associated with the token: Click Add Tag and provide the key and its value.
   • Change the key or value of existing tags.
   • Delete existing tags.

4. Click Save.

Your changes to the API token are applied.