Update API Key

PUT

/apikeys/{key_id}

Last modified:2023-12-21 20:51:58

OperationId:UpdateApikey

This is a limited action and will require special access to create API keys. The Update is even more limited only allowing the change of the description and IP restrictions. You will not be able to change the scope, access rights or any premissions. A new apikey would need to be created in those cases.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Example

{
    "description": "my OMP test (updated2)",
    "ip-address": "10.211.55.0/24,127.0.0.1"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/apikeys/nss_gPGEUWBI' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "my OMP test (updated2)",
    "ip-address": "10.211.55.0/24,127.0.0.1"
}'

Responses

🟢202Accepted

application/json

Body

Example

{
    "code": 0,
    "message": "string"
}

🟠403Forbidden

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required

Modified at 2023-12-21 20:51:58

Create API Key

Revoke API Key