Create a User API Key

Create a new API key for the authenticated user.

POST /api-keys

Try it

Create a User API Key

cURL

curl --request POST \
  --url https://api.xata.tech/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "expiry": "2023-11-07T05:31:56Z",
  "scopes": [
    "<string>"
  ],
  "projects": [
    "<string>"
  ],
  "branches": [
    "<string>"
  ]
}
'

201

{
  "key": {
    "id": "<string>",
    "name": "<string>",
    "preview": "<string>",
    "scopes": [
      "<string>"
    ],
    "projects": [
      "<string>"
    ],
    "branches": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "expiry": "2023-11-07T05:31:56Z",
    "last_used": "2023-11-07T05:31:56Z",
    "token": "<string>",
    "created_by": "<string>",
    "created_by_key": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

name · string · required

expiry · string<date-time> | null

Expiration date for the API key, null for no expiry

scopes · string[]

Optional scopes assigned to the API key

Maximum array length: 50

projects · string[]

Limit access to these projects

Maximum array length: 50

branches · string[]

Limit access to these branches

Maximum array length: 50

Response

201

application/json

API Key created successfully

key · object · required

Show child attributes

key. id · string · required

key. name · string · required

key. preview · string · required

key. scopes · string[] · required

key. projects · string[] · required

Projects this API key has access to

key. branches · string[] · required

Branches this API key has access to

key. created_at · string<date-time> · required

key. expiry · string<date-time> | null · required

Date when the API key expires (null if no expiry)

key. last_used · string<date-time> | null · required

Timestamp of the last time the key was used (null if never)

key. token · string · required

The actual API key token

key. created_by · string | null

ID of the user that created this API key

key. created_by_key · string | null

ID of the API key that created this API key