Справочник API публикуется на английском языке.

Import remote secrets

POST/api/companies/{companyId}/secrets/remote-import
Personal API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Import remote secrets.

Авторизация

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

Тело запроса

application/json · обязательно

providerConfigIdstring (uuid)Обязательный
secretsarray<object>Обязательный
secrets[].externalRefstringОбязательный1–2048 characters
secrets[].namestring | nullНеобязательный1–160 characters
secrets[].keystring | nullНеобязательный1–120 characterspattern: ^[a-zA-Z0-9_.-]+$
secrets[].descriptionstring | nullНеобязательныйat most 500 characters
secrets[].providerVersionRefstring | nullНеобязательный1–512 characters
secrets[].providerMetadataobject | nullНеобязательный

Ответы

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Secrets