API referansı İngilizce yayımlanır.

Import remote secrets

POST/api/companies/{companyId}/secrets/remote-import
Personal API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Import remote secrets.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

companyIdstringZorunluThe organization's id.

İstek gövdesi

application/json · zorunlu

providerConfigIdstring (uuid)Zorunlu
secretsarray<object>Zorunlu
secrets[].externalRefstringZorunlu1–2048 characters
secrets[].namestring | nullİsteğe bağlı1–160 characters
secrets[].keystring | nullİsteğe bağlı1–120 characterspattern: ^[a-zA-Z0-9_.-]+$
secrets[].descriptionstring | nullİsteğe bağlıat most 500 characters
secrets[].providerVersionRefstring | nullİsteğe bağlı1–512 characters
secrets[].providerMetadataobject | nullİsteğe bağlı

Yanıtlar

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.

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Secrets