6.1 Generating and Using API Tokens

You can generate an API token for an application and use the token in the required REST API request. You can generate multiple tokens for one application. You can generate tokens for all the resources for which you can check out credentials from the user console.

To generate an API token, perform the following:

  1. Select the appropriate resource for which you need to generate a token.

    For example, if you want to generate a token for a database, select Predefined Tags > Databases and then select the required database.

  2. Click API Token > Generate Token.

  3. Specify the following details:

    Token Expiry: Duration for which the token is valid.

    Select Set Expiry if you want the token to be disabled after a specific duration and select the appropriate expiry date and time. These tokens expire after the configured duration. If you want to use the token after expiry, you can edit the token and modify the expiry duration.

    Select Never if you do not want the token to expire.

    Token Name: Name to identify the token.

    Access From: Represents the host from which the token can be authenticated.

    Select Any Host to allow token access from any host.

    Specify the Host IP / Host Name to allow the token access only from those hosts. To specify multiple hosts, use comma as a separator.

    Notes: Any additional information about this token.

  4. Click Generate Token.

    The generated token is added to the API Tokens list.

  5. Click to copy the appropriate token and use it as required. For more information about how to use tokens, see Using API Tokens.