--- updatedAt: 2025-09-09T23:55:56.000Z agentTools: projectIndex: https://docs.ns-api.com/llms.txt --- # Create API Key This is a limited action and will require special access to create API keys. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "NetSapiens API v2", "description": "", "version": "1.0.0" }, "tags": [ { "name": "Authentication/API Key (Machine 2 Machine)" } ], "paths": { "/apikeys": { "post": { "summary": "Create API Key", "deprecated": false, "description": "This is a limited action and will require special access to create API keys. ", "operationId": "CreateApikey", "tags": [ "Authentication/API Key (Machine 2 Machine)" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "x-apidog-refs": { "01H634DGKM7VCSYN604FJT4TS4": { "$ref": "#/components/schemas/ApiKey" } }, "x-apidog-orders": [ "01H634DGKM7VCSYN604FJT4TS4" ], "properties": { "description": { "type": "string", "minLength": 12, "examples": [ "Used by Vendor Xyz for Billing Automation" ], "description": "This is the main description/name for the API key that should describe its purpose for tracking and understanding its intended use. " }, "reseller": { "type": "string", "default": "*", "description": "This is the reseller that will limit the API key to access the resellers data set. " }, "user": { "$ref": "#/components/schemas/UserName" }, "domain": { "$ref": "#/components/schemas/DomainName" }, "user-scope": { "type": "string", "description": "This is the scope that will be be used to enforce permissions for this API key and access. ", "enum": [ "Basic User", "Simple User", "Advanced User", "Call Center Agent", "Call Center Supervisor", "Office Manager", "Reseller", "Super User", "NDP" ], "x-apidog": { "enumDescriptions": { "Basic User": "", "Simple User": "", "Advanced User": "", "Call Center Agent": "", "Call Center Supervisor": "", "Office Manager": "", "Reseller": "", "Super User": "", "NDP": "" } } }, "ip-address": { "type": "string", "examples": [ "1.2.3.4,5.6.7.0/24" ], "description": "Optional IP restrictions for API to require access from matching IP or subnets. Multipe ips/subnets can be provided comma seperated" }, "readonly": { "type": "string", "enum": [ "yes", "no" ], "x-apidog": { "enumDescriptions": { "yes": "", "no": "" } }, "default": "no", "description": "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. " }, "can-create-keys": { "type": "string", "enum": [ "yes", "no" ], "x-apidog": { "enumDescriptions": { "yes": "", "no": "" } }, "default": "no", "description": "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-models": { "anyOf": [ { "type": "string", "description": "A string with a specific model or \"*\" for all. " }, { "type": "array", "items": { "type": "string", "description": "A string with a specific model or \"*\" for all. The specific models reference the API's scope defintions stored in the DB. ", "enum": [ "agentlog", "account", "address", "agent", "answerrule", "apikey", "attendant", "attendee", "audio", "call", "callidemgr", "callqueue", "callqueuereport", "callrequest", "cdr", "cdr2", "cdrschedule", "chart", "conference", "conferencecdr", "contact", "conversation", "dashboard", "department", "device", "deviceprofile", "dialrule", "disposition", "domain", "email", "event", "fax", "mac", "meeting", "message", "messagesession", "mfa", "moh", "participant", "phaxio", "phoneconfiguration", "phonenumber", "presence", "push", "recording", "sfu", "site", "smsnumber", "speechcommand", "sso", "statistics", "subscriber", "subscriberani", "timeframe", "timerange", "turn", "uiconfig", "upload", "vmailnag", "voice", "voicemail", "queued", "callqueueemailreport", "callqueuestat", "cdrexport", "connection", "devicedefault", "dialplan", "dialpolicy", "licf_lea", "oauth", "permission", "quota", "quotaUsage", "recordingstorage", "trace", "auditlog", "auditlog_lite", "elementdomain", "*" ], "x-apidog": { "enumDescriptions": { "agentlog": "", "account": "", "address": "", "agent": "", "answerrule": "", "apikey": "", "attendant": "", "attendee": "", "audio": "", "call": "", "callidemgr": "", "callqueue": "", "callqueuereport": "", "callrequest": "", "cdr": "", "cdr2": "", "cdrschedule": "", "chart": "", "conference": "", "conferencecdr": "", "contact": "", "conversation": "", "dashboard": "", "department": "", "device": "", "deviceprofile": "", "dialrule": "", "disposition": "", "domain": "", "email": "", "event": "", "fax": "", "mac": "", "meeting": "", "message": "", "messagesession": "", "mfa": "", "moh": "", "participant": "", "phaxio": "", "phoneconfiguration": "", "phonenumber": "", "presence": "", "push": "", "recording": "", "sfu": "", "site": "", "smsnumber": "", "speechcommand": "", "sso": "", "statistics": "", "subscriber": "", "subscriberani": "", "timeframe": "", "timerange": "", "turn": "", "uiconfig": "", "upload": "", "vmailnag": "", "voice": "", "voicemail": "", "queued": "", "callqueueemailreport": "", "callqueuestat": "", "cdrexport": "", "connection": "", "devicedefault": "", "dialplan": "", "dialpolicy": "", "licf_lea": "", "oauth": "", "permission": "", "quota": "", "quotaUsage": "", "recordingstorage": "", "trace": "", "auditlog": "", "auditlog_lite": "", "elementdomain": "", "*": "" } } }, "description": "An array of models. " } ], "description": "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. " }, "created-datetime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that the key was created. " }, "lastused-datetime": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true, "description": "The datetime of the last time the apikey was used for API access. The timestamp is acurrate up to the hour to avoid overhead in tracking high volume requests" } }, "required": [ "description", "reseller", "domain" ], "x-apidog-ignore-properties": [ "description", "reseller", "user", "domain", "user-scope", "ip-address", "readonly", "can-create-keys", "allowed-models", "created-datetime", "lastused-datetime" ] }, "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" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "x-apidog-refs": { "01H645TF0RNTE9FVP0R19697F5": { "$ref": "#/components/schemas/ApiKey" } }, "x-apidog-orders": [ "01H645TF0RNTE9FVP0R19697F5" ], "properties": { "description": { "type": "string", "minLength": 12, "examples": [ "Used by Vendor Xyz for Billing Automation" ], "description": "This is the main description/name for the API key that should describe its purpose for tracking and understanding its intended use. " }, "key-id": { "type": "string", "minLength": 12, "maxLength": 12, "examples": [ "nsd-123dsa23" ], "description": "This is the Key ID that will identify the key and allow for managment, audit tracking and monitoring. " }, "key": { "type": "string", "readOnly": true, "description": "This is the key that will need to be saved securly for use in accessing the API. It will only be shown once. " }, "reseller": { "type": "string", "default": "*", "description": "This is the reseller that will limit the API key to access the resellers data set. " }, "user": { "$ref": "#/components/schemas/UserName" }, "domain": { "$ref": "#/components/schemas/DomainName" }, "user-scope": { "type": "string", "description": "This is the scope that will be be used to enforce permissions for this API key and access. ", "enum": [ "Basic User", "Simple User", "Advanced User", "Call Center Agent", "Call Center Supervisor", "Office Manager", "Reseller", "Super User", "NDP" ], "x-apidog": { "enumDescriptions": { "Basic User": "", "Simple User": "", "Advanced User": "", "Call Center Agent": "", "Call Center Supervisor": "", "Office Manager": "", "Reseller": "", "Super User": "", "NDP": "" } } }, "ip-address": { "type": "string", "examples": [ "1.2.3.4,5.6.7.0/24" ], "description": "Optional IP restrictions for API to require access from matching IP or subnets. Multipe ips/subnets can be provided comma seperated" }, "readonly": { "type": "string", "enum": [ "yes", "no" ], "x-apidog": { "enumDescriptions": { "yes": "", "no": "" } }, "default": "no", "description": "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. " }, "can-create-keys": { "type": "string", "enum": [ "yes", "no" ], "x-apidog": { "enumDescriptions": { "yes": "", "no": "" } }, "default": "no", "description": "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-models": { "anyOf": [ { "type": "string", "description": "A string with a specific model or \"*\" for all. " }, { "type": "array", "items": { "type": "string", "description": "A string with a specific model or \"*\" for all. The specific models reference the API's scope defintions stored in the DB. ", "enum": [ "agentlog", "account", "address", "agent", "answerrule", "apikey", "attendant", "attendee", "audio", "call", "callidemgr", "callqueue", "callqueuereport", "callrequest", "cdr", "cdr2", "cdrschedule", "chart", "conference", "conferencecdr", "contact", "conversation", "dashboard", "department", "device", "deviceprofile", "dialrule", "disposition", "domain", "email", "event", "fax", "mac", "meeting", "message", "messagesession", "mfa", "moh", "participant", "phaxio", "phoneconfiguration", "phonenumber", "presence", "push", "recording", "sfu", "site", "smsnumber", "speechcommand", "sso", "statistics", "subscriber", "subscriberani", "timeframe", "timerange", "turn", "uiconfig", "upload", "vmailnag", "voice", "voicemail", "queued", "callqueueemailreport", "callqueuestat", "cdrexport", "connection", "devicedefault", "dialplan", "dialpolicy", "licf_lea", "oauth", "permission", "quota", "quotaUsage", "recordingstorage", "trace", "auditlog", "auditlog_lite", "elementdomain", "*" ], "x-apidog": { "enumDescriptions": { "agentlog": "", "account": "", "address": "", "agent": "", "answerrule": "", "apikey": "", "attendant": "", "attendee": "", "audio": "", "call": "", "callidemgr": "", "callqueue": "", "callqueuereport": "", "callrequest": "", "cdr": "", "cdr2": "", "cdrschedule": "", "chart": "", "conference": "", "conferencecdr": "", "contact": "", "conversation": "", "dashboard": "", "department": "", "device": "", "deviceprofile": "", "dialrule": "", "disposition": "", "domain": "", "email": "", "event": "", "fax": "", "mac": "", "meeting": "", "message": "", "messagesession": "", "mfa": "", "moh": "", "participant": "", "phaxio": "", "phoneconfiguration": "", "phonenumber": "", "presence": "", "push": "", "recording": "", "sfu": "", "site": "", "smsnumber": "", "speechcommand": "", "sso": "", "statistics": "", "subscriber": "", "subscriberani": "", "timeframe": "", "timerange": "", "turn": "", "uiconfig": "", "upload": "", "vmailnag": "", "voice": "", "voicemail": "", "queued": "", "callqueueemailreport": "", "callqueuestat": "", "cdrexport": "", "connection": "", "devicedefault": "", "dialplan": "", "dialpolicy": "", "licf_lea": "", "oauth": "", "permission": "", "quota": "", "quotaUsage": "", "recordingstorage": "", "trace": "", "auditlog": "", "auditlog_lite": "", "elementdomain": "", "*": "" } } }, "description": "An array of models. " } ], "description": "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. " }, "created-datetime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that the key was created. " }, "lastused-datetime": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true, "description": "The datetime of the last time the apikey was used for API access. The timestamp is acurrate up to the hour to avoid overhead in tracking high volume requests" } }, "required": [ "description", "key-id", "reseller", "domain" ], "x-apidog-ignore-properties": [ "description", "key-id", "key", "reseller", "user", "domain", "user-scope", "ip-address", "readonly", "can-create-keys", "allowed-models", "created-datetime", "lastused-datetime" ] }, "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" } } }, "headers": {}, "x-apidog-name": "OK" }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": 403, "message": "API key creation only allowed using an API key with permission to create new API keys" } } }, "headers": {}, "x-apidog-name": "Forbidden" } }, "security": [ { "bearer": [] } ], "x-apidog-folder": "Authentication/API Key (Machine 2 Machine)", "x-apidog-status": "released", "x-run-in-apidog": "https://apidog.com/web/project/374090/apis/api-4683858-run" } } }, "components": { "schemas": { "ApiKey": { "type": "object", "properties": { "description": { "type": "string", "minLength": 12, "examples": [ "Used by Vendor Xyz for Billing Automation" ], "description": "This is the main description/name for the API key that should describe its purpose for tracking and understanding its intended use. " }, "key-id": { "type": "string", "minLength": 12, "maxLength": 12, "examples": [ "nsd-123dsa23" ], "description": "This is the Key ID that will identify the key and allow for managment, audit tracking and monitoring. " }, "key": { "type": "string", "readOnly": true, "description": "This is the key that will need to be saved securly for use in accessing the API. It will only be shown once. " }, "reseller": { "type": "string", "default": "*", "description": "This is the reseller that will limit the API key to access the resellers data set. " }, "user": { "$ref": "#/components/schemas/UserName" }, "domain": { "$ref": "#/components/schemas/DomainName" }, "user-scope": { "type": "string", "description": "This is the scope that will be be used to enforce permissions for this API key and access. ", "enum": [ "Basic User", "Simple User", "Advanced User", "Call Center Agent", "Call Center Supervisor", "Office Manager", "Reseller", "Super User", "NDP" ], "x-apidog": { "enumDescriptions": { "Basic User": "", "Simple User": "", "Advanced User": "", "Call Center Agent": "", "Call Center Supervisor": "", "Office Manager": "", "Reseller": "", "Super User": "", "NDP": "" } } }, "ip-address": { "type": "string", "examples": [ "1.2.3.4,5.6.7.0/24" ], "description": "Optional IP restrictions for API to require access from matching IP or subnets. Multipe ips/subnets can be provided comma seperated" }, "readonly": { "type": "string", "enum": [ "yes", "no" ], "x-apidog": { "enumDescriptions": { "yes": "", "no": "" } }, "default": "no", "description": "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. " }, "can-create-keys": { "type": "string", "enum": [ "yes", "no" ], "x-apidog": { "enumDescriptions": { "yes": "", "no": "" } }, "default": "no", "description": "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-models": { "anyOf": [ { "type": "string", "description": "A string with a specific model or \"*\" for all. " }, { "type": "array", "items": { "type": "string", "description": "A string with a specific model or \"*\" for all. The specific models reference the API's scope defintions stored in the DB. ", "enum": [ "agentlog", "account", "address", "agent", "answerrule", "apikey", "attendant", "attendee", "audio", "call", "callidemgr", "callqueue", "callqueuereport", "callrequest", "cdr", "cdr2", "cdrschedule", "chart", "conference", "conferencecdr", "contact", "conversation", "dashboard", "department", "device", "deviceprofile", "dialrule", "disposition", "domain", "email", "event", "fax", "mac", "meeting", "message", "messagesession", "mfa", "moh", "participant", "phaxio", "phoneconfiguration", "phonenumber", "presence", "push", "recording", "sfu", "site", "smsnumber", "speechcommand", "sso", "statistics", "subscriber", "subscriberani", "timeframe", "timerange", "turn", "uiconfig", "upload", "vmailnag", "voice", "voicemail", "queued", "callqueueemailreport", "callqueuestat", "cdrexport", "connection", "devicedefault", "dialplan", "dialpolicy", "licf_lea", "oauth", "permission", "quota", "quotaUsage", "recordingstorage", "trace", "auditlog", "auditlog_lite", "elementdomain", "*" ], "x-apidog": { "enumDescriptions": { "agentlog": "", "account": "", "address": "", "agent": "", "answerrule": "", "apikey": "", "attendant": "", "attendee": "", "audio": "", "call": "", "callidemgr": "", "callqueue": "", "callqueuereport": "", "callrequest": "", "cdr": "", "cdr2": "", "cdrschedule": "", "chart": "", "conference": "", "conferencecdr": "", "contact": "", "conversation": "", "dashboard": "", "department": "", "device": "", "deviceprofile": "", "dialrule": "", "disposition": "", "domain": "", "email": "", "event": "", "fax": "", "mac": "", "meeting": "", "message": "", "messagesession": "", "mfa": "", "moh": "", "participant": "", "phaxio": "", "phoneconfiguration": "", "phonenumber": "", "presence": "", "push": "", "recording": "", "sfu": "", "site": "", "smsnumber": "", "speechcommand": "", "sso": "", "statistics": "", "subscriber": "", "subscriberani": "", "timeframe": "", "timerange": "", "turn": "", "uiconfig": "", "upload": "", "vmailnag": "", "voice": "", "voicemail": "", "queued": "", "callqueueemailreport": "", "callqueuestat": "", "cdrexport": "", "connection": "", "devicedefault": "", "dialplan": "", "dialpolicy": "", "licf_lea": "", "oauth": "", "permission": "", "quota": "", "quotaUsage": "", "recordingstorage": "", "trace": "", "auditlog": "", "auditlog_lite": "", "elementdomain": "", "*": "" } } }, "description": "An array of models. " } ], "description": "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. " }, "created-datetime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that the key was created. " }, "lastused-datetime": { "type": [ "string", "null" ], "format": "date-time", "readOnly": true, "description": "The datetime of the last time the apikey was used for API access. The timestamp is acurrate up to the hour to avoid overhead in tracking high volume requests" } }, "required": [ "description", "key-id", "reseller", "domain" ], "x-apidog-orders": [ "description", "key-id", "key", "reseller", "user", "domain", "user-scope", "ip-address", "readonly", "can-create-keys", "allowed-models", "created-datetime", "lastused-datetime" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "Schemas" }, "DomainName": { "type": "string", "description": "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 (\\*). ", "pattern": "^[A-Za-z0-9._-]+|\\*", "maxLength": 64, "examples": [ "example.com" ], "x-apidog-folder": "Enums" }, "UserName": { "type": "string", "examples": [ "1000", "200" ], "description": "This is the main user extension for the user account. ", "x-apidog-folder": "Enums" }, "ErrorResponse": { "type": "object", "properties": { "code": { "type": "integer", "description": "This is the HTTP error code that was returned." }, "message": { "type": "string", "description": "This is a more detailed description of what the error was and any potential correction steps. " } }, "x-apidog-orders": [ "code", "message" ], "required": [ "code", "message" ], "x-apidog-ignore-properties": [], "x-apidog-folder": "Enums" } }, "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer" }, "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "servers": [ { "url": "https://{server}/ns-api/v2", "description": "Dynamic Environment", "variables": { "server": { "default": "ns-api.com" } } } ], "security": [ { "bearerAuth": [] } ] } ```