Skip to main content
You need a root key with the permissions listed on this page. Create one in the dashboard under Settings > Root Keys. See Permission reference for every permission.
Create a keyspace (still called an API in the CLI). Every key belongs to one keyspace. Make one per service or environment you want to keep separate. Calls POST /v2/apis.createApi. See Keyspaces.

Usage

Flags

string
required
Name of the new API, 3 to 256 characters. The name is just a label. Other commands take the ID from the response.

Shared flags

Every unkey api command takes these. See CLI output and shared flags.
string
Root key used for the request. Falls back to UNKEY_ROOT_KEY, then to the key stored by unkey auth login.
string
default:"https://api.unkey.com"
Base URL of the API. Falls back to UNKEY_API_BASE_URL. You don’t normally need to set it.
string
default:"~/.unkey/config.toml"
Path of the config file written by unkey auth login. Falls back to UNKEY_CONFIG.
string
Output format. Falls back to UNKEY_OUTPUT. json prints the full response. Any other value prints the request ID and data.
string
Send this JSON as the whole request body instead of using the command’s flags. You can’t combine it with them.

Required permissions

api.*.create_api. See Root key permissions.

Examples

Create an API
Or send the whole request as JSON:
Raw body
Last modified on September 29, 2026