API#

When updating integrations to version 5.9.4, review the API v1 changes: some older routes were removed, request schemas became stricter, and tasks are now read through a queue. Check the method, path, and fields of each request against the Swagger documentation for the installed Sherpa Orchestrator version.

The API screen has three tabs:

1. Swagger — interactive documentation for requests, parameters, and responses. It is also available at https://orchestrator.sherparpa.ru/api/docs/swagger.
2. ReDoc — another view of the same API, useful for reading schemas and required fields.
3. Key — a table of API tokens. Each token has a name, assigned roles, and an expiration date; multiple tokens can be used at the same time.

Creating an API token#

You need permission to create API tokens. On the Key tab, click New, enter a token name, and select one or more roles. Set an expiration date and time or select Unlimited, then click Create. The assigned roles determine the token's permissions.

After creation, copy the token value or the ready-made Authorization header from the dialog. The value is shown only once: store it in a secure secrets manager before closing the dialog. Use the header displayed by the Orchestrator when calling the API, and check each route's requirements in Swagger. Do not put the token in URLs, logs, or unprotected files.

The table lets you inspect expiration dates and roles, edit token settings, or delete an unneeded token if you have the required permissions. The secret value of an existing token cannot be retrieved from the table. Robot GUID authentication on the routes that support it is a separate mechanism; a GUID is not an API token.