For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • GETGet API key permission options
      • GETList API keys
      • POSTCreate API key
      • GETGet aggregate API key analytics
      • GETReveal test key plaintext
      • GETGet API key
      • PUTUpdate API key
      • DELDelete API key
      • POSTRegenerate API key
      • GETGet API key analytics
Dashboard
LogoLogo
Runtype APIAPI Keys

Get API key

GET
/v1/api-keys/:id
GET
/v1/api-keys/:id
$curl https://api.runtype.com/v1/api-keys/id \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "apiKey": {
3    "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
4    "name": "Production API Key",
5    "keyPrefix": "runtype-prod-",
6    "searchHint": "prod-key-2024",
7    "permissions": [
8      "read:projects",
9      "write:deployments",
10      "read:logs"
11    ],
12    "isActive": true,
13    "expiresAt": "2025-12-31T23:59:59Z",
14    "lastUsedAt": "2024-06-10T14:22:00Z",
15    "createdAt": "2024-01-01T08:00:00Z",
16    "updatedAt": "2024-06-01T12:00:00Z",
17    "maskedKey": "runtype-prod-****-****-1234"
18  },
19  "timestamp": "2024-06-10T14:30:00Z"
20}
Get details of a specific API key by ID.
Was this page helpful?
Previous

Update API key

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Response

API key details
apiKeyobject
timestampdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error