API Reference

Create API Key

post
https://{server}/ns-api/v2/apikeys

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 12

This is the main description/name for the API key that should describe its purpose for tracking and understanding its intended use.

string
required
Defaults to *

This is the reseller that will limit the API key to access the resellers data set.

string

This is the main user extension for the user account.

string
required
length ≤ 64

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

string
enum

This is the scope that will be be used to enforce permissions for this API key and access.

string

Optional IP restrictions for API to require access from matching IP or subnets. Multipe ips/subnets can be provided comma seperated

string
enum
Defaults to no

If enabled it will limit any get Scope to a read only verion providing only GET acces to the read actions. POST, PUT and DELETE will be rejected.

Allowed:
string
enum
Defaults to no

If enabled it will allow this key to make keys for lesser scopes then itself. It will not allow creations of scopes same or higher access level.

Allowed:

This is an optional limitation to the ability of this apikey. The default is * or all models, but can be set to a specific model or array of models allowing specific access. The "models" are linked to objects as defined in the scope definition and might have varies terminolofy from the api itself.

A string with a specific model or "*" for all.

Responses

Updated 8 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago