{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Default API Key",
"key": "f9e67690304c23f133f7d965f130139d36f985b1ce8169a7d8ed99dbd5edc3b9",
"created_at": "2023-11-07T05:31:56Z",
"default_request_mode": "async",
"__event__": {
"type": "APIKey.created",
"origin": "api"
},
"environment": "production",
"federation_grants": [],
"organization_grants": []
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Api key created
Emitted when a new API Key is created.
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Default API Key",
"key": "f9e67690304c23f133f7d965f130139d36f985b1ce8169a7d8ed99dbd5edc3b9",
"created_at": "2023-11-07T05:31:56Z",
"default_request_mode": "async",
"__event__": {
"type": "APIKey.created",
"origin": "api"
},
"environment": "production",
"federation_grants": [],
"organization_grants": []
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
The ID of the API Key.
The name of the API Key.
"Default API Key"
The API Key.
"f9e67690304c23f133f7d965f130139d36f985b1ce8169a7d8ed99dbd5edc3b9"
When the API Key was created.
The default execution mode for requests authenticated with this API key. 'sync' means requests block until completion; 'async' means requests return immediately with a 202 status. The Prefer header overrides this default.
sync, async "async"
"sync"
Show child attributes
Show child attributes
The environment the key authenticates in. Null on federation and operator keys, which belong to no application.
sandbox, production "production"
Federation grants scoping this key. Populated only on federation API keys; null for organization and operator keys.
Capabilities granted to a federation-owner API key.
Populated only on APIKey rows where owner == Federation; NULL
elsewhere. A federation key must have at least one grant.
sandbox, production, admin Surfaces this organization key may reach ('api' for the customer HTTP API, 'exports' for the SFTP bulk data feed). Null means unscoped: full API access and no SFTP. Always null on federation and operator keys.
Surfaces an organization-owner API key may reach (ENG-6872).
NULL means ungranted — the historical blanket behavior: the full
customer API, and no SFTP. Every key minted before this column existed is
NULL, which is what makes the column backwards compatible by construction.
A non-NULL set is authoritative and must be non-empty. Populated only
on rows where owner == Organization; NULL elsewhere.
api, exports, nevermined Response
Successful Response