OffRail

Retrieve key status

>-

GET
/v1/key

Returns usage information for the API key used to authenticate the request. Lets clients that only hold an API key surface their own usage without a dashboard session. Deliberately excludes billing details and the key token itself.

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer token authentication using API keys

In: header

Response Body

application/json

curl -X GET "https://example.com/v1/key"
{
  "data": {
    "label": "string",
    "usage": "string",
    "limit": "string"
  }
}

How is this guide?