keys - Xata

A user key belongs to the account that created it, an organization key to an organization. Both are printed once, when they are created. Every command below also takes -h, --help.

xata keys user — Manage API keys for the current user
- xata keys user list — List all API keys of the current user
- xata keys user create — Create a new API key
- xata keys user delete — Delete one or more API keys
xata keys organization — Manage API keys for an organization
- xata keys organization list — List all API keys for an organization
- xata keys organization create — Create a new API key
- xata keys organization delete — Delete one or more API keys

user

Manage API keys for the current user

user list

List all API keys of the current user

xata keys user list [--profile value] [--debug] [--json]

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

Aliases: xata keys user ls

user create

Create a new API key Creates a key for the account you are logged in with. It is printed once, when it is created, and cannot be read again.

xata keys user create [--name value] [--expiry value] [--profile value] [--debug] [--json]

string

API key name

string

Expiry, as a date or a phrase such as ‘in 1 week’, or ‘never’

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

Examples:

# Create a key that does not expire
xata keys user create --name ci
# Create a key that expires
xata keys user create --name ci --expiry 2026-12-31

user delete

Delete one or more API keys

xata keys user delete [--profile value] [--debug] [--json] <keyId>...

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

string

IDs of the keys to delete

organization

Manage API keys for an organization Aliases: xata keys org

organization list

List all API keys for an organization

xata keys organization list [--organization value] [--profile value] [--debug] [--json]

string

Organization ID

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

Aliases: xata keys organization ls

organization create

Create a new API key Creates a key for an organization rather than for an account. It is printed once, when it is created, and cannot be read again.

xata keys organization create [--organization value] [--name value] [--expiry value] [--profile value] [--debug] [--json]

string

Organization ID

string

API key name

string

Expiry, as a date or a phrase such as ‘in 1 week’, or ‘never’

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

Examples:

# Create a key for an organization
xata keys organization create --name deploy

organization delete

Delete one or more API keys

xata keys organization delete [--organization value] [--profile value] [--debug] [--json] <keyId>...

string

Organization ID

string

The profile to use

boolean

Print where each resolved value came from

boolean

Output in JSON format when the command supports it. Defaults to on when an AI agent runs the command.

string

IDs of the keys to delete

​user

​user list

​user create

​user delete

​organization

​organization list

​organization create

​organization delete

user

user list

user create

user delete

organization

organization list

organization create

organization delete