API Keys

Create an Organization API Key

Changed on

Create a new API key for an organization.

post/organizations/{organizationID}/api-keys

Request

  • Base URL
    https://api.xata.tech
  • Auth
    OAuth 2
    Implicit: https://auth.xata.io/realms/xata/protocol/openid-connect/auth
    Scopes: keys:write

Request body

namestring required
expirystring date-time nullable

Expiration date for the API key, null for no expiry

scopesstring[]

Optional scopes assigned to the API key

projectsstring[]

Limit access to these projects

branchesstring[]

Limit access to these branches

Response

API Key created

Changes