Skip to main content
API Keys is found in the Settings area (Figure 1). As a Ruddr customer, you have access to the Ruddr API. The Ruddr API is a tool to access your workspace data. For additional information on the Ruddr API, refer to the Ruddr API Reference Guide.
API Keys in the Settings Area

Figure 1 - Select API Keys in the Settings Area

In order to authenticate to the Ruddr API, you need to generate authentication keys to be stored with your workspace. The API Keys section (Figure 2) lists each key’s Name, Type, the last four characters of its Token, and the date it was Created.
API Keys for Your Workspace will be Created and Accessed in the API Keys Section

Figure 2 - API Keys for Your Workspace will be Created and Accessed in the API Keys Section

​
Key Types

Each API key is one of two types:
  • Read-Only - The key can only read data. Use it for integrations that only pull data out of Ruddr, such as a data warehouse sync, a BI extract, or a status dashboard. If the integration tries to create, update, or delete data, the API rejects the request with the message This API key is read-only.
  • Full Access - The key can read data and also create, update, and delete data.
The type is chosen when the key is created and cannot be changed afterwards. If your business requirements change, you can create a new key of the type you need, update your integration to use it, and then delete the old key. Keys created before key types were introduced are Full Access.

​
Create an API Key

To create a key, click the + button (New API Key) at the top-right of the API Keys section. In the Create API Key window (Figure 3), optionally enter a Name to make the key easier to identify, choose Read-Only or Full Access, and click Submit. Read-Only is selected by default.
Name the Key and Choose its Type

Figure 3 - Name the Key and Choose its Type

Once submitted, you will be presented with an API Key (Figure 4). This is the only time you will see the full token, so save a copy of it in a secure location, such as a password manager. Afterwards, only the last four characters are shown. You will use this key in connecting / authenticating to the Ruddr API.
API Key for Your Records

Figure 4 - API Key for Your Records

​
Edit or Remove an API Key

To rename a key, click the edit (pencil) icon at the end of its row (Figure 2), change the Name, and click Save. The key’s type is shown but cannot be changed. To revoke a key, click the delete (trash) icon at the end of its row, and click Remove in the Remove API Key window to confirm (Figure 5). Revoking a key is permanent: within a few seconds, the API rejects any request made with it, and the key no longer appears in the list.
Remove API Key window showing the key's name and last four characters, with Cancel and Remove buttons

Figure 5 - Confirm Removing an API Key

For additional information, including how to use a key in your requests, see the Authentication guide in the Ruddr API Reference Guide.