Skip to main content
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

​
--api-id
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

FlagTypeDescription
--root-keystringOverride root key ($UNKEY_ROOT_KEY)
--api-urlstringOverride API base URL (default: https://api.unkey.com)
--configstringPath to config file (default: ~/.unkey/config.toml)
--outputstringOutput format — use json for raw JSON

​
Examples

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

​
Output

Default output shows the request ID with latency, followed by the API information: 
req_2c9a0jf23l4k567 (took 45ms)

{
  "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"
  }
}
Last modified on March 26, 2026