--- title: "Issue an API key" description: "Creates an audited key for the calling administrator. The raw token and prefix are returned once in this response and are never included in later reads.\n\n### Quire permissions\n\nRequired capability: `api/manage_keys`.\n\nCredential scopes: `integrations:write`.\n\nThe acting subject must also be allowed to perform this action in the organisation." image: "https://docs.quirelms.com/og.png" --- > Documentation Index > Fetch the complete documentation index at: https://docs.quirelms.com/llms.txt > Use this file to discover all available pages before exploring further. Path: Quire API › integrations `POST /api_keys` Creates an audited key for the calling administrator. The raw token and prefix are returned once in this response and are never included in later reads. \### Quire permissions Required capability: `api/manage_keys`. Credential scopes: `integrations:write`. The acting subject must also be allowed to perform this action in the organisation. ## Authentication Requires one of the following: - `apiKey`, http, header `Authorization`, scopes: `integrations:write` - `oauth2`, oauth2, scopes: `integrations:write` ## Header parameters - `createApiKey.header.Quire-Version` (string, optional) — The dated API revision to serve this request at. Omitted, the request is served at the revision the credential was issued against. The response echoes the revision actually applied. - format `date` - `createApiKey.header.Idempotency-Key` (string, optional) — A caller-chosen key making this request safe to retry. A replay of a completed request returns the recorded response with `Idempotency-Replayed: true`. Reusing a key for a different request is refused. - maxLength 255 ## Request body _Required._ - `createApiKey.name` (string, required) - minLength 1; maxLength 200 - `createApiKey.scopes` (array, required) - minLength 1; maxLength 100 - `createApiKey.mode` (string, required) - one of `"live"`, `"test"` - `createApiKey.expires_at` (any of, optional) - any of: `string`, `null` - `createApiKey.ip_allowlist` (array, optional) - minLength 1; maxLength 100 ## Example request ```json { "name": "string", "scopes": [ "string" ], "mode": "live", "expires_at": "2019-08-24T14:15:22Z", "ip_allowlist": [ "string" ] } ``` ## Code samples ### cURL ```curl curl --request POST \ --url https://your-organisation.quirelms.com/api/v1/api_keys \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "name": "string", "scopes": [ "string" ], "mode": "live", "expires_at": "2019-08-24T14:15:22Z", "ip_allowlist": [ "string" ] } ' ``` ### TypeScript ```typescript const url = 'https://your-organisation.quirelms.com/api/v1/api_keys'; const options = { method: 'POST', headers: {'Content-Type': 'application/json', Authorization: 'Bearer '}, body: JSON.stringify({ name: 'string', scopes: ['string'], mode: 'live', expires_at: '2019-08-24T14:15:22Z', ip_allowlist: ['string'] }) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err)); ``` ### Python ```python import requests url = "https://your-organisation.quirelms.com/api/v1/api_keys" payload = { "name": "string", "scopes": ["string"], "mode": "live", "expires_at": "2019-08-24T14:15:22Z", "ip_allowlist": ["string"] } headers = { "Content-Type": "application/json", "Authorization": "Bearer " } response = requests.post(url, json=payload, headers=headers) print(response.text) ``` ## Responses ### 201 Success. #### Example ```json { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "scopes": [ "string" ], "expires_at": "2019-08-24T14:15:22Z", "last_used_at": "2019-08-24T14:15:22Z", "revoked_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "prefix": "string", "token": "string" } ``` - `createApiKey.response.201.id` (string, required) - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$` - `createApiKey.response.201.name` (string, required) - `createApiKey.response.201.scopes` (array, required) - `createApiKey.response.201.expires_at` (any of, required) - any of: `string`, `null` - `createApiKey.response.201.last_used_at` (any of, required) - any of: `string`, `null` - `createApiKey.response.201.revoked_at` (any of, required) - any of: `string`, `null` - `createApiKey.response.201.created_at` (string, required) - format `date-time`; pattern `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$` - `createApiKey.response.201.prefix` (string, required) - `createApiKey.response.201.token` (string, required) ### 401 The credential is missing, malformed, expired or revoked. #### Example ```json { "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" } ``` - `createApiKey.response.401.type` (string, required) - format `uri` - `createApiKey.response.401.title` (string, required) - `createApiKey.response.401.status` (integer, required) - `createApiKey.response.401.code` (string, required) - `createApiKey.response.401.category` (string, required) - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"` - `createApiKey.response.401.detail` (string, required) - `createApiKey.response.401.request_id` (string, required) - `createApiKey.response.401.docs_url` (string, required) - format `uri` - `createApiKey.response.401.errors` (array, optional) - `createApiKey.response.401.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body. - `createApiKey.response.401.errors.code` (string, required) - `createApiKey.response.401.errors.detail` (string, required) - `createApiKey.response.401.retry_after` (integer | null, optional) ### 403 The credential lacks the scope this operation requires, or the acting subject lacks the capability. #### Example ```json { "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" } ``` - `createApiKey.response.403.type` (string, required) - format `uri` - `createApiKey.response.403.title` (string, required) - `createApiKey.response.403.status` (integer, required) - `createApiKey.response.403.code` (string, required) - `createApiKey.response.403.category` (string, required) - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"` - `createApiKey.response.403.detail` (string, required) - `createApiKey.response.403.request_id` (string, required) - `createApiKey.response.403.docs_url` (string, required) - format `uri` - `createApiKey.response.403.errors` (array, optional) - `createApiKey.response.403.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body. - `createApiKey.response.403.errors.code` (string, required) - `createApiKey.response.403.errors.detail` (string, required) - `createApiKey.response.403.retry_after` (integer | null, optional) ### 409 The request conflicts with the current state, with a previous use of the same idempotency key, or with a concurrent write. #### Example ```json { "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" } ``` - `createApiKey.response.409.type` (string, required) - format `uri` - `createApiKey.response.409.title` (string, required) - `createApiKey.response.409.status` (integer, required) - `createApiKey.response.409.code` (string, required) - `createApiKey.response.409.category` (string, required) - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"` - `createApiKey.response.409.detail` (string, required) - `createApiKey.response.409.request_id` (string, required) - `createApiKey.response.409.docs_url` (string, required) - format `uri` - `createApiKey.response.409.errors` (array, optional) - `createApiKey.response.409.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body. - `createApiKey.response.409.errors.code` (string, required) - `createApiKey.response.409.errors.detail` (string, required) - `createApiKey.response.409.retry_after` (integer | null, optional) ### 422 The request was understood and its content is not valid. `errors` names each field. #### Example ```json { "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" } ``` - `createApiKey.response.422.type` (string, required) - format `uri` - `createApiKey.response.422.title` (string, required) - `createApiKey.response.422.status` (integer, required) - `createApiKey.response.422.code` (string, required) - `createApiKey.response.422.category` (string, required) - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"` - `createApiKey.response.422.detail` (string, required) - `createApiKey.response.422.request_id` (string, required) - `createApiKey.response.422.docs_url` (string, required) - format `uri` - `createApiKey.response.422.errors` (array, optional) - `createApiKey.response.422.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body. - `createApiKey.response.422.errors.code` (string, required) - `createApiKey.response.422.errors.detail` (string, required) - `createApiKey.response.422.retry_after` (integer | null, optional) ### 429 A rate limit or a concurrency cap was reached. `Retry-After` says when to try again. #### Example ```json { "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" } ``` - `createApiKey.response.429.type` (string, required) - format `uri` - `createApiKey.response.429.title` (string, required) - `createApiKey.response.429.status` (integer, required) - `createApiKey.response.429.code` (string, required) - `createApiKey.response.429.category` (string, required) - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"` - `createApiKey.response.429.detail` (string, required) - `createApiKey.response.429.request_id` (string, required) - `createApiKey.response.429.docs_url` (string, required) - format `uri` - `createApiKey.response.429.errors` (array, optional) - `createApiKey.response.429.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body. - `createApiKey.response.429.errors.code` (string, required) - `createApiKey.response.429.errors.detail` (string, required) - `createApiKey.response.429.retry_after` (integer | null, optional) ### 500 Something failed at our end. Quote `request_id` when reporting it. #### Example ```json { "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" } ``` - `createApiKey.response.500.type` (string, required) - format `uri` - `createApiKey.response.500.title` (string, required) - `createApiKey.response.500.status` (integer, required) - `createApiKey.response.500.code` (string, required) - `createApiKey.response.500.category` (string, required) - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"` - `createApiKey.response.500.detail` (string, required) - `createApiKey.response.500.request_id` (string, required) - `createApiKey.response.500.docs_url` (string, required) - format `uri` - `createApiKey.response.500.errors` (array, optional) - `createApiKey.response.500.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body. - `createApiKey.response.500.errors.code` (string, required) - `createApiKey.response.500.errors.detail` (string, required) - `createApiKey.response.500.retry_after` (integer | null, optional) Source: https://docs.quirelms.com/api/integrations/createApiKey/index.md