apis
Get API namespace
Changed onRetrieve 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
Your root key must have one of the following permissions:
- api.*.read_api (to read any API)
- api.<api_id>.read_api (to read a specific API)
post/v2/apis.getApi
Request
- Base URLhttps://api.unkey.com
- URLhttps://api.unkey.com/v2/apis.getApi
- AuthHTTP bearer
Request body
Example request
{
"apiId": "api_1234abcd"
}Response
API information retrieved successfully. Contains the unique API ID and human-readable name.
Example response
{
"meta": {
"requestId": "req_123"
},
"data": {
"id": "api_1234567890abcdef",
"name": "payment-service-production"
}
}Changes
- breaking
the
/response property's maxLength was increased from255to256for the response status
- breaking
- info
the endpoint scheme security
bearerwas added to the API - info
the endpoint scheme security
rootKeywas removed from the API
- info