How to Set Up an API Key
Overview
Use the API Dashboard to create, edit and delete API keys and to review API request history.
The Account Owner can open the API Dashboard and can grant an Admin the Can manage API keys and webhooks permission. See Grant API Key and Webhook Access. Everyone with that permission can see and manage all keys for the account.
How to Access the API Dashboard
- Open Settings.
- Select API Dashboard.
How to create an API Key
- From the API Dashboard, select Manage Keys.
- Select Create API Key.
-
Enter a Name that identifies the integration.
-
Choose an Access Level:
- Full Access can read and change supported account data.
- Read Only can read data but cannot create, update or delete it.
-
Select Create.
-
Copy the key and store it in your integration's secrets manager before closing the dialog.
Access levels
Each key's access level controls whether it can make write requests.
| Access level | What the key can do |
|---|---|
| Full Access | Can read data as well as create, update and delete it. |
| Read Only | Can read data. Requests that create, update or delete data return 403 Forbidden. |
For most API operations, a key is not restricted by the key owner's other Astalty permissions. Finance endpoints are the exception and require the key owner to have Finance access. Read API Authentication and Permissions before issuing a Full Access key.
Changing an existing key's access level
- Open Manage Keys.
- Open the key's action menu and select Edit.
- Select Full Access or Read Only.
- Select Save.
The change applies to later requests that use the key. The keys table shows the access level, last-used date and creation date for each key. Use Delete from the action menu when an integration no longer needs a key.
API Dashboard
The API Dashboard lists API requests for the account. You can search by URL and see each request's date, status, method, source and path.
Select a request to see its status, ID, time, IP address, User details, request body and response body. Request and response bodies can contain sensitive account data, so only grant Dashboard access to trusted Admins.
Use the request history to investigate an integration error, then compare the request with the API Reference.
API Endpoint Dashboard
The API Endpoint Dashboard is generated from the deployed API. It documents each public operation's path, method, parameters, request body and response schema. Check the deployed reference when building or updating an integration.
