Create a Stax API Token

Create a Stax API Token to authenticate requests to the Stax API

Article Tags
On This Page
Before You BeginCreate a Stax API TokenSee also

Creating a Stax API token will provide you with a unique Access Key and a Secret Key, both of which are required for authentication to use the Stax API. You can choose to store these credentials in your own credential manager or utilize the Stax API Token storage solution.

Before You Begin

  • You must be an Admin to create an API Token

Create a Stax API Token

  1. Log in to the Stax customer console
  2. In the left-hand nav, ensure that Beta mode is enabled
  3. From the left-hand nav, select API Tokens under MANAGEMENT
  4. Select Get started or
  • If you have already used the API Token service, select + Create a token from within the API Token section
  1. Enter a name and description for the new API Token
  2. Select the role to be assigned to the API Token. Available roles are Admin, Developer, and Readonly. See API Token Permissions for more detail on the permissions granted to each role
  3. Select the API Token storage solution:
  • Option 1: I’ll copy and store my API token in the next step

    • Select this option if you would like to store the API Token's Access and Secret Key in your own credential manager
    • Ensure you take a copy of the Secret Key as Stax will only display it once during creation
    • If you lose the API Token's Secret Key you will need to create a new API Token
  • Option 2: I’d like Stax to store my API Token in SSM

    • Stax Encrypt and store the API Token's Access and Secret key in AWS Systems Manager Parameter Store (SSM), in your security account
    • You can choose to bring your own KMS encryption key or use a dedicated KMS key defined by Stax
    • If you would like to use your own KMS key for encryption, provide the key id parameter of the key in the field provided. AWS supports the following key id parameter formats:
      • Key ARN. For example: arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
      • Alias ARN. For example: arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
      • Key ID. For example: 12345678-1234-1234-1234-123456789012
      • Alias Name. For example: alias/MyAliasName
    • To retrieve the API Token's Keys in future, you will need to navigate to SSM in your Security Account
    • Refer to Viewing an API Token's Access Key and Secret Key for details on how to retrieve the API Token's Keys
  1. Optionally, add tags to your API Token
  2. Select Create token

The API Token can now be used by your organization to authenticate calls to the Stax API. The API Token cannot be used to log into the Stax console and is not tied to a specific user's identity. For more information see the Stax Python SDK.

See also