Create API Key

POST

/apikeys

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

OperationId:CreateApikey

This is a limited action and will require special access to create API keys.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Example

{
    "description": "Myomp ApiKey 2",
    "domain": "apidog.ApiReseller",
    "reseller": "ApiReseller",
    "readonly": "no",
    "ip-address": "10.211.55.0/24,127.0.0.1",
    "user-scope": "Office Manager",
    "can-create-keys": "no" 
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://awqacore01.crexendocloud.com/ns-api/v2/apikeys' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "Myomp ApiKey 2",
    "domain": "apidog.ApiReseller",
    "reseller": "ApiReseller",
    "readonly": "no",
    "ip-address": "10.211.55.0/24,127.0.0.1",
    "user-scope": "Office Manager",
    "can-create-keys": "no" 
}'

Responses

🟢200OK

application/json

Body

Example

{
    "notes": "This key needs to be kept secure and secret and will not be shown again so please note it down now!",
    "key": "nsd_UKkxfEzvJnM9DkGZ0RoXs8qn3wkOuKsALxKhUcYFrwTUtxNg64676181",
    "description": "Myomp ApiKey 2",
    "domain": "apidog.ApiReseller",
    "readonly": "no",
    "key-id": "nsd_UKkxfEzv",
    "reseller": "ApiReseller",
    "can-create-keys": "no",
    "ip-address": "10.211.55.0/24,127.0.0.1",
    "user-scope": "Office Manager",
    "created-datetime": "2023-08-11T04:29:33+00:00"
}

🟠403Forbidden

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

Read Info on specific APIKey via Key ID

Update API Key