API Keys
All PUT endpoints update only the fields present in the body; see Updating Resources.
GET/v1/api-keysGET /v1/api-keys
Code samples
cURL
# You can also use wget
curl -X GET /v1/api-keys \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
GET /v1/api-keys
Gets the API keys based on the provided request.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| select | query | string | false | none |
| filter | query | string | false | none |
| include | query | string | false | none |
| sort | query | string | false | none |
| take | query | integer(int32) | false | none |
| skip | query | integer(int32) | false | none |
Example responses
200 Response
{"success":true,"code":0,"message":"string","apiKeys":[{"id":0,"name":"string","key":"string","clientSecret":"string","createdDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","ownerId":"string","revoked":true,"permissions":0,"description":"string"}],"totalApiKeysCount":0}{
"success": true,
"code": 0,
"message": "string",
"apiKeys": [
{
"id": 0,
"name": "string",
"key": "string",
"clientSecret": "string",
"createdDate": "2019-08-24T14:15:22Z",
"expireDate": "2019-08-24T14:15:22Z",
"ownerId": "string",
"revoked": true,
"permissions": 0,
"description": "string"
}
],
"totalApiKeysCount": 0
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.GetApiKeysResponse |
Authentication: API key (x-api-key).
POST/v1/api-keysPOST /v1/api-keys
Code samples
cURL
# You can also use wget
curl -X POST /v1/api-keys \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
POST /v1/api-keys
Inserts a new API key.
Body parameter
{
"apiKey": {
"id": 0,
"name": "string",
"key": "string",
"clientSecret": "string",
"createdDate": "2019-08-24T14:15:22Z",
"expireDate": "2019-08-24T14:15:22Z",
"ownerId": "string",
"revoked": true,
"permissions": 0,
"description": "string"
}
}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Management.InsertApiKeyRequest | false | The request containing the API key to insert. |
Example responses
200 Response
{"apiKeyId":0,"success":true,"code":0,"message":"string","apiKey":"string"}{
"apiKeyId": 0,
"success": true,
"code": 0,
"message": "string",
"apiKey": "string"
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.InsertApiKeyResponse |
Authentication: API key (x-api-key).
PUT/v1/api-keysPUT /v1/api-keys
Code samples
cURL
# You can also use wget
curl -X PUT /v1/api-keys \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
PUT /v1/api-keys
Updates the API key with the specified ID.
Body parameter
{
"apiKey": {
"id": 0,
"name": "string",
"key": "string",
"clientSecret": "string",
"createdDate": "2019-08-24T14:15:22Z",
"expireDate": "2019-08-24T14:15:22Z",
"ownerId": "string",
"revoked": true,
"permissions": 0,
"description": "string"
}
}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Management.UpdateApiKeyRequest | false | The request containing the API key to update. |
Example responses
200 Response
{"success":true,"code":0,"message":"string"}{
"success": true,
"code": 0,
"message": "string"
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.UpdateApiKeyResponse |
Authentication: API key (x-api-key).
DELETE/v1/api-keys/{apiKeyId}DELETE /v1/api-keys/{apiKeyId}
Code samples
cURL
# You can also use wget
curl -X DELETE /v1/api-keys/{apiKeyId} \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
DELETE /v1/api-keys/\{apiKeyId\}
Deletes the API key with the specified ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| apiKeyId | path | integer(int32) | true | The ID of the API key to delete. |
Example responses
200 Response
{"success":true,"code":0,"message":"string"}{
"success": true,
"code": 0,
"message": "string"
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.DeleteApiKeyResponse |
Authentication: API key (x-api-key).
Last updated on