AuthenticationThis token authenticates to the Conveyor API. To successfully authenticate, you must include this token in the headers of your request. If the api key is not valid or active, the endpoint will respond with a 403 and no body.
If the engineer setting up the integration is not a user of Conveyor, an existing user can generate the keys and securely share them using a password wallet.
It is best to create one key per integration you are looking to set up, although you are able to connect multiple integrations using the same key.
How to create an API token
- Login to Conveyor as user in a Superadmin or Conveyor Admin role, or a user belonging to a custom role that has the Integrations module granted at an Admin level.
- Click the top right dropdown and select "Settings" and then navigate to the "Integrations" tab on the left (alternatively, you can go to this url: https://app.conveyor.com/settings/organization/integrations).
- In the "Integrations" section, click "Add Integration" in the top right.
- At the bottom of the list choose "Conveyor API" and click "Next Step".
- Enter a name for the API key and select what permissions you want this key to have available. After your selections have been made, click "Create".
- In the next screen your new API key will be displayed. This is the only time you will be able to view the full key. Copy the key and put it somewhere safe (i.e., a password wallet). There is a "Copy API Key" button on this screen that will copy the key to your machines clipboard. After noting the key, click "Done".
- Your key will now be in the "API Keys" table. You can see the corresponding key prefix for reconciliation with active keys. You can view the key's active permissions by expanding the table row via the caret on the left hand side of the row. If you need to adjust the permissions or remove the key, you can do so by clicking the ellipsis menu on the right of the row.
Rate LimitingPlease note, the API is rate limited at 2000 requests per 5 minutes.