Manage an API key

An API key provides access to services available through PDC. API keys can be managed through the user-interface or programmatically with the API.

Default key duration

This chart lists the standard durations for API keys and session tokens. The Operations Team can extend the duration up to the maximum values shown:

Manage API keys through the user-interface

API keys are managed in different places in the user-interface depending on the account:

• User account API keys are managed on the Account Settings page.
• Users with the Tenant Administrator role can manage service account API keys on the Users page.

Generate an API key for a user account

To generate an API key for a user account:

1. Click the User icon.
2. Click the email address. The Account Settings screen appears. If there is an existing API key, it shows the expiry date. If there is not an existing key, or if the expiry date is approaching, continue with step 3.
3. Click Manage your API Key.
4. (Optional) In the Generate your API Key section, enter the number of minutes the key will be valid.
5. Click Generate. A key generates and appears under Your API Key with an expiry date.

Revoke a user account API key

To revoke an API key:

1. Click the User icon.
2. Click your email address.
3. Click Manage your API Key.
4. Under Revoke your API Key, click Revoke. The API key is no longer listed.

Generate an API key for a service account

To generate an API key for a service account:

1. Click the Settings icon.
2. Click Users.
3. Locate the appropriate service account.
4. Click the key icon.
5. The Key Management sidebar appears. If there is an existing API key, it shows the expiry date. If there is not an existing key, or if the expiry date is approaching, continue with step 6.
6. (Optional) In the Generate API Key section, enter the number of minutes the key will be valid.
7. Click Generate. A key generates and appears with an expiry date.

Revoke a service account API key

To revoke a service account API key:

1. Click the Settings icon.
2. Click Users.
3. Locate the appropriate service account.
4. Click the key icon. The Key Management sidebar appears.
5. Click Revoke.

Manage keys with the API

Before generating a new key from the API, generate an access token. Then, check the expiry date of the existing key before generating a new one.

Generate an access token

To generate an access token:

1. Submit a POST request to the token service. For example:

   Copy

   POST https://{tenancy-URL}/token/
   Content-Type: application/json
   

   Copy

   {
       "grantType": "apikey",
       "key": "abc123XYZ789example+ApiKey/Sample=="
   }
   

2. An access token is returned. Use this token in the header of the other calls in this section. For example:

   Copy

   curl -H "Authorization: Bearer {access_token}" https://{tenancy-URL}/ml/{target-endpoint}
   

Check the expiry date of the API key

After generating an access token, check the expiry date of the current API key:

1. Make a call to the GET /api/account/apikey endpoint. The server returns a response like this:

   Copy

   {
     "apikey": "_ABCDGAHHjYAYKyA9rA==",
     "expiryDate": "2025-03-27T12:31:43Z"
   }
   

2. Check the expiryDate field to see when the API key expires. If the expiryDate is approaching soon or will expire before it is used again, generate a new API key.

Generate a new API key (if necessary)

1. Make a call to the PUT /api/account/apikey endpoint:

   Copy

   PUT https://{tenancy-URL}/api/account/apikey
   Content-Type: application/json
   Authorization: Bearer {access_token}
   

   Copy

   {
       "durationMinutes": 129600
   }
   

   Note: The durationMinutes parameter is optional. If omitted, the default duration will be used.

   A new API key like this appears in the response:

   Copy

   {
     "apikey": "D08NxE25rbw5iFaTfLxbA==",
     "expiryDate": "2025-08-12T20:11:25Z"
   }
   

2. In the next step, use this key to reauthenticate.

Reauthenticate with the new key

1. Make a call to POST /token with the new API key:

   Copy

   POST https://{tenancy-URL}/token/
   Content-Type: application/json
   

   Copy

   {
       "grantType": "apikey",
       "key": "D08NxE25rbw5iFaTfLxbA=="
   }
   

2. All future automated tasks should now reference the new key.