How to Generate and Manage API Access Tokens

API Access Tokens allow you to access your LDAR data and integrate Chateau with third-party tools, such as PowerBI or other business intelligence applications. These tokens provide secure, programmatic access to your data using our REST API.

This page in Majordomo allows you to view, create, and revoke API Access Tokens for databases you are an Administrator.

Before You Begin

• Prerequisite: You must be an Administrator of the database for which you want to generate an API access token.

How to Generate a Token

Follow these steps to create a new API access token:

1. Log in to Chateau and on the Overview, click Majordomo at the bottom-left.
   
    
2. From the main navigation menu, select API Access Token.
   
    
3. On the API Access Tokens page, click the + Add API Access Token button in the top-right corner.
   
    
   1. An Add API Access Token panel will appear. Fill in the following field
      .
       
      • Token Description: Enter a clear, memorable name for the token so you know its purpose (e.g., “PowerBI – Compliance Report” or “Quarterly BI Integration”).
        
         
      • Database: Select the database you want this token to access from the drop-down menu.
        
         
4. Click the Create Token button.

Important: Copy Your New Token

After you click Create Token, a dialog box will appear displaying your new, unique API access token.

This is the only time you will see the full token. For security reasons, the token will not be shown again after you close this window.

1. Click the Copy button to copy the token to your clipboard.
   
    
2. Store this token in a secure location (such as a password manager) before closing the dialog.
   
    
3. Once you have safely stored the token, click Close.

Managing Your Tokens

After you create a token, it will appear in the main “API Access Tokens” grid. This grid shows you:

• Description: The name you gave the token.
  
   
• Database: The database it has access to.
  
   
• Date Created: When the token was generated.
  
   
• Usage: This column shows how many times the token was used in the previous month and the current month, which helps you confirm if your integration is active. Administrators will also receive a periodic API Usage Report at the end of month showing API token usage by database. Administrators with access to multiple databases receive a consolidated report.

Security Best Practices

Treat your API Access Tokens like passwords. They grant direct access to your LDAR data.

• Do Not Share: Never share tokens in emails, chats, or other unsecured-communications.
  
   
• One Token, One Purpose: It is best practice to create a new, unique token for each third-party tool or integration. This makes it easy to revoke access for one tool without affecting others.
  
   
• Revoke Unused Tokens: If an integration is no longer needed, revoke its token immediately from the “API Access Tokens” page.