Documentation forSolarWinds Observability

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.

To access the API Tokens view, the organization role of your user must be Admin or Owner.

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

API token types

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

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

Create a new or reuse an existing API token?

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

Reuse an API token

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

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

  • Reuse a token for users who have access to the same entities or configurations.

  • Reuse a 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

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

  2. Click Generate API token.

  3. Type a name, select an API token type, and click Create API Token.

  4. Copy the API token.

The API token is added to the table.

Copy API tokens

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

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

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

Rename API tokens

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

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

  3. Adjust the API token name, and click Save.

The API token is renamed.