Configure an Analytics API token

Cloudflare recommends API tokens as the preferred authentication method with Cloudflare APIs. This article walks through creating API tokens for authentication to the GraphQL Analytics API.

For more details on API tokens and the full range of supported options, refer to Creating API tokens.

To create an API token for authentication to the GraphQL Analytics API, use this workflow:

• Access the Create API Token page
• Configure a custom API token
• Review and create your API token
• Copy and test your API token

Access the Create API Token page

To access the Create Custom Token page, follow these steps:

1. Log in to your Cloudflare account and select My Profile from the user account drop-down list.

2. In your user profile page, select the API Tokens tab.

3. In the API Tokens page, select Create Token.

The Create API Token page displays.

The next section of this walkthrough shows you how to configure a custom token for access to the GraphQL Analytics API.

Configure a custom API token

To configure a custom token, follow these steps:

1. Select Get started in the Custom token section of the Create API Token page:

The Create Custom Token page displays:

2. Enter a descriptive name for your token in the Token name text input field.

3. To configure access to the GraphQL Analytics API, use the Permissions drop-down lists.

4. To set permissions for the GraphQL Analytics API, select Account in the first drop-down list, Account Analytics from the second drop-down list, and Read from the third.

This example scopes account-level permissions for read access to the Analytics API:

5. To configure the specific zones to which the token grants access, use the Zone Resources drop-down lists. In this example, the token is set to grant access to all zones:

6. To restrict the API token to specific IP addresses, use the Client IP Address Filtering controls.

7. To define how long the token is valid, select the TTL (time-to-live) start/end date.

8. Select Continue to summary.

The next section of this walkthrough covers how to review and test your API token.

Review and create your API token

Once you select Continue to summary, the API Token Summary page displays.

Use the API Token Summary to confirm that you have scoped the API Token to the desired permissions and resources before creating it.

Once you have validated your API token configuration, select Create Token.

Copy and test your API token

When you create a new token, a confirmation page displays that includes your token and a custom curl command.

To copy the token to your device’s clipboard, select the Copy button.

Warning

The token displays only on the confirmation page, so copy the token and store it safely, since anyone who has the token can use it to access your data.

If you lose the token, you can regenerate it from the API Tokens page, so that you do not have to configure all the permissions again.

To test your token, copy the curl command and paste it into a terminal.

When you have finished, select View all API tokens.