get-api

Retrieve basic information about an API namespace including its ID and name. Use this to verify an API exists before performing operations, get the human-readable name when you only have the API ID, or confirm access to a specific namespace. For detailed key information, use the listKeys endpoint instead. Required permissions:

api.*.read_api (to read any API)
api.<api_id>.read_api (to read a specific API)

See the API reference for the full HTTP endpoint documentation.

Usage

unkey api apis get-api [flags]

Flags

string

required

Specifies which API to retrieve by its unique identifier. Must be a valid API ID that begins with api_ and exists within your workspace.

Global Flags

Flag	Type	Description
`--root-key`	string	Override root key (`$UNKEY_ROOT_KEY`)
`--api-url`	string	Override API base URL (default: `https://api.unkey.com`)
`--config`	string	Path to config file (default: `~/.unkey/config.toml`)
`--output`	string	Output format. Use `json` for raw JSON
`--body`	string	Send this JSON string as the request body. You cannot combine it with request-building flags.

Examples

unkey api apis get-api --api-id=api_1234abcd

unkey api apis get-api --api-id=api_1234abcd --output=json

unkey api apis get-api --api-id=api_1234abcd && unkey api keys create-key --api-id=api_1234abcd

Output

Default output shows the request ID, followed by the API information:

req_2c9a0jf23l4k567

{
  "id": "api_1234abcd",
  "name": "payment-service-prod"
}

With --output=json, the full response envelope is returned:

{
  "meta": {
    "requestId": "req_2c9a0jf23l4k567"
  },
  "data": {
    "id": "api_1234abcd",
    "name": "payment-service-prod"
  }
}

Getting Started

Platform

Build & Deploy

Networking

Observability

CLI

Security

Keyspaces

AI Code Gen

Audit Logs

CLI

Errors

Usage

Flags

Global Flags

Examples

Output

​Usage

​Flags

​Global Flags

​Examples

​Output

Usage

Flags

Global Flags

Examples

Output