Skip to main content
POST
Create one independently managed protection for an external provider key

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

protections:provision

Atomically create the disclosed AIRCTRL resources for a protected external key.

Headers

Idempotency-Key
string
required

Caller-generated operation key. Same key and request replay the same result; a different request returns 409.

Required string length: 16 - 200

Body

application/json
externalResourceId
string
required
Required string length: 1 - 255
providerId
string<uuid>
required
providerKey
string
required
write-only
Required string length: 1 - 2000
gatewayName
string
required
Required string length: 3 - 100
models
string[]
required
Minimum array length: 1
credentialLabel
string
Required string length: 1 - 100
settings
object
otel
object

Response

Protection metadata bound to one external resource. Provider secrets are never returned; creation, runtime-token rotation and reactivation include the new runtime token plaintext once.

ok
enum<boolean>
required
Available options:
true
data
object
required