API DocsRESTApi key service

CreateApiKey

Creates an API key.

POST
/api/v2/api-keys

Request Body

application/jsonRequired

The request for a call to ApiKeyService.CreateApiKey.

name
Required
string

The name for the new ApiKey. Required.

userId
Required
string

curl -X POST "<API_URL>/api/v2/api-keys" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "userId": "string"
  }'

A successful response.

{
  "apiKey": {
    "apiKeyId": "string",
    "name": "string",
    "key": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "createdByUserId": "string",
    "userId": "string"
  }
}

Previous

UpdateAnnotation PATCH

Next

DeleteApiKey DELETE