{ "info": { "_postman_id": "3be77e0d-6b87-49f3-9d58-de0bce7d1512", "name": "Unkey analytics keys API", "description": "Unkey's API provides programmatic access for all resources within our platform.\n\n\n### Authentication\n#\nThis API uses HTTP Bearer authentication with root keys. Most endpoints require specific permissions associated with your root key. When making requests, include your root key in the `Authorization` header:\n```\nAuthorization: Bearer unkey_xxxxxxxxxxx\n```\n\nAll responses follow a consistent envelope structure that separates operational metadata from actual data. This design provides several benefits:\n- Debugging: Every response includes a unique requestId for tracing issues\n- Consistency: Predictable response format across all endpoints\n- Extensibility: Easy to add new metadata without breaking existing integrations\n- Error Handling: Unified error format with actionable information\n\n### Success Response Format:\n```json\n{\n \"meta\": {\n \"requestId\": \"req_123456\"\n },\n \"data\": {\n // Actual response data here\n }\n}\n```\n\nThe meta object contains operational information:\n- `requestId`: Unique identifier for this request (essential for support)\n\nThe data object contains the actual response data specific to each endpoint.\n\n### Paginated Response Format:\n```json\n{\n \"meta\": {\n \"requestId\": \"req_123456\"\n },\n \"data\": [\n // Array of results\n ],\n \"pagination\": {\n \"cursor\": \"next_page_token\",\n \"hasMore\": true\n }\n}\n```\n\nThe pagination object appears on list endpoints and contains:\n- `cursor`: Token for requesting the next page\n- `hasMore`: Whether more results are available\n\n### Error Response Format:\n```json\n{\n \"meta\": {\n \"requestId\": \"req_2c9a0jf23l4k567\"\n },\n \"error\": {\n \"detail\": \"The resource you are attempting to modify is protected and cannot be changed\",\n \"status\": 403,\n \"title\": \"Forbidden\",\n \"type\": \"https://unkey.com/docs/errors/unkey/application/protected_resource\"\n }\n}\n```\n\nError responses include comprehensive diagnostic information:\n- `title`: Human-readable error summary\n- `detail`: Specific description of what went wrong\n- `status`: HTTP status code\n- `type`: Link to error documentation\n- `errors`: Array of validation errors (for 400 responses)\n\nThis structure ensures you always have the context needed to debug issues and take corrective action.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:23:23.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "lastUpdatedBy": "35240", "uid": "35240-3be77e0d-6b87-49f3-9d58-de0bce7d1512" }, "item": [ { "name": "v2", "item": [ { "name": "keys.addPermissions", "item": [ { "name": "Add Key Permissions", "id": "5d71fdb9-8fb1-4b31-83a5-78b3080aded1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"jmjm\",\n \"permissions\": [\n \"A*A*\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addPermissions" ] }, "description": "Add permissions to a key without affecting existing permissions.\n\nUse this for privilege upgrades, enabling new features, or plan changes that grant additional capabilities. Permissions granted through roles remain unchanged.\n\n**Important**: Changes take effect immediately with up to 30-second edge propagation.\n\n**Required Permissions**\n\nYour root key must have one of the following permissions:\n- `api.*.update_key` (to update keys in any API)\n- `api..update_key` (to update keys in a specific API)\n\n**Side Effects**\n\nInvalidates the key cache for immediate effect, and makes permissions available for verification within 30 seconds across all regions.\n" }, "response": [ { "id": "7f3ef021-100f-42db-8863-d13934ff2322", "name": "Permissions added successfully. Returns all permissions currently assigned to the key.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"jmjm\",\n \"permissions\": [\n \"A*A*\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addPermissions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": [\n {\n \"id\": \"UZzWRN\",\n \"name\": \"\",\n \"slug\": \"K1LzCPyZ.\",\n \"description\": \"\"\n },\n {\n \"id\": \"QAEQebsQT\",\n \"name\": \"\",\n \"slug\": \"ZL_VwSM0L\",\n \"description\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-7f3ef021-100f-42db-8863-d13934ff2322" }, { "id": "c4d5dfbb-6540-4dab-8c18-594d6b90ca41", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"jmjm\",\n \"permissions\": [\n \"A*A*\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addPermissions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-c4d5dfbb-6540-4dab-8c18-594d6b90ca41" }, { "id": "5e208c15-dfe8-453a-9f0e-f9c85e66b87d", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"jmjm\",\n \"permissions\": [\n \"A*A*\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addPermissions" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-5e208c15-dfe8-453a-9f0e-f9c85e66b87d" }, { "id": "25040a49-f7d2-4243-8a6d-593309b12bda", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"jmjm\",\n \"permissions\": [\n \"A*A*\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addPermissions" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-25040a49-f7d2-4243-8a6d-593309b12bda" }, { "id": "19a65780-0fce-45c7-a913-00124e86df2a", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"jmjm\",\n \"permissions\": [\n \"A*A*\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addPermissions" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-19a65780-0fce-45c7-a913-00124e86df2a" }, { "id": "e7341e59-ceda-49fb-b0b0-44aebf6a8230", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"jmjm\",\n \"permissions\": [\n \"A*A*\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addPermissions" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-e7341e59-ceda-49fb-b0b0-44aebf6a8230" }, { "id": "89b9ca11-dd69-428a-a582-f21f9aa79e6b", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"jmjm\",\n \"permissions\": [\n \"A*A*\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addPermissions" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-89b9ca11-dd69-428a-a582-f21f9aa79e6b" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-5d71fdb9-8fb1-4b31-83a5-78b3080aded1" } ], "id": "65ccc03e-4d9b-43cc-9f75-49b87c50b2a8", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-65ccc03e-4d9b-43cc-9f75-49b87c50b2a8" }, { "name": "keys.addRoles", "item": [ { "name": "Add Key Roles", "id": "9e72f87c-555c-4b59-b53b-c79e4095fb43", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ofzuQJ_\",\n \"roles\": [\n \"Rg7I9n3wA-2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addRoles" ] }, "description": "Add roles to a key without affecting existing roles or permissions.\n\nUse this for privilege upgrades, enabling new feature sets, or subscription changes that grant additional role-based capabilities. Direct permissions remain unchanged.\n\n**Important**: Changes take effect immediately with up to 30-second edge propagation.\n\n**Required Permissions**\n\nYour root key must have one of the following permissions:\n- `api.*.update_key` (to update keys in any API)\n- `api..update_key` (to update keys in a specific API)\n\n**Side Effects**\n\nInvalidates the key cache for immediate effect, and makes role assignments available for verification within 30 seconds across all regions.\n" }, "response": [ { "id": "551cdf3f-1ddb-4e30-a54c-510f0c4156ef", "name": "Roles added successfully. Returns all roles currently assigned to the key.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ofzuQJ_\",\n \"roles\": [\n \"Rg7I9n3wA-2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addRoles" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"id\": \"1kMVHVxdU\",\n \"name\": \"\",\n \"slug\": \"_o27-defm\",\n \"description\": \"\"\n },\n {\n \"id\": \"RC_KD\",\n \"name\": \"\",\n \"slug\": \"LW\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"id\": \"Om4cD\",\n \"name\": \"\",\n \"slug\": \"tPxa64dM2\",\n \"description\": \"\"\n },\n {\n \"id\": \"6cnl6\",\n \"name\": \"\",\n \"slug\": \"hrjqCtLLK\",\n \"description\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-551cdf3f-1ddb-4e30-a54c-510f0c4156ef" }, { "id": "46ec34f6-5438-4525-b248-cb6b1d8fffb2", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ofzuQJ_\",\n \"roles\": [\n \"Rg7I9n3wA-2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addRoles" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-46ec34f6-5438-4525-b248-cb6b1d8fffb2" }, { "id": "d0fed5f2-e5c6-4382-8fce-f1f8c9f7938c", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ofzuQJ_\",\n \"roles\": [\n \"Rg7I9n3wA-2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addRoles" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-d0fed5f2-e5c6-4382-8fce-f1f8c9f7938c" }, { "id": "6555b104-aae7-4406-ac38-642767dfea1b", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ofzuQJ_\",\n \"roles\": [\n \"Rg7I9n3wA-2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addRoles" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-6555b104-aae7-4406-ac38-642767dfea1b" }, { "id": "2afd5677-a4f2-44d1-b573-6c4ca5bba756", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ofzuQJ_\",\n \"roles\": [\n \"Rg7I9n3wA-2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addRoles" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-2afd5677-a4f2-44d1-b573-6c4ca5bba756" }, { "id": "47b3ceca-82e8-4c6b-8249-65e7b7208250", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ofzuQJ_\",\n \"roles\": [\n \"Rg7I9n3wA-2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addRoles" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-47b3ceca-82e8-4c6b-8249-65e7b7208250" }, { "id": "f018a93e-ef48-4f68-899c-6571ed8e3fb4", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ofzuQJ_\",\n \"roles\": [\n \"Rg7I9n3wA-2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.addRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.addRoles" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-f018a93e-ef48-4f68-899c-6571ed8e3fb4" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-9e72f87c-555c-4b59-b53b-c79e4095fb43" } ], "id": "301b8344-9005-4a85-b052-f116b8f7f31f", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-301b8344-9005-4a85-b052-f116b8f7f31f" }, { "name": "keys.createKey", "item": [ { "name": "Create API Key", "id": "f967a569-2ddf-4179-b9a9-34c2f3d78b8b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"apiId\": \"okok\",\n \"prefix\": \"y2GrojD7cSQ\",\n \"name\": \"\",\n \"byteLength\": 16,\n \"externalId\": \"hBp\",\n \"meta\": {\n \"adipisicing1_1\": \"Ut\",\n \"commodo_21\": true,\n \"et_0a\": \"nisi in labore laboris Lorem\",\n \"incididunt_03\": true,\n \"deserunt_a\": -52485479,\n \"Excepteurc\": true,\n \"deserunt_50\": true,\n \"velit96_\": \"nostrud est consectetur\",\n \"nulla4c\": 26106032.678815663,\n \"in3fa\": \"dolor ad\",\n \"officia95e\": false,\n \"ea_4\": true,\n \"ea859\": false,\n \"consequat2\": -8632903,\n \"veniamc\": false,\n \"voluptate7\": -51985061.56079561,\n \"Excepteure0\": 56393769,\n \"quis67\": false,\n \"etb\": -80193264.18700258,\n \"Excepteur_93\": \"reprehenderit quis eu\",\n \"in_9e\": 8621449,\n \"exercitation_aea\": -69910602,\n \"qui_22\": false\n },\n \"roles\": [\n \"*3S9g\",\n \"djp5U-7\"\n ],\n \"permissions\": \"R\",\n \"expires\": \"\",\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": true,\n \"recoverable\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.createKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.createKey" ] }, "description": "Create a new API key for user authentication and authorization.\n\nUse this endpoint when users sign up, upgrade subscription tiers, or need additional keys. Keys are cryptographically secure and unique to the specified API namespace.\n\n**Important**: The key is returned only once. Store it immediately and provide it to your user, as it cannot be retrieved later.\n\n**Common use cases:**\n- Generate keys for new user registrations\n- Create additional keys for different applications\n- Issue keys with specific permissions or limits\n\n**Required Permissions**\n\nYour root key needs one of:\n- `api.*.create_key` (create keys in any API)\n- `api..create_key` (create keys in specific API)\n" }, "response": [ { "id": "d7b83b84-88af-4d4c-8b54-ae18e2c5621c", "name": "Successfully created a new API key. The response includes both the keyId (for reference in your system) and the full key string. IMPORTANT: This is the only time the complete key is available - it cannot be retrieved later. You must securely provide this ", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"apiId\": \"okok\",\n \"prefix\": \"y2GrojD7cSQ\",\n \"name\": \"\",\n \"byteLength\": 16,\n \"externalId\": \"hBp\",\n \"meta\": {\n \"adipisicing1_1\": \"Ut\",\n \"commodo_21\": true,\n \"et_0a\": \"nisi in labore laboris Lorem\",\n \"incididunt_03\": true,\n \"deserunt_a\": -52485479,\n \"Excepteurc\": true,\n \"deserunt_50\": true,\n \"velit96_\": \"nostrud est consectetur\",\n \"nulla4c\": 26106032.678815663,\n \"in3fa\": \"dolor ad\",\n \"officia95e\": false,\n \"ea_4\": true,\n \"ea859\": false,\n \"consequat2\": -8632903,\n \"veniamc\": false,\n \"voluptate7\": -51985061.56079561,\n \"Excepteure0\": 56393769,\n \"quis67\": false,\n \"etb\": -80193264.18700258,\n \"Excepteur_93\": \"reprehenderit quis eu\",\n \"in_9e\": 8621449,\n \"exercitation_aea\": -69910602,\n \"qui_22\": false\n },\n \"roles\": [\n \"*3S9g\",\n \"djp5U-7\"\n ],\n \"permissions\": \"R\",\n \"expires\": \"\",\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": true,\n \"recoverable\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.createKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.createKey" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": {\n \"keyId\": \"\",\n \"key\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-d7b83b84-88af-4d4c-8b54-ae18e2c5621c" }, { "id": "c23830d8-a206-4551-940c-8185128cf8ac", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"apiId\": \"okok\",\n \"prefix\": \"y2GrojD7cSQ\",\n \"name\": \"\",\n \"byteLength\": 16,\n \"externalId\": \"hBp\",\n \"meta\": {\n \"adipisicing1_1\": \"Ut\",\n \"commodo_21\": true,\n \"et_0a\": \"nisi in labore laboris Lorem\",\n \"incididunt_03\": true,\n \"deserunt_a\": -52485479,\n \"Excepteurc\": true,\n \"deserunt_50\": true,\n \"velit96_\": \"nostrud est consectetur\",\n \"nulla4c\": 26106032.678815663,\n \"in3fa\": \"dolor ad\",\n \"officia95e\": false,\n \"ea_4\": true,\n \"ea859\": false,\n \"consequat2\": -8632903,\n \"veniamc\": false,\n \"voluptate7\": -51985061.56079561,\n \"Excepteure0\": 56393769,\n \"quis67\": false,\n \"etb\": -80193264.18700258,\n \"Excepteur_93\": \"reprehenderit quis eu\",\n \"in_9e\": 8621449,\n \"exercitation_aea\": -69910602,\n \"qui_22\": false\n },\n \"roles\": [\n \"*3S9g\",\n \"djp5U-7\"\n ],\n \"permissions\": \"R\",\n \"expires\": \"\",\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": true,\n \"recoverable\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.createKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.createKey" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-c23830d8-a206-4551-940c-8185128cf8ac" }, { "id": "dc7a5643-0aaf-4d0a-85f2-566a311a06cc", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"apiId\": \"okok\",\n \"prefix\": \"y2GrojD7cSQ\",\n \"name\": \"\",\n \"byteLength\": 16,\n \"externalId\": \"hBp\",\n \"meta\": {\n \"adipisicing1_1\": \"Ut\",\n \"commodo_21\": true,\n \"et_0a\": \"nisi in labore laboris Lorem\",\n \"incididunt_03\": true,\n \"deserunt_a\": -52485479,\n \"Excepteurc\": true,\n \"deserunt_50\": true,\n \"velit96_\": \"nostrud est consectetur\",\n \"nulla4c\": 26106032.678815663,\n \"in3fa\": \"dolor ad\",\n \"officia95e\": false,\n \"ea_4\": true,\n \"ea859\": false,\n \"consequat2\": -8632903,\n \"veniamc\": false,\n \"voluptate7\": -51985061.56079561,\n \"Excepteure0\": 56393769,\n \"quis67\": false,\n \"etb\": -80193264.18700258,\n \"Excepteur_93\": \"reprehenderit quis eu\",\n \"in_9e\": 8621449,\n \"exercitation_aea\": -69910602,\n \"qui_22\": false\n },\n \"roles\": [\n \"*3S9g\",\n \"djp5U-7\"\n ],\n \"permissions\": \"R\",\n \"expires\": \"\",\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": true,\n \"recoverable\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.createKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.createKey" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-dc7a5643-0aaf-4d0a-85f2-566a311a06cc" }, { "id": "4155a60c-0e68-4e2e-beea-d14ef7ea0983", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"apiId\": \"okok\",\n \"prefix\": \"y2GrojD7cSQ\",\n \"name\": \"\",\n \"byteLength\": 16,\n \"externalId\": \"hBp\",\n \"meta\": {\n \"adipisicing1_1\": \"Ut\",\n \"commodo_21\": true,\n \"et_0a\": \"nisi in labore laboris Lorem\",\n \"incididunt_03\": true,\n \"deserunt_a\": -52485479,\n \"Excepteurc\": true,\n \"deserunt_50\": true,\n \"velit96_\": \"nostrud est consectetur\",\n \"nulla4c\": 26106032.678815663,\n \"in3fa\": \"dolor ad\",\n \"officia95e\": false,\n \"ea_4\": true,\n \"ea859\": false,\n \"consequat2\": -8632903,\n \"veniamc\": false,\n \"voluptate7\": -51985061.56079561,\n \"Excepteure0\": 56393769,\n \"quis67\": false,\n \"etb\": -80193264.18700258,\n \"Excepteur_93\": \"reprehenderit quis eu\",\n \"in_9e\": 8621449,\n \"exercitation_aea\": -69910602,\n \"qui_22\": false\n },\n \"roles\": [\n \"*3S9g\",\n \"djp5U-7\"\n ],\n \"permissions\": \"R\",\n \"expires\": \"\",\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": true,\n \"recoverable\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.createKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.createKey" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-4155a60c-0e68-4e2e-beea-d14ef7ea0983" }, { "id": "aab989cd-e565-4aa9-a98a-1902eb05447a", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"apiId\": \"okok\",\n \"prefix\": \"y2GrojD7cSQ\",\n \"name\": \"\",\n \"byteLength\": 16,\n \"externalId\": \"hBp\",\n \"meta\": {\n \"adipisicing1_1\": \"Ut\",\n \"commodo_21\": true,\n \"et_0a\": \"nisi in labore laboris Lorem\",\n \"incididunt_03\": true,\n \"deserunt_a\": -52485479,\n \"Excepteurc\": true,\n \"deserunt_50\": true,\n \"velit96_\": \"nostrud est consectetur\",\n \"nulla4c\": 26106032.678815663,\n \"in3fa\": \"dolor ad\",\n \"officia95e\": false,\n \"ea_4\": true,\n \"ea859\": false,\n \"consequat2\": -8632903,\n \"veniamc\": false,\n \"voluptate7\": -51985061.56079561,\n \"Excepteure0\": 56393769,\n \"quis67\": false,\n \"etb\": -80193264.18700258,\n \"Excepteur_93\": \"reprehenderit quis eu\",\n \"in_9e\": 8621449,\n \"exercitation_aea\": -69910602,\n \"qui_22\": false\n },\n \"roles\": [\n \"*3S9g\",\n \"djp5U-7\"\n ],\n \"permissions\": \"R\",\n \"expires\": \"\",\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": true,\n \"recoverable\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.createKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.createKey" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-aab989cd-e565-4aa9-a98a-1902eb05447a" }, { "id": "67a89534-fb71-489c-a8f1-4b71a701d189", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"apiId\": \"okok\",\n \"prefix\": \"y2GrojD7cSQ\",\n \"name\": \"\",\n \"byteLength\": 16,\n \"externalId\": \"hBp\",\n \"meta\": {\n \"adipisicing1_1\": \"Ut\",\n \"commodo_21\": true,\n \"et_0a\": \"nisi in labore laboris Lorem\",\n \"incididunt_03\": true,\n \"deserunt_a\": -52485479,\n \"Excepteurc\": true,\n \"deserunt_50\": true,\n \"velit96_\": \"nostrud est consectetur\",\n \"nulla4c\": 26106032.678815663,\n \"in3fa\": \"dolor ad\",\n \"officia95e\": false,\n \"ea_4\": true,\n \"ea859\": false,\n \"consequat2\": -8632903,\n \"veniamc\": false,\n \"voluptate7\": -51985061.56079561,\n \"Excepteure0\": 56393769,\n \"quis67\": false,\n \"etb\": -80193264.18700258,\n \"Excepteur_93\": \"reprehenderit quis eu\",\n \"in_9e\": 8621449,\n \"exercitation_aea\": -69910602,\n \"qui_22\": false\n },\n \"roles\": [\n \"*3S9g\",\n \"djp5U-7\"\n ],\n \"permissions\": \"R\",\n \"expires\": \"\",\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": true,\n \"recoverable\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.createKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.createKey" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-67a89534-fb71-489c-a8f1-4b71a701d189" }, { "id": "9c951412-2768-4ada-b467-4f382ed096d1", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"apiId\": \"okok\",\n \"prefix\": \"y2GrojD7cSQ\",\n \"name\": \"\",\n \"byteLength\": 16,\n \"externalId\": \"hBp\",\n \"meta\": {\n \"adipisicing1_1\": \"Ut\",\n \"commodo_21\": true,\n \"et_0a\": \"nisi in labore laboris Lorem\",\n \"incididunt_03\": true,\n \"deserunt_a\": -52485479,\n \"Excepteurc\": true,\n \"deserunt_50\": true,\n \"velit96_\": \"nostrud est consectetur\",\n \"nulla4c\": 26106032.678815663,\n \"in3fa\": \"dolor ad\",\n \"officia95e\": false,\n \"ea_4\": true,\n \"ea859\": false,\n \"consequat2\": -8632903,\n \"veniamc\": false,\n \"voluptate7\": -51985061.56079561,\n \"Excepteure0\": 56393769,\n \"quis67\": false,\n \"etb\": -80193264.18700258,\n \"Excepteur_93\": \"reprehenderit quis eu\",\n \"in_9e\": 8621449,\n \"exercitation_aea\": -69910602,\n \"qui_22\": false\n },\n \"roles\": [\n \"*3S9g\",\n \"djp5U-7\"\n ],\n \"permissions\": \"R\",\n \"expires\": \"\",\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": true,\n \"recoverable\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.createKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.createKey" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-9c951412-2768-4ada-b467-4f382ed096d1" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-f967a569-2ddf-4179-b9a9-34c2f3d78b8b" } ], "id": "84ce6f8e-9b9e-41f5-a78b-90b4b3f0b9f9", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-84ce6f8e-9b9e-41f5-a78b-90b4b3f0b9f9" }, { "name": "keys.deleteKey", "item": [ { "name": "Delete API Keys", "id": "302d23e9-8a45-4f03-ab08-593524046636", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"XM_7SK\",\n \"permanent\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.deleteKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.deleteKey" ] }, "description": "Delete API keys permanently from user accounts or for cleanup purposes.\n\nUse this for user-requested key deletion, account deletion workflows, or cleaning up unused keys. Keys are immediately invalidated. Two modes: soft delete (default, preserves audit records) and permanent delete.\n\n**Important**: For temporary access control, use `updateKey` with `enabled: false` instead of deletion.\n\n**Required Permissions**\n\nYour root key must have one of the following permissions:\n- `api.*.delete_key` (to delete keys in any API)\n- `api..delete_key` (to delete keys in a specific API)\n" }, "response": [ { "id": "b1702766-d374-4af7-a0f2-6ee0d3931984", "name": "Key deleted successfully. Verification fails immediately with up to 30-second edge propagation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"XM_7SK\",\n \"permanent\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.deleteKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.deleteKey" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": {}\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-b1702766-d374-4af7-a0f2-6ee0d3931984" }, { "id": "66036cdf-3074-4c03-812d-fe353644dea6", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"XM_7SK\",\n \"permanent\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.deleteKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.deleteKey" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-66036cdf-3074-4c03-812d-fe353644dea6" }, { "id": "4ef1510a-8a43-499f-a369-a990fd88d6cd", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"XM_7SK\",\n \"permanent\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.deleteKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.deleteKey" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-4ef1510a-8a43-499f-a369-a990fd88d6cd" }, { "id": "28a372f9-1678-4a43-957f-a9089be9af2b", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"XM_7SK\",\n \"permanent\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.deleteKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.deleteKey" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-28a372f9-1678-4a43-957f-a9089be9af2b" }, { "id": "f6dda93a-103d-4271-aafd-afcc284c930b", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"XM_7SK\",\n \"permanent\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.deleteKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.deleteKey" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-f6dda93a-103d-4271-aafd-afcc284c930b" }, { "id": "124b0227-b333-4727-af35-1a5b50272207", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"XM_7SK\",\n \"permanent\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.deleteKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.deleteKey" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-124b0227-b333-4727-af35-1a5b50272207" }, { "id": "d2a50b63-20b8-4793-b82e-19a911092cce", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"XM_7SK\",\n \"permanent\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.deleteKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.deleteKey" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-d2a50b63-20b8-4793-b82e-19a911092cce" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-302d23e9-8a45-4f03-ab08-593524046636" } ], "id": "dafff8f9-4013-4951-a2b1-7f093f87b49a", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-dafff8f9-4013-4951-a2b1-7f093f87b49a" }, { "name": "keys.getKey", "item": [ { "name": "Get API Key", "id": "3cd463a5-4268-42d8-b274-04e39529a8eb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"8eiSBT_\",\n \"decrypt\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.getKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.getKey" ] }, "description": "Retrieve detailed key information for dashboard interfaces and administrative purposes.\n\nUse this to build key management dashboards showing users their key details, status, permissions, and usage data. You can identify keys by `keyId` or the actual key string.\n\n**Important**: Set `decrypt: true` only in secure contexts to retrieve plaintext key values from recoverable keys.\n\n**Required Permissions**\n\nYour root key must have one of the following permissions for basic key information:\n- `api.*.read_key` (to read keys from any API)\n- `api..read_key` (to read keys from a specific API)\n\nAdditional permission required for decrypt functionality:\n- `api.*.decrypt_key` or `api..decrypt_key`\n" }, "response": [ { "id": "986156b3-8a93-48a6-ba5a-46e78f9c93cb", "name": "Successfully retrieved key information. When `decrypt: true`, includes plaintext key value for recoverable keys.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"8eiSBT_\",\n \"decrypt\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.getKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.getKey" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": {\n \"keyId\": \"8SWccID_Y\",\n \"start\": \"\",\n \"createdAt\": \"\",\n \"enabled\": \"\",\n \"name\": \"\",\n \"meta\": {\n \"exercitation9a\": 86101735,\n \"autefc\": false,\n \"Ut1d\": false,\n \"Excepteur_f\": false,\n \"ea6e2\": -86748389,\n \"dolorec\": \"qui labore consequat aliquip\",\n \"Ut9cf\": 63316408,\n \"nostrude\": true,\n \"elitd1\": -19204744.537709713,\n \"consectetur_a\": 97508271,\n \"do_9\": 84948410,\n \"nisi_8e7\": -74347912,\n \"ea_cd\": true,\n \"culpa_2d\": 14437334,\n \"in_01\": false,\n \"consectetur_4b\": true,\n \"non9\": -87662649,\n \"adipisicing_c60\": 70837440,\n \"pariaturcba\": false,\n \"amet75\": -90655236,\n \"doloree\": 46560214.74128255,\n \"in__\": false,\n \"incididunt_83\": 72026854.02061924,\n \"voluptate_21f\": -92439360,\n \"estb7\": -99460260,\n \"et0\": false,\n \"sit4\": 75481113.44298384,\n \"voluptatef\": -85425017.36619474,\n \"sunt_6\": -85323463,\n \"fugiat81\": 67285067.58594733,\n \"cillumc3\": -96979745,\n \"velit_2\": -88754322.32458782,\n \"exercitation_c12\": -9778876,\n \"veniam_9\": 32684534.714871645,\n \"laboruma\": -41388358.23677782,\n \"sit94\": \"cupidatat culpa\",\n \"cupidatata\": true,\n \"est_84e\": -86024141.13426304,\n \"reprehenderit_1\": -93347278.36182207,\n \"aliqua_454\": true,\n \"non2a\": \"enim dolore anim\",\n \"laborum_80\": \"qui consect\",\n \"aliquip_572\": false,\n \"minim_73\": true,\n \"amet52\": 88458859.56324264,\n \"laboruma5\": 55524170,\n \"eiusmod11a\": -80206862.20291542,\n \"dolor_b\": true,\n \"eta02\": \"fugiat\",\n \"cupidatat_60\": 87749369.20095557,\n \"dolor15f\": -87769904.04662839,\n \"Excepteur4a_\": \"velit quis consectetur eu\",\n \"adipisicing80c\": -86648044.80721906,\n \"sit8\": 19735590,\n \"sint_525\": \"sunt dolore anim pariatur\",\n \"velit_58\": -96913536,\n \"ea_4b0\": \"sunt Lorem eiusmod\",\n \"irure871\": true,\n \"Lorem_d8b\": false,\n \"sit_20\": -30199584,\n \"cillum_621\": \"laborum dolore aute\",\n \"labore_f65\": false,\n \"dolore562\": \"amet nostrud proident laborum\",\n \"cillum23a\": true,\n \"culpa_1\": \"nostrud dolor voluptate officia\",\n \"sed_44f\": true,\n \"id_5e\": false,\n \"ea_38\": 11782565.024960816,\n \"commodo433\": 27575232,\n \"reprehenderite\": -95505081.7339714,\n \"pariatur_d64\": \"dolor eu in nulla\",\n \"consecteture5f\": 56231281.32196644,\n \"magna9f\": false,\n \"quiabb\": \"in nostrud\",\n \"aliqua_e\": 45776659.08265525,\n \"pariatur_32e\": 64341627,\n \"Utec\": 33410526.01136218,\n \"magnac5\": \"laborum dolor Ut\",\n \"Excepteur9\": -14382831.263933718,\n \"et1\": 24058332.49834095,\n \"aute3ad\": \"consequat officia\",\n \"nisi_42\": \"cillum minim est\",\n \"labore_adb\": true,\n \"ida7\": true,\n \"tempore\": true,\n \"fugiat_fc\": true,\n \"non_b\": true,\n \"irure_4f\": \"proiden\",\n \"fugiat_eed\": 20730491,\n \"laboris_c2\": true,\n \"ut1c\": 7014546.34120369,\n \"occaecatac\": -65494071.446687266,\n \"irure_863\": \"aliquip ipsum cillum\",\n \"cupidatat39\": \"non aliqua pariatur\",\n \"nisi_0\": true\n },\n \"updatedAt\": \"\",\n \"lastUsedAt\": \"\",\n \"expires\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"\",\n \"\"\n ],\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"identity\": {\n \"externalId\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"officia81\": false\n },\n \"ratelimits\": [\n {\n \"id\": \"rl_gtmLk34\",\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": \"\"\n },\n {\n \"id\": \"rl_CB3rl_CB3\",\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": \"\"\n }\n ]\n },\n \"plaintext\": \"\",\n \"ratelimits\": [\n {\n \"id\": \"rl_JdH2MBvj9hG\",\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": \"\"\n },\n {\n \"id\": \"rl_L8rl_L8\",\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-986156b3-8a93-48a6-ba5a-46e78f9c93cb" }, { "id": "6a7e26fb-74b9-4624-ad54-77ded5fc4ce1", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"8eiSBT_\",\n \"decrypt\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.getKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.getKey" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-6a7e26fb-74b9-4624-ad54-77ded5fc4ce1" }, { "id": "509a933e-426d-4851-b359-44bdfe2e65be", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"8eiSBT_\",\n \"decrypt\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.getKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.getKey" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-509a933e-426d-4851-b359-44bdfe2e65be" }, { "id": "5d3d7e4f-2bfa-4721-9253-7fe8c66ae979", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"8eiSBT_\",\n \"decrypt\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.getKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.getKey" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-5d3d7e4f-2bfa-4721-9253-7fe8c66ae979" }, { "id": "49de2f68-80db-45da-987a-c8789b864bd9", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"8eiSBT_\",\n \"decrypt\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.getKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.getKey" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-49de2f68-80db-45da-987a-c8789b864bd9" }, { "id": "fe3fe08e-3d08-485d-9705-545c315d6688", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"8eiSBT_\",\n \"decrypt\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.getKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.getKey" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-fe3fe08e-3d08-485d-9705-545c315d6688" }, { "id": "54e71aed-6d85-4a38-b301-bd81fc93f7cd", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"8eiSBT_\",\n \"decrypt\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.getKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.getKey" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-54e71aed-6d85-4a38-b301-bd81fc93f7cd" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-3cd463a5-4268-42d8-b274-04e39529a8eb" } ], "id": "c7adc625-2577-4906-9d6f-063eafe5bf44", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-c7adc625-2577-4906-9d6f-063eafe5bf44" }, { "name": "keys.migrateKeys", "item": [ { "name": "Migrate API Key(s)", "id": "88d86345-560a-48e3-960d-6695e2ef058b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"migrationId\": \"\",\n \"apiId\": \"\",\n \"keys\": [\n {\n \"hash\": \"\",\n \"name\": \"\",\n \"externalId\": \"\",\n \"meta\": {\n \"nulla_f\": 2975976.2805974633,\n \"Duisd3\": 62041655.240302384,\n \"nisi653\": \"reprehenderit oc\",\n \"sitff\": -14955061.412011132,\n \"quis__\": -2130736.2443442494,\n \"veniam_a\": -83897425.43132415,\n \"inb0\": -15765441,\n \"fugiat37a\": -65826522.746479996,\n \"ipsum035\": false,\n \"tempor_4\": \"ex\",\n \"sint21\": -47171872.95206631,\n \"velit_0\": false\n },\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"expires\": \"\",\n \"enabled\": true,\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.migrateKeys", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.migrateKeys" ] }, "description": "Returns HTTP 200 even on partial success; hashes that could not be migrated are listed under `data.failed`.\n\n**Required Permissions**\nYour root key must have one of the following permissions for basic key information:\n- `api.*.create_key` (to migrate keys to any API)\n- `api..create_key` (to migrate keys to a specific API)\n" }, "response": [ { "id": "2636bd65-c0cb-4074-ad67-b607f18af8b9", "name": "Successfully migrated keys.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"migrationId\": \"\",\n \"apiId\": \"\",\n \"keys\": [\n {\n \"hash\": \"\",\n \"name\": \"\",\n \"externalId\": \"\",\n \"meta\": {\n \"nulla_f\": 2975976.2805974633,\n \"Duisd3\": 62041655.240302384,\n \"nisi653\": \"reprehenderit oc\",\n \"sitff\": -14955061.412011132,\n \"quis__\": -2130736.2443442494,\n \"veniam_a\": -83897425.43132415,\n \"inb0\": -15765441,\n \"fugiat37a\": -65826522.746479996,\n \"ipsum035\": false,\n \"tempor_4\": \"ex\",\n \"sint21\": -47171872.95206631,\n \"velit_0\": false\n },\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"expires\": \"\",\n \"enabled\": true,\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.migrateKeys", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.migrateKeys" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": {\n \"migrated\": [\n {\n \"hash\": \"\",\n \"keyId\": \"\"\n },\n {\n \"hash\": \"\",\n \"keyId\": \"\"\n }\n ],\n \"failed\": [\n \"\",\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-2636bd65-c0cb-4074-ad67-b607f18af8b9" }, { "id": "d95201dd-56be-4fdf-b290-5248161953f7", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"migrationId\": \"\",\n \"apiId\": \"\",\n \"keys\": [\n {\n \"hash\": \"\",\n \"name\": \"\",\n \"externalId\": \"\",\n \"meta\": {\n \"nulla_f\": 2975976.2805974633,\n \"Duisd3\": 62041655.240302384,\n \"nisi653\": \"reprehenderit oc\",\n \"sitff\": -14955061.412011132,\n \"quis__\": -2130736.2443442494,\n \"veniam_a\": -83897425.43132415,\n \"inb0\": -15765441,\n \"fugiat37a\": -65826522.746479996,\n \"ipsum035\": false,\n \"tempor_4\": \"ex\",\n \"sint21\": -47171872.95206631,\n \"velit_0\": false\n },\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"expires\": \"\",\n \"enabled\": true,\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.migrateKeys", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.migrateKeys" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-d95201dd-56be-4fdf-b290-5248161953f7" }, { "id": "4671137f-adba-436f-9bff-6d156920ab3d", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"migrationId\": \"\",\n \"apiId\": \"\",\n \"keys\": [\n {\n \"hash\": \"\",\n \"name\": \"\",\n \"externalId\": \"\",\n \"meta\": {\n \"nulla_f\": 2975976.2805974633,\n \"Duisd3\": 62041655.240302384,\n \"nisi653\": \"reprehenderit oc\",\n \"sitff\": -14955061.412011132,\n \"quis__\": -2130736.2443442494,\n \"veniam_a\": -83897425.43132415,\n \"inb0\": -15765441,\n \"fugiat37a\": -65826522.746479996,\n \"ipsum035\": false,\n \"tempor_4\": \"ex\",\n \"sint21\": -47171872.95206631,\n \"velit_0\": false\n },\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"expires\": \"\",\n \"enabled\": true,\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.migrateKeys", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.migrateKeys" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-4671137f-adba-436f-9bff-6d156920ab3d" }, { "id": "0497ccf9-8218-4360-862f-4a3f4d432122", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"migrationId\": \"\",\n \"apiId\": \"\",\n \"keys\": [\n {\n \"hash\": \"\",\n \"name\": \"\",\n \"externalId\": \"\",\n \"meta\": {\n \"nulla_f\": 2975976.2805974633,\n \"Duisd3\": 62041655.240302384,\n \"nisi653\": \"reprehenderit oc\",\n \"sitff\": -14955061.412011132,\n \"quis__\": -2130736.2443442494,\n \"veniam_a\": -83897425.43132415,\n \"inb0\": -15765441,\n \"fugiat37a\": -65826522.746479996,\n \"ipsum035\": false,\n \"tempor_4\": \"ex\",\n \"sint21\": -47171872.95206631,\n \"velit_0\": false\n },\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"expires\": \"\",\n \"enabled\": true,\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.migrateKeys", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.migrateKeys" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-0497ccf9-8218-4360-862f-4a3f4d432122" }, { "id": "66e12e5e-2dc1-4176-8a17-a87697fbc9d1", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"migrationId\": \"\",\n \"apiId\": \"\",\n \"keys\": [\n {\n \"hash\": \"\",\n \"name\": \"\",\n \"externalId\": \"\",\n \"meta\": {\n \"nulla_f\": 2975976.2805974633,\n \"Duisd3\": 62041655.240302384,\n \"nisi653\": \"reprehenderit oc\",\n \"sitff\": -14955061.412011132,\n \"quis__\": -2130736.2443442494,\n \"veniam_a\": -83897425.43132415,\n \"inb0\": -15765441,\n \"fugiat37a\": -65826522.746479996,\n \"ipsum035\": false,\n \"tempor_4\": \"ex\",\n \"sint21\": -47171872.95206631,\n \"velit_0\": false\n },\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"expires\": \"\",\n \"enabled\": true,\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.migrateKeys", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.migrateKeys" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-66e12e5e-2dc1-4176-8a17-a87697fbc9d1" }, { "id": "3960a221-8889-4819-b562-72427c5fcea1", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"migrationId\": \"\",\n \"apiId\": \"\",\n \"keys\": [\n {\n \"hash\": \"\",\n \"name\": \"\",\n \"externalId\": \"\",\n \"meta\": {\n \"nulla_f\": 2975976.2805974633,\n \"Duisd3\": 62041655.240302384,\n \"nisi653\": \"reprehenderit oc\",\n \"sitff\": -14955061.412011132,\n \"quis__\": -2130736.2443442494,\n \"veniam_a\": -83897425.43132415,\n \"inb0\": -15765441,\n \"fugiat37a\": -65826522.746479996,\n \"ipsum035\": false,\n \"tempor_4\": \"ex\",\n \"sint21\": -47171872.95206631,\n \"velit_0\": false\n },\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"expires\": \"\",\n \"enabled\": true,\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.migrateKeys", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.migrateKeys" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-3960a221-8889-4819-b562-72427c5fcea1" }, { "id": "4279d4f5-e39c-436d-bb09-70e5083fb46f", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"migrationId\": \"\",\n \"apiId\": \"\",\n \"keys\": [\n {\n \"hash\": \"\",\n \"name\": \"\",\n \"externalId\": \"\",\n \"meta\": {\n \"nulla_f\": 2975976.2805974633,\n \"Duisd3\": 62041655.240302384,\n \"nisi653\": \"reprehenderit oc\",\n \"sitff\": -14955061.412011132,\n \"quis__\": -2130736.2443442494,\n \"veniam_a\": -83897425.43132415,\n \"inb0\": -15765441,\n \"fugiat37a\": -65826522.746479996,\n \"ipsum035\": false,\n \"tempor_4\": \"ex\",\n \"sint21\": -47171872.95206631,\n \"velit_0\": false\n },\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"expires\": \"\",\n \"enabled\": true,\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.migrateKeys", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.migrateKeys" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-4279d4f5-e39c-436d-bb09-70e5083fb46f" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-88d86345-560a-48e3-960d-6695e2ef058b" } ], "id": "d7dfb7ce-bd3d-4276-a934-dcd9a4f11926", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-d7dfb7ce-bd3d-4276-a934-dcd9a4f11926" }, { "name": "keys.removePermissions", "item": [ { "name": "Remove Key Permissions", "id": "d4e1619c-0ec8-4995-9986-ee7b3dc36f0b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ILKJeY\",\n \"permissions\": [\n \"EQfn\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removePermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removePermissions" ] }, "description": "Remove permissions from a key without affecting existing roles or other permissions.\n\nUse this for privilege downgrades, removing temporary access, or plan changes that revoke specific capabilities. Permissions granted through roles remain unchanged.\n\n**Important**: Changes take effect immediately with up to 30-second edge propagation.\n\n**Required Permissions**\n\nYour root key must have one of the following permissions:\n- `api.*.update_key` (to update keys in any API)\n- `api..update_key` (to update keys in a specific API)\n\n**Side Effects**\n\nInvalidates the key cache for immediate effect, and makes permission changes available for verification within 30 seconds across all regions.\n" }, "response": [ { "id": "e7af92b0-4d28-46c9-b889-4bb452ab54dc", "name": "Permissions removed successfully. Returns all permissions currently assigned to the key.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ILKJeY\",\n \"permissions\": [\n \"EQfn\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removePermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removePermissions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": [\n {\n \"id\": \"ZLnC77RAgr\",\n \"name\": \"\",\n \"slug\": \"BC49lvJ0\",\n \"description\": \"\"\n },\n {\n \"id\": \"uvsIUev98DI\",\n \"name\": \"\",\n \"slug\": \"SmoE1602Vsf\",\n \"description\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-e7af92b0-4d28-46c9-b889-4bb452ab54dc" }, { "id": "08616152-4134-48d1-bd10-c53cb817afc1", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ILKJeY\",\n \"permissions\": [\n \"EQfn\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removePermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removePermissions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-08616152-4134-48d1-bd10-c53cb817afc1" }, { "id": "8d6fa5a6-df3a-42ed-995d-1c5d2057e808", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ILKJeY\",\n \"permissions\": [\n \"EQfn\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removePermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removePermissions" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-8d6fa5a6-df3a-42ed-995d-1c5d2057e808" }, { "id": "797dfae1-1e47-4e83-a43f-9bd9cd80cf6b", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ILKJeY\",\n \"permissions\": [\n \"EQfn\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removePermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removePermissions" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-797dfae1-1e47-4e83-a43f-9bd9cd80cf6b" }, { "id": "bafbe9b2-17ef-4185-a68e-02d2ae0c86f4", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ILKJeY\",\n \"permissions\": [\n \"EQfn\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removePermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removePermissions" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-bafbe9b2-17ef-4185-a68e-02d2ae0c86f4" }, { "id": "e48b4b58-6e53-4f7a-8d2d-6f8731fda2d6", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ILKJeY\",\n \"permissions\": [\n \"EQfn\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removePermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removePermissions" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-e48b4b58-6e53-4f7a-8d2d-6f8731fda2d6" }, { "id": "20bf40ca-5584-4227-97ce-41f2d8e613e2", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"ILKJeY\",\n \"permissions\": [\n \"EQfn\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removePermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removePermissions" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-20bf40ca-5584-4227-97ce-41f2d8e613e2" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-d4e1619c-0ec8-4995-9986-ee7b3dc36f0b" } ], "id": "757b8bde-f5a1-4f97-b121-ce37803270f5", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-757b8bde-f5a1-4f97-b121-ce37803270f5" }, { "name": "keys.removeRoles", "item": [ { "name": "Remove Key Roles", "id": "9186af8c-7423-4843-be86-eda0a1521a3c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"hHQG\",\n \"roles\": [\n \"SGI-wJ\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removeRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removeRoles" ] }, "description": "Remove roles from a key without affecting direct permissions or other roles.\n\nUse this for privilege downgrades, removing temporary access, or subscription changes that revoke specific role-based capabilities. Direct permissions remain unchanged.\n\n**Important**: Changes take effect immediately with up to 30-second edge propagation.\n\n**Required Permissions**\n\nYour root key must have one of the following permissions:\n- `api.*.update_key` (to update keys in any API)\n- `api..update_key` (to update keys in a specific API)\n\n**Side Effects**\n\nInvalidates the key cache for immediate effect, and makes role changes available for verification within 30 seconds across all regions.\n" }, "response": [ { "id": "4a31f45e-27ba-4aee-acd5-a633300de28c", "name": "Roles removed successfully. Returns all roles currently assigned to the key.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"hHQG\",\n \"roles\": [\n \"SGI-wJ\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removeRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removeRoles" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"id\": \"Es7B\",\n \"name\": \"\",\n \"slug\": \"AzN.OikumOw\",\n \"description\": \"\"\n },\n {\n \"id\": \"jJumiYV9\",\n \"name\": \"\",\n \"slug\": \"Lft3O\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"id\": \"GHKHfl\",\n \"name\": \"\",\n \"slug\": \"_\",\n \"description\": \"\"\n },\n {\n \"id\": \"MXgkj8xQ0\",\n \"name\": \"\",\n \"slug\": \"g\",\n \"description\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-4a31f45e-27ba-4aee-acd5-a633300de28c" }, { "id": "089eb89c-a81e-4519-b63f-9f12a091d617", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"hHQG\",\n \"roles\": [\n \"SGI-wJ\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removeRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removeRoles" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-089eb89c-a81e-4519-b63f-9f12a091d617" }, { "id": "25bf7793-a3da-44c1-8e51-7680fbb0e041", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"hHQG\",\n \"roles\": [\n \"SGI-wJ\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removeRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removeRoles" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-25bf7793-a3da-44c1-8e51-7680fbb0e041" }, { "id": "182514cb-d622-4b9d-8aab-5e6436478ff9", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"hHQG\",\n \"roles\": [\n \"SGI-wJ\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removeRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removeRoles" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-182514cb-d622-4b9d-8aab-5e6436478ff9" }, { "id": "a76a961b-0705-463e-9b98-484a97999f08", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"hHQG\",\n \"roles\": [\n \"SGI-wJ\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removeRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removeRoles" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-a76a961b-0705-463e-9b98-484a97999f08" }, { "id": "8244c4ee-7292-4618-bfea-dc30975def50", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"hHQG\",\n \"roles\": [\n \"SGI-wJ\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removeRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removeRoles" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-8244c4ee-7292-4618-bfea-dc30975def50" }, { "id": "7cfc4c4b-444e-4cfb-9261-1648a944d6cf", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"hHQG\",\n \"roles\": [\n \"SGI-wJ\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.removeRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.removeRoles" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-7cfc4c4b-444e-4cfb-9261-1648a944d6cf" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-9186af8c-7423-4843-be86-eda0a1521a3c" } ], "id": "654dd9e9-1ed3-4c9a-9c2c-b4733635ebcd", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-654dd9e9-1ed3-4c9a-9c2c-b4733635ebcd" }, { "name": "keys.rerollKey", "item": [ { "name": "Reroll Key", "id": "e94dc654-3aed-441c-8445-97fbe833bdaf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"oooo\",\n \"expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.rerollKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.rerollKey" ] }, "description": "Generate a new API key while preserving the configuration from an existing key.\n\nThis operation creates a fresh key with a new token while maintaining all settings from the original key:\n- Permissions and roles\n- Custom metadata\n- Rate limit configurations\n- Identity associations\n- Remaining credits\n- Recovery settings\n\n**Key Generation:**\n- The system attempts to extract the prefix from the original key\n- If prefix extraction fails, the default API prefix is used\n- Key length follows the API's default byte configuration (or 16 bytes if not specified)\n\n**Original Key Handling:**\n- The original key will be revoked after the duration specified in `expiration`\n- Set `expiration` to 0 to revoke immediately\n- This allows for graceful key rotation with an overlap period\n\nCommon use cases include:\n- Rotating keys for security compliance\n- Issuing replacement keys for compromised credentials\n- Creating backup keys with identical permissions\n\n**Important:** Analytics and usage metrics are tracked at both the key level AND identity level. If the original key has an identity, the new key will inherit it, allowing you to track usage across both individual keys and the overall identity.\n\n**Required Permissions**\n\n Your root key must have:\n - `api.*.create_key` or `api..create_key`\n - `api.*.encrypt_key` or `api..encrypt_key` (only when the original key is recoverable)\n" }, "response": [ { "id": "bec64738-503f-4f1f-85e4-9edf87b0a587", "name": "Key rerolled successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"oooo\",\n \"expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.rerollKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.rerollKey" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": {\n \"keyId\": \"\",\n \"key\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-bec64738-503f-4f1f-85e4-9edf87b0a587" }, { "id": "94a055e9-8338-42f7-af9f-c6f6877a8200", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"oooo\",\n \"expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.rerollKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.rerollKey" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-94a055e9-8338-42f7-af9f-c6f6877a8200" }, { "id": "172720b2-7777-487b-938d-0d02d8834288", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"oooo\",\n \"expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.rerollKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.rerollKey" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-172720b2-7777-487b-938d-0d02d8834288" }, { "id": "90c31a63-8197-4b4b-be65-be6fbfe77bb8", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"oooo\",\n \"expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.rerollKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.rerollKey" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-90c31a63-8197-4b4b-be65-be6fbfe77bb8" }, { "id": "ad1b4847-9554-4c10-9756-ea4b8bd2b5e3", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"oooo\",\n \"expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.rerollKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.rerollKey" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-ad1b4847-9554-4c10-9756-ea4b8bd2b5e3" }, { "id": "5a8f8ee2-141e-4d28-8678-39753437ad11", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"oooo\",\n \"expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.rerollKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.rerollKey" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-5a8f8ee2-141e-4d28-8678-39753437ad11" }, { "id": "66c96402-7556-4ec1-a39e-82f6e0faea90", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"oooo\",\n \"expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.rerollKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.rerollKey" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-66c96402-7556-4ec1-a39e-82f6e0faea90" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-e94dc654-3aed-441c-8445-97fbe833bdaf" } ], "id": "6fe35997-f3a0-4817-9b28-93265c406e4c", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-6fe35997-f3a0-4817-9b28-93265c406e4c" }, { "name": "keys.setPermissions", "item": [ { "name": "Set Key Permissions", "id": "d968dd8c-87bd-45b7-8ef4-d3aaf59ac35b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"AK6UOLpUVrQ\",\n \"permissions\": [\n \"6BkcQ\",\n \":2iO3\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setPermissions" ] }, "description": "Replace all permissions on a key with the specified set in a single atomic operation.\n\nUse this to synchronize with external systems, reset permissions to a known state, or apply standardized permission templates. Permissions granted through roles remain unchanged.\n\n**Important**: Changes take effect immediately with up to 30-second edge propagation.\n\n**Required Permissions**\n\nYour root key must have one of the following permissions:\n- `api.*.update_key` (to update keys in any API)\n- `api..update_key` (to update keys in a specific API)\n\n**Side Effects**\n\nInvalidates the key cache for immediate effect, and makes permission changes available for verification within 30 seconds across all regions.\n" }, "response": [ { "id": "751ff170-b375-4aa8-b26e-835d6a864900", "name": "Permissions set successfully. Returns all permissions currently assigned to the key.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"AK6UOLpUVrQ\",\n \"permissions\": [\n \"6BkcQ\",\n \":2iO3\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setPermissions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": [\n {\n \"id\": \"gF6W\",\n \"name\": \"\",\n \"slug\": \"IcP\",\n \"description\": \"\"\n },\n {\n \"id\": \"FpX\",\n \"name\": \"\",\n \"slug\": \"30cSAESFl:0\",\n \"description\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-751ff170-b375-4aa8-b26e-835d6a864900" }, { "id": "23204cd9-1b84-43d0-9685-62fcc0985508", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"AK6UOLpUVrQ\",\n \"permissions\": [\n \"6BkcQ\",\n \":2iO3\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setPermissions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-23204cd9-1b84-43d0-9685-62fcc0985508" }, { "id": "8931934d-6537-43fd-a062-3581b47bf8c4", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"AK6UOLpUVrQ\",\n \"permissions\": [\n \"6BkcQ\",\n \":2iO3\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setPermissions" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-8931934d-6537-43fd-a062-3581b47bf8c4" }, { "id": "b4bb9ac6-3fb3-4ecc-b966-81d787df1979", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"AK6UOLpUVrQ\",\n \"permissions\": [\n \"6BkcQ\",\n \":2iO3\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setPermissions" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-b4bb9ac6-3fb3-4ecc-b966-81d787df1979" }, { "id": "0c8e9146-ec25-43df-bdeb-bd1bfddc5ec4", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"AK6UOLpUVrQ\",\n \"permissions\": [\n \"6BkcQ\",\n \":2iO3\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setPermissions" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-0c8e9146-ec25-43df-bdeb-bd1bfddc5ec4" }, { "id": "8dd60d74-b036-4541-a571-ef2aaa5f9185", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"AK6UOLpUVrQ\",\n \"permissions\": [\n \"6BkcQ\",\n \":2iO3\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setPermissions" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-8dd60d74-b036-4541-a571-ef2aaa5f9185" }, { "id": "b8289883-e79d-4e4f-a220-ee1018ed0982", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"AK6UOLpUVrQ\",\n \"permissions\": [\n \"6BkcQ\",\n \":2iO3\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setPermissions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setPermissions" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-b8289883-e79d-4e4f-a220-ee1018ed0982" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-d968dd8c-87bd-45b7-8ef4-d3aaf59ac35b" } ], "id": "249bc8db-5ce9-4a21-80bb-087278316959", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-249bc8db-5ce9-4a21-80bb-087278316959" }, { "name": "keys.setRoles", "item": [ { "name": "Set Key Roles", "id": "7f103e89-d603-46ec-a1f7-362983bd6a17", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"GSUWTfZV3l\",\n \"roles\": [\n \"QJQJ\",\n \"EVEV\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setRoles" ] }, "description": "Replace all roles on a key with the specified set in a single atomic operation.\n\nUse this to synchronize with external systems, reset roles to a known state, or apply standardized role templates. Direct permissions are never affected.\n\n**Important**: Changes take effect immediately with up to 30-second edge propagation.\n\n**Required Permissions**\n\nYour root key must have one of the following permissions:\n- `api.*.update_key` (to update keys in any API)\n- `api..update_key` (to update keys in a specific API)\n\n**Side Effects**\n\nInvalidates the key cache for immediate effect, and makes role changes available for verification within 30 seconds across all regions.\n" }, "response": [ { "id": "e790bbb1-06e7-4488-b3fb-8c33361d8895", "name": "Roles set successfully. Returns all roles currently assigned to the key.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"GSUWTfZV3l\",\n \"roles\": [\n \"QJQJ\",\n \"EVEV\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setRoles" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"id\": \"3D26\",\n \"name\": \"\",\n \"slug\": \"ChjhSQBR.\",\n \"description\": \"\"\n },\n {\n \"id\": \"bll0bDVJB\",\n \"name\": \"\",\n \"slug\": \"2QsHXzDWp\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"permissions\": [\n {\n \"id\": \"Lyf5ZO\",\n \"name\": \"\",\n \"slug\": \"oF-\",\n \"description\": \"\"\n },\n {\n \"id\": \"WQx2r1c\",\n \"name\": \"\",\n \"slug\": \"1GE-T\",\n \"description\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-e790bbb1-06e7-4488-b3fb-8c33361d8895" }, { "id": "1476a2d9-7292-4d30-b3aa-95c8c345f8d3", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"GSUWTfZV3l\",\n \"roles\": [\n \"QJQJ\",\n \"EVEV\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setRoles" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-1476a2d9-7292-4d30-b3aa-95c8c345f8d3" }, { "id": "823031ac-f5a0-4f6d-9dff-d5a9565ab21b", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"GSUWTfZV3l\",\n \"roles\": [\n \"QJQJ\",\n \"EVEV\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setRoles" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-823031ac-f5a0-4f6d-9dff-d5a9565ab21b" }, { "id": "6aadf970-4a21-48d3-8a38-4f19c20de1e5", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"GSUWTfZV3l\",\n \"roles\": [\n \"QJQJ\",\n \"EVEV\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setRoles" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-6aadf970-4a21-48d3-8a38-4f19c20de1e5" }, { "id": "15ddf457-1f0c-4dd0-8cdf-61ff97e9ddfa", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"GSUWTfZV3l\",\n \"roles\": [\n \"QJQJ\",\n \"EVEV\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setRoles" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-15ddf457-1f0c-4dd0-8cdf-61ff97e9ddfa" }, { "id": "795bca83-2d74-495d-8b73-700f44d0005c", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"GSUWTfZV3l\",\n \"roles\": [\n \"QJQJ\",\n \"EVEV\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setRoles" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-795bca83-2d74-495d-8b73-700f44d0005c" }, { "id": "2afde0b1-bd5d-4e10-85e0-77dc22140680", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"GSUWTfZV3l\",\n \"roles\": [\n \"QJQJ\",\n \"EVEV\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.setRoles", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.setRoles" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-2afde0b1-bd5d-4e10-85e0-77dc22140680" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-7f103e89-d603-46ec-a1f7-362983bd6a17" } ], "id": "c12c0ce9-c1fa-4933-beb4-8a4f8caf4249", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-c12c0ce9-c1fa-4933-beb4-8a4f8caf4249" }, { "name": "keys.updateCredits", "item": [ { "name": "Update Key Credits", "id": "1e3acd7f-088d-4610-a9d3-2095d57b4a45", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"\",\n \"operation\": \"increment\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateCredits", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateCredits" ] }, "description": "Update credit quotas in response to plan changes, billing cycles, or usage purchases.\n\nUse this for user upgrades/downgrades, monthly quota resets, credit purchases, or promotional bonuses. Supports three operations: set, increment, or decrement credits. Set to null for unlimited usage.\n\n**Important**: Setting unlimited credits automatically clears existing refill configurations.\n\n**Required Permissions**\n\nYour root key must have one of the following permissions:\n- `api.*.update_key` (to update keys in any API)\n- `api..update_key` (to update keys in a specific API)\n\n**Side Effects**\n\nCredit updates remove the key from cache immediately. Setting credits to unlimited automatically clears any existing refill settings. Changes take effect instantly but may take up to 30 seconds to propagate to all edge regions.\n" }, "response": [ { "id": "4cc3de18-8908-41d1-b3e6-ddd2fc618c99", "name": "Credits updated successfully. Response includes updated remaining credits and refill settings.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"\",\n \"operation\": \"increment\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateCredits", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateCredits" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"daily\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-4cc3de18-8908-41d1-b3e6-ddd2fc618c99" }, { "id": "99baa654-6834-4f02-b657-cdbf5a0d062d", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"\",\n \"operation\": \"increment\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateCredits", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateCredits" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-99baa654-6834-4f02-b657-cdbf5a0d062d" }, { "id": "8f65b15a-4539-4d15-a737-7c83d39b8953", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"\",\n \"operation\": \"increment\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateCredits", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateCredits" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-8f65b15a-4539-4d15-a737-7c83d39b8953" }, { "id": "9a8be017-eb9e-4bd5-b3f6-48c16fbf4ec7", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"\",\n \"operation\": \"increment\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateCredits", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateCredits" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-9a8be017-eb9e-4bd5-b3f6-48c16fbf4ec7" }, { "id": "c848c342-4050-49d4-9d33-572792875b58", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"\",\n \"operation\": \"increment\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateCredits", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateCredits" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-c848c342-4050-49d4-9d33-572792875b58" }, { "id": "f40d290f-be77-4ca6-a019-21ed171f88f6", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"\",\n \"operation\": \"increment\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateCredits", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateCredits" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-f40d290f-be77-4ca6-a019-21ed171f88f6" }, { "id": "f07bcef0-373d-4859-af30-f023b16494e4", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"\",\n \"operation\": \"increment\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateCredits", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateCredits" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-f07bcef0-373d-4859-af30-f023b16494e4" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-1e3acd7f-088d-4610-a9d3-2095d57b4a45" } ], "id": "4fcd69b6-c176-403d-9f16-2565df3c1624", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-4fcd69b6-c176-403d-9f16-2565df3c1624" }, { "name": "keys.updateKey", "item": [ { "name": "Update Key Settings", "id": "b7512627-6e5e-403e-be9d-4f3ad9332290", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"45Yn1Nw\",\n \"name\": \"\",\n \"externalId\": \"MGPx\",\n \"meta\": {\n \"ullamco_3d\": \"voluptate consequat occaecat sit ad\",\n \"labore_e2\": -48650143.129794456,\n \"nulla_eb0\": -77561631.88153748,\n \"adipisicing45b\": \"Lorem in\",\n \"nostrud__\": -4906766,\n \"velitebd\": -39090990.39182089,\n \"ut_6\": \"culpa in\",\n \"seda1\": -16289818.60576953\n },\n \"expires\": \"\",\n \"credits\": null,\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": \"\",\n \"roles\": [\n \"LD-7L2d\",\n \"2nU5BY5aW\"\n ],\n \"permissions\": [\n \"4pN\",\n \"ABQB\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateKey" ] }, "description": "Update key properties in response to plan changes, subscription updates, or account status changes.\n\nUse this for user upgrades/downgrades, role modifications, or administrative changes. Supports partial updates - only specify fields you want to change. Set fields to null to clear them.\n\n**Important**: Permissions and roles are replaced entirely. Use dedicated add/remove endpoints for incremental changes.\n\n**Required Permissions**\n\nYour root key must have one of the following permissions:\n- `api.*.update_key` (to update keys in any API)\n- `api..update_key` (to update keys in a specific API)\n\n**Side Effects**\n\nIf you specify an `externalId` that doesn't exist, a new identity will be automatically created and linked to the key. Permission updates will auto-create any permissions that don't exist in your workspace. Changes take effect immediately but may take up to 30 seconds to propagate to all edge regions due to cache invalidation.\n" }, "response": [ { "id": "b66f9fb6-fc70-4a5d-a0ba-80485847b1e3", "name": "Key updated successfully. Changes take effect immediately with up to 30-second edge propagation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"45Yn1Nw\",\n \"name\": \"\",\n \"externalId\": \"MGPx\",\n \"meta\": {\n \"ullamco_3d\": \"voluptate consequat occaecat sit ad\",\n \"labore_e2\": -48650143.129794456,\n \"nulla_eb0\": -77561631.88153748,\n \"adipisicing45b\": \"Lorem in\",\n \"nostrud__\": -4906766,\n \"velitebd\": -39090990.39182089,\n \"ut_6\": \"culpa in\",\n \"seda1\": -16289818.60576953\n },\n \"expires\": \"\",\n \"credits\": null,\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": \"\",\n \"roles\": [\n \"LD-7L2d\",\n \"2nU5BY5aW\"\n ],\n \"permissions\": [\n \"4pN\",\n \"ABQB\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateKey" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": {}\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-b66f9fb6-fc70-4a5d-a0ba-80485847b1e3" }, { "id": "1f9e4572-a6c2-4826-92dd-b26245356b86", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"45Yn1Nw\",\n \"name\": \"\",\n \"externalId\": \"MGPx\",\n \"meta\": {\n \"ullamco_3d\": \"voluptate consequat occaecat sit ad\",\n \"labore_e2\": -48650143.129794456,\n \"nulla_eb0\": -77561631.88153748,\n \"adipisicing45b\": \"Lorem in\",\n \"nostrud__\": -4906766,\n \"velitebd\": -39090990.39182089,\n \"ut_6\": \"culpa in\",\n \"seda1\": -16289818.60576953\n },\n \"expires\": \"\",\n \"credits\": null,\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": \"\",\n \"roles\": [\n \"LD-7L2d\",\n \"2nU5BY5aW\"\n ],\n \"permissions\": [\n \"4pN\",\n \"ABQB\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateKey" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-1f9e4572-a6c2-4826-92dd-b26245356b86" }, { "id": "f15e8945-4ba3-4054-992c-8ae3e0db002c", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"45Yn1Nw\",\n \"name\": \"\",\n \"externalId\": \"MGPx\",\n \"meta\": {\n \"ullamco_3d\": \"voluptate consequat occaecat sit ad\",\n \"labore_e2\": -48650143.129794456,\n \"nulla_eb0\": -77561631.88153748,\n \"adipisicing45b\": \"Lorem in\",\n \"nostrud__\": -4906766,\n \"velitebd\": -39090990.39182089,\n \"ut_6\": \"culpa in\",\n \"seda1\": -16289818.60576953\n },\n \"expires\": \"\",\n \"credits\": null,\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": \"\",\n \"roles\": [\n \"LD-7L2d\",\n \"2nU5BY5aW\"\n ],\n \"permissions\": [\n \"4pN\",\n \"ABQB\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateKey" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-f15e8945-4ba3-4054-992c-8ae3e0db002c" }, { "id": "2da3e328-45d0-42fe-b69e-f5a5426d692a", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"45Yn1Nw\",\n \"name\": \"\",\n \"externalId\": \"MGPx\",\n \"meta\": {\n \"ullamco_3d\": \"voluptate consequat occaecat sit ad\",\n \"labore_e2\": -48650143.129794456,\n \"nulla_eb0\": -77561631.88153748,\n \"adipisicing45b\": \"Lorem in\",\n \"nostrud__\": -4906766,\n \"velitebd\": -39090990.39182089,\n \"ut_6\": \"culpa in\",\n \"seda1\": -16289818.60576953\n },\n \"expires\": \"\",\n \"credits\": null,\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": \"\",\n \"roles\": [\n \"LD-7L2d\",\n \"2nU5BY5aW\"\n ],\n \"permissions\": [\n \"4pN\",\n \"ABQB\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateKey" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-2da3e328-45d0-42fe-b69e-f5a5426d692a" }, { "id": "44c5210e-f098-4181-a17e-4c4eacddeb41", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"45Yn1Nw\",\n \"name\": \"\",\n \"externalId\": \"MGPx\",\n \"meta\": {\n \"ullamco_3d\": \"voluptate consequat occaecat sit ad\",\n \"labore_e2\": -48650143.129794456,\n \"nulla_eb0\": -77561631.88153748,\n \"adipisicing45b\": \"Lorem in\",\n \"nostrud__\": -4906766,\n \"velitebd\": -39090990.39182089,\n \"ut_6\": \"culpa in\",\n \"seda1\": -16289818.60576953\n },\n \"expires\": \"\",\n \"credits\": null,\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": \"\",\n \"roles\": [\n \"LD-7L2d\",\n \"2nU5BY5aW\"\n ],\n \"permissions\": [\n \"4pN\",\n \"ABQB\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateKey" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-44c5210e-f098-4181-a17e-4c4eacddeb41" }, { "id": "461f0020-2aeb-42f7-9810-07883deab265", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"45Yn1Nw\",\n \"name\": \"\",\n \"externalId\": \"MGPx\",\n \"meta\": {\n \"ullamco_3d\": \"voluptate consequat occaecat sit ad\",\n \"labore_e2\": -48650143.129794456,\n \"nulla_eb0\": -77561631.88153748,\n \"adipisicing45b\": \"Lorem in\",\n \"nostrud__\": -4906766,\n \"velitebd\": -39090990.39182089,\n \"ut_6\": \"culpa in\",\n \"seda1\": -16289818.60576953\n },\n \"expires\": \"\",\n \"credits\": null,\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": \"\",\n \"roles\": [\n \"LD-7L2d\",\n \"2nU5BY5aW\"\n ],\n \"permissions\": [\n \"4pN\",\n \"ABQB\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateKey" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-461f0020-2aeb-42f7-9810-07883deab265" }, { "id": "16e0b8e1-9a1c-4790-88e2-977b95fa9c82", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": \"45Yn1Nw\",\n \"name\": \"\",\n \"externalId\": \"MGPx\",\n \"meta\": {\n \"ullamco_3d\": \"voluptate consequat occaecat sit ad\",\n \"labore_e2\": -48650143.129794456,\n \"nulla_eb0\": -77561631.88153748,\n \"adipisicing45b\": \"Lorem in\",\n \"nostrud__\": -4906766,\n \"velitebd\": -39090990.39182089,\n \"ut_6\": \"culpa in\",\n \"seda1\": -16289818.60576953\n },\n \"expires\": \"\",\n \"credits\": null,\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n },\n {\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": false\n }\n ],\n \"enabled\": \"\",\n \"roles\": [\n \"LD-7L2d\",\n \"2nU5BY5aW\"\n ],\n \"permissions\": [\n \"4pN\",\n \"ABQB\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.updateKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.updateKey" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-16e0b8e1-9a1c-4790-88e2-977b95fa9c82" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-b7512627-6e5e-403e-be9d-4f3ad9332290" } ], "id": "b96d033a-77fa-40b7-8996-4e5338941382", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-b96d033a-77fa-40b7-8996-4e5338941382" }, { "name": "keys.verifyKey", "item": [ { "name": "Verify API Key", "id": "f0228e93-499e-467d-8e23-755364a94f32", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"permissions\": \"\",\n \"credits\": {\n \"cost\": \"\"\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n },\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n }\n ],\n \"migrationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.verifyKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.verifyKey" ] }, "description": "Verify an API key's validity and permissions for request authentication.\n\nUse this endpoint on every incoming request to your protected resources. It checks key validity, permissions, rate limits, and usage quotas in a single call.\n\n**Important**: Returns HTTP 200 for all verification outcomes \u2014 check the `valid` field in response data to determine if the key is authorized. A 429 may be returned if the workspace exceeds its API rate limit.\n\n**Common use cases:**\n- Authenticate API requests before processing\n- Enforce permission-based access control\n- Track usage and apply rate limits\n\n**Required Permissions**\n\nYour root key needs one of:\n- `api.*.verify_key` (verify keys in any API)\n- `api..verify_key` (verify keys in specific API)\n\n**Note**: If your root key has no verify permissions at all, you will receive a `403 Forbidden` error. If your root key has verify permissions for a different API than the key you're verifying, you will receive a `200` response with `code: NOT_FOUND` to avoid leaking key existence.\n" }, "response": [ { "id": "09bc1a61-d53d-432a-8d0c-a526cdd40615", "name": "Key verification process completed. This endpoint always returns HTTP 200 regardless of whether the key passed or failed verification. You must check the `valid` field in the response data to determine the actual verification result.\n\nWhen verification su", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"permissions\": \"\",\n \"credits\": {\n \"cost\": \"\"\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n },\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n }\n ],\n \"migrationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.verifyKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.verifyKey" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": {\n \"valid\": \"\",\n \"code\": \"USAGE_EXCEEDED\",\n \"keyId\": \"\",\n \"name\": \"\",\n \"meta\": {\n \"exercitationb\": -17799512.764566302\n },\n \"expires\": \"\",\n \"credits\": \"\",\n \"enabled\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"\",\n \"\"\n ],\n \"identity\": {\n \"externalId\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"voluptate20b\": false\n },\n \"ratelimits\": [\n {\n \"id\": \"rl_0hkfpY23Csp\",\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": \"\"\n },\n {\n \"id\": \"rl_3rl_3\",\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": \"\"\n }\n ]\n },\n \"ratelimits\": [\n {\n \"id\": \"rl_VMN83\",\n \"exceeded\": \"\",\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"reset\": \"\",\n \"remaining\": \"\",\n \"autoApply\": \"\"\n },\n {\n \"id\": \"rl_WWADeHK9a2u\",\n \"exceeded\": \"\",\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"reset\": \"\",\n \"remaining\": \"\",\n \"autoApply\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-09bc1a61-d53d-432a-8d0c-a526cdd40615" }, { "id": "065fbff0-473d-4666-9d35-e5124ea07ff1", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"permissions\": \"\",\n \"credits\": {\n \"cost\": \"\"\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n },\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n }\n ],\n \"migrationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.verifyKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.verifyKey" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-065fbff0-473d-4666-9d35-e5124ea07ff1" }, { "id": "990ae514-7159-4fb2-a6ac-a3c68b59da36", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"permissions\": \"\",\n \"credits\": {\n \"cost\": \"\"\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n },\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n }\n ],\n \"migrationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.verifyKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.verifyKey" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-990ae514-7159-4fb2-a6ac-a3c68b59da36" }, { "id": "f970c5a5-b70f-43f7-b18d-8e4f9faf3785", "name": "Forbidden. Returned when the root key has no verify permissions at all (neither `api.*.verify_key` nor `api..verify_key` for any API).\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"permissions\": \"\",\n \"credits\": {\n \"cost\": \"\"\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n },\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n }\n ],\n \"migrationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.verifyKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.verifyKey" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-f970c5a5-b70f-43f7-b18d-8e4f9faf3785" }, { "id": "e6cebcfe-433c-47ac-aa3f-92b114743dc2", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"permissions\": \"\",\n \"credits\": {\n \"cost\": \"\"\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n },\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n }\n ],\n \"migrationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.verifyKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.verifyKey" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-e6cebcfe-433c-47ac-aa3f-92b114743dc2" }, { "id": "44e8b140-1d63-4edf-9077-69b74f45da06", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"permissions\": \"\",\n \"credits\": {\n \"cost\": \"\"\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n },\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n }\n ],\n \"migrationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.verifyKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.verifyKey" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-44e8b140-1d63-4edf-9077-69b74f45da06" }, { "id": "7cb3033c-6bab-4c31-8841-17f149e78b16", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"permissions\": \"\",\n \"credits\": {\n \"cost\": \"\"\n },\n \"ratelimits\": [\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n },\n {\n \"name\": \"\",\n \"cost\": 1,\n \"limit\": \"\",\n \"duration\": \"\"\n }\n ],\n \"migrationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.verifyKey", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.verifyKey" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-7cb3033c-6bab-4c31-8841-17f149e78b16" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-f0228e93-499e-467d-8e23-755364a94f32" } ], "id": "75f5de60-20a2-4e32-811b-af5244dff701", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-75f5de60-20a2-4e32-811b-af5244dff701" }, { "name": "keys.whoami", "item": [ { "name": "Get API Key by Hash", "id": "3708bc0d-101a-463a-90c0-2c1e8f06a1ea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.whoami", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.whoami" ] }, "description": "Find out what key this is.\n\n**Required Permissions**\n\nYour root key must have one of the following permissions for basic key information:\n- `api.*.read_key` (to read keys from any API)\n- `api..read_key` (to read keys from a specific API)\n\nIf your rootkey lacks permissions but the key exists, we may return a 404 status here to prevent leaking the existance of a key to unauthorized clients. If you believe that a key should exist, but receive a 404, please double check your root key has the correct permissions.\n" }, "response": [ { "id": "1ad45a49-263d-4679-964e-a88a6747342d", "name": "Successfully retrieved key information.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.whoami", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.whoami" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"data\": {\n \"keyId\": \"8SWccID_Y\",\n \"start\": \"\",\n \"createdAt\": \"\",\n \"enabled\": \"\",\n \"name\": \"\",\n \"meta\": {\n \"exercitation9a\": 86101735,\n \"autefc\": false,\n \"Ut1d\": false,\n \"Excepteur_f\": false,\n \"ea6e2\": -86748389,\n \"dolorec\": \"qui labore consequat aliquip\",\n \"Ut9cf\": 63316408,\n \"nostrude\": true,\n \"elitd1\": -19204744.537709713,\n \"consectetur_a\": 97508271,\n \"do_9\": 84948410,\n \"nisi_8e7\": -74347912,\n \"ea_cd\": true,\n \"culpa_2d\": 14437334,\n \"in_01\": false,\n \"consectetur_4b\": true,\n \"non9\": -87662649,\n \"adipisicing_c60\": 70837440,\n \"pariaturcba\": false,\n \"amet75\": -90655236,\n \"doloree\": 46560214.74128255,\n \"in__\": false,\n \"incididunt_83\": 72026854.02061924,\n \"voluptate_21f\": -92439360,\n \"estb7\": -99460260,\n \"et0\": false,\n \"sit4\": 75481113.44298384,\n \"voluptatef\": -85425017.36619474,\n \"sunt_6\": -85323463,\n \"fugiat81\": 67285067.58594733,\n \"cillumc3\": -96979745,\n \"velit_2\": -88754322.32458782,\n \"exercitation_c12\": -9778876,\n \"veniam_9\": 32684534.714871645,\n \"laboruma\": -41388358.23677782,\n \"sit94\": \"cupidatat culpa\",\n \"cupidatata\": true,\n \"est_84e\": -86024141.13426304,\n \"reprehenderit_1\": -93347278.36182207,\n \"aliqua_454\": true,\n \"non2a\": \"enim dolore anim\",\n \"laborum_80\": \"qui consect\",\n \"aliquip_572\": false,\n \"minim_73\": true,\n \"amet52\": 88458859.56324264,\n \"laboruma5\": 55524170,\n \"eiusmod11a\": -80206862.20291542,\n \"dolor_b\": true,\n \"eta02\": \"fugiat\",\n \"cupidatat_60\": 87749369.20095557,\n \"dolor15f\": -87769904.04662839,\n \"Excepteur4a_\": \"velit quis consectetur eu\",\n \"adipisicing80c\": -86648044.80721906,\n \"sit8\": 19735590,\n \"sint_525\": \"sunt dolore anim pariatur\",\n \"velit_58\": -96913536,\n \"ea_4b0\": \"sunt Lorem eiusmod\",\n \"irure871\": true,\n \"Lorem_d8b\": false,\n \"sit_20\": -30199584,\n \"cillum_621\": \"laborum dolore aute\",\n \"labore_f65\": false,\n \"dolore562\": \"amet nostrud proident laborum\",\n \"cillum23a\": true,\n \"culpa_1\": \"nostrud dolor voluptate officia\",\n \"sed_44f\": true,\n \"id_5e\": false,\n \"ea_38\": 11782565.024960816,\n \"commodo433\": 27575232,\n \"reprehenderite\": -95505081.7339714,\n \"pariatur_d64\": \"dolor eu in nulla\",\n \"consecteture5f\": 56231281.32196644,\n \"magna9f\": false,\n \"quiabb\": \"in nostrud\",\n \"aliqua_e\": 45776659.08265525,\n \"pariatur_32e\": 64341627,\n \"Utec\": 33410526.01136218,\n \"magnac5\": \"laborum dolor Ut\",\n \"Excepteur9\": -14382831.263933718,\n \"et1\": 24058332.49834095,\n \"aute3ad\": \"consequat officia\",\n \"nisi_42\": \"cillum minim est\",\n \"labore_adb\": true,\n \"ida7\": true,\n \"tempore\": true,\n \"fugiat_fc\": true,\n \"non_b\": true,\n \"irure_4f\": \"proiden\",\n \"fugiat_eed\": 20730491,\n \"laboris_c2\": true,\n \"ut1c\": 7014546.34120369,\n \"occaecatac\": -65494071.446687266,\n \"irure_863\": \"aliquip ipsum cillum\",\n \"cupidatat39\": \"non aliqua pariatur\",\n \"nisi_0\": true\n },\n \"updatedAt\": \"\",\n \"lastUsedAt\": \"\",\n \"expires\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"\",\n \"\"\n ],\n \"credits\": {\n \"remaining\": \"\",\n \"refill\": {\n \"interval\": \"monthly\",\n \"amount\": \"\",\n \"refillDay\": \"\"\n }\n },\n \"identity\": {\n \"externalId\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"officia81\": false\n },\n \"ratelimits\": [\n {\n \"id\": \"rl_gtmLk34\",\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": \"\"\n },\n {\n \"id\": \"rl_CB3rl_CB3\",\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": \"\"\n }\n ]\n },\n \"plaintext\": \"\",\n \"ratelimits\": [\n {\n \"id\": \"rl_JdH2MBvj9hG\",\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": \"\"\n },\n {\n \"id\": \"rl_L8rl_L8\",\n \"name\": \"\",\n \"limit\": \"\",\n \"duration\": \"\",\n \"autoApply\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-1ad45a49-263d-4679-964e-a88a6747342d" }, { "id": "7f555f9a-ab55-4400-ae73-3992aeca7e61", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.whoami", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.whoami" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"detail\": \"\",\n \"errors\": [\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n },\n {\n \"location\": \"\",\n \"message\": \"\",\n \"fix\": \"\"\n }\n ],\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-7f555f9a-ab55-4400-ae73-3992aeca7e61" }, { "id": "9fcda2b8-c201-47c2-8d10-3eb601882998", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.whoami", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.whoami" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-9fcda2b8-c201-47c2-8d10-3eb601882998" }, { "id": "d4bb7baf-fda1-4ab8-80e8-2420e9e80af7", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.whoami", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.whoami" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-d4bb7baf-fda1-4ab8-80e8-2420e9e80af7" }, { "id": "684c128c-ce7a-4cb2-bf7b-8e16298dc1f2", "name": "Not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.whoami", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.whoami" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-684c128c-ce7a-4cb2-bf7b-8e16298dc1f2" }, { "id": "0738f345-436e-44a9-a4b7-37b67784ff7b", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.whoami", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.whoami" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-0738f345-436e-44a9-a4b7-37b67784ff7b" }, { "id": "31b82a5c-34fd-473d-b00a-22eaa49642e9", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/keys.whoami", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keys.whoami" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"requestId\": \"\"\n },\n \"error\": {\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"type\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-31b82a5c-34fd-473d-b00a-22eaa49642e9" } ], "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-3708bc0d-101a-463a-90c0-2c1e8f06a1ea" } ], "id": "01442461-ae66-42cf-a144-88599a56e5e0", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-01442461-ae66-42cf-a144-88599a56e5e0" } ], "id": "39669ae8-b715-42b1-bbf4-a6973189d8bc", "createdAt": "2026-07-28T03:23:24.000Z", "updatedAt": "2026-07-28T03:23:24.000Z", "uid": "35240-39669ae8-b715-42b1-bbf4-a6973189d8bc" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.unkey.com" } ] }