La référence de l'API est publiée en anglais.
Import remote secrets
POST
/api/companies/{companyId}/secrets/remote-importPersonal API keyConsole session
Import remote secrets.
Autorisation
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. Fonctionnement des clés.
Paramètres de chemin
companyIdstringObligatoireThe organization's id.
Corps de la requête
application/json · obligatoire
providerConfigIdstring (uuid)Obligatoire
secretsarray<object>Obligatoire
secrets[].externalRefstringObligatoire
1–2048 characterssecrets[].namestring | nullFacultatif
1–160 characterssecrets[].keystring | nullFacultatif
1–120 characterspattern: ^[a-zA-Z0-9_.-]+$secrets[].descriptionstring | nullFacultatif
at most 500 characterssecrets[].providerVersionRefstring | nullFacultatif
1–512 characterssecrets[].providerMetadataobject | nullFacultatif
Réponses
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.
Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.