Create an API Token

You can create permanent and temporary tokens:

• Permanent tokens can be either:
  • Personal when a user is a person accessing the console or an API. Keep in mind, if you use a personal key and that user is removed from Spot, any tokens created for that user won’t be valid. This will cause some of your services and APIs to fail.
  • Programmatic when the user is an application accessing Spot with an API or service.
• Temporary tokens are created using the Spot API.

Create a Permanent Token

You can only see tokens that you have permission to view. For example, only Organization Admins and users with Delete Permanent Token permissions can see other users’ tokens. Permissions are defined in the permission policies.

Only Organization Admins can create programmatic tokens.

1. In the Spot console, click the user icon > Settings > API.
2. Click Permanent Tokens > Generate Token.
3. Select Personal or Programmatic:
   • Personal: give your token a name and click Generate. Keep in mind, if you use a personal key and that user is removed from Spot, any tokens created for that user won’t be valid. This will cause some of your services and APIs to fail.
   • Programmatic: give your token a name and select the type of programmatic user, then click Generate. Only Organization Admins can create programmatic tokens.

important

Remember to keep your tokens secret. Treat them just like passwords. They act on your behalf when interacting with the API. Do not share your personal access tokens with anyone outside your organization. Do not hardcode them into your programs. Instead, use environment variables. Contact support if you're concerned your token has been compromised.

Create a Temporary Token

1. In the Spot console, click the user icon > Settings > API.
2. Click Temporary Token.

API Token from User Details Page

You can only see tokens that you have permission to view. For example, only Organization Admins and users with Delete Permanent Token permissions can see other users’ tokens. Permissions are defined in the permission policies.

1. In the Spot console, click the user icon > Settings > Users.
2. In the Users list, select your username.
3. Click API Tokens.
4. Give your token a name and click Generate API Token.

important

Remember to keep your tokens secret. Treat them just like passwords. They act on your behalf when interacting with the API. Do not share your personal access tokens with anyone outside your organization. Do not hardcode them into your programs. Instead, use environment variables. Contact support if you're concerned your token has been compromised.

Delete a Token

Organization Admins and users with Delete Permanent Token permissions can see other users’ tokens. Permissions are defined in the permission policies.