{ "id": "@itentialopensource/adapter-nokia_vitalqip", "type": "Adapter", "export": "NokiaVitalqip", "title": "Nokia_vitalqip", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name" : "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type" : "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } }, { "name": "persistFlag", "type": "boolean", "info": "Whether the input properties should be saved", "required": true, "schema": { "title": "persistFlag", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the IAP database", "description": "Moves entities from an adapter into the IAP database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "getV4Network", "summary": "getV4Network", "description": "Get V4 network by name or address", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "V4NetworkRec", "type": "object", "properties": { "address": { "type": "string", "description": "V4 Network address", "xml": { "name": "address", "attribute": false, "wrapped": false } }, "maskLength": { "type": "integer", "description": "Mask length of v4 network", "xml": { "name": "maskLength", "attribute": false, "wrapped": false } }, "email": { "type": "string", "description": "email to contact", "xml": { "name": "email", "attribute": false, "wrapped": false } }, "warningPercent": { "type": "integer", "description": "Warning percent", "xml": { "name": "warningPercent", "attribute": false, "wrapped": false } }, "warningType": { "type": "string", "description": "warnning type (1 or 2 or 3)", "xml": { "name": "warningType", "attribute": false, "wrapped": false } }, "name": { "type": "string", "description": "Network name", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "dnsServer": { "type": "string", "description": "Name of DNS Server", "xml": { "name": "dnsServer", "attribute": false, "wrapped": false } }, "cidr": { "type": "string", "description": "CIDR (Y or N)", "xml": { "name": "cidr", "attribute": false, "wrapped": false } }, "optionalAttributeList": { "title": "UdaList", "type": "object", "properties": { "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } }, "groups": { "type": "array", "items": { "title": "UdaGroup", "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "optionalAddrRangeList": { "title": "AddrRangeList", "type": "object", "properties": { "addrRange": { "type": "array", "items": { "title": "AddrRange", "type": "object", "properties": { "startAddress": { "type": "string", "xml": { "name": "startAddress", "attribute": false, "wrapped": false } }, "endAddress": { "type": "string", "xml": { "name": "endAddress", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } } }, "description": "V4 Network model", "xml": { "name": "V4NetworkRec", "attribute": false, "wrapped": false } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getV4Network" }, "task": true }, { "name": "deleteV4Network", "summary": "deleteV4Network", "description": "Delete V4 network by name or address", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteV4Network" }, "task": true }, { "name": "addV4Network", "summary": "addV4Network", "description": "Create a new V4 network", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/addV4Network" }, "task": true }, { "name": "searchV4Network", "summary": "searchV4Network", "description": "Search V4 network by name or address.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "title": "V4NetworkRec", "type": "object", "properties": { "address": { "type": "string", "description": "V4 Network address", "xml": { "name": "address", "attribute": false, "wrapped": false } }, "maskLength": { "type": "integer", "description": "Mask length of v4 network", "xml": { "name": "maskLength", "attribute": false, "wrapped": false } }, "email": { "type": "string", "description": "email to contact", "xml": { "name": "email", "attribute": false, "wrapped": false } }, "warningPercent": { "type": "integer", "description": "Warning percent", "xml": { "name": "warningPercent", "attribute": false, "wrapped": false } }, "warningType": { "type": "string", "description": "warnning type (1 or 2 or 3)", "xml": { "name": "warningType", "attribute": false, "wrapped": false } }, "name": { "type": "string", "description": "Network name", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "dnsServer": { "type": "string", "description": "Name of DNS Server", "xml": { "name": "dnsServer", "attribute": false, "wrapped": false } }, "cidr": { "type": "string", "description": "CIDR (Y or N)", "xml": { "name": "cidr", "attribute": false, "wrapped": false } }, "optionalAttributeList": { "title": "UdaList", "type": "object", "properties": { "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } }, "groups": { "type": "array", "items": { "title": "UdaGroup", "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "optionalAddrRangeList": { "title": "AddrRangeList", "type": "object", "properties": { "addrRange": { "type": "array", "items": { "title": "AddrRange", "type": "object", "properties": { "startAddress": { "type": "string", "xml": { "name": "startAddress", "attribute": false, "wrapped": false } }, "endAddress": { "type": "string", "xml": { "name": "endAddress", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } } }, "description": "V4 Network model", "xml": { "name": "V4NetworkRec", "attribute": false, "wrapped": false } }, "description": "" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/searchV4Network" }, "task": true }, { "name": "getV6SubnetByAddress", "summary": "getV6SubnetByAddress", "description": "Get V6 subnet get by address and prefix length.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "V6SubnetRec", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "address": { "type": "string", "xml": { "name": "address", "attribute": false, "wrapped": false } }, "prefixLength": { "type": "integer", "xml": { "name": "prefixLength", "attribute": false, "wrapped": false } }, "domain": { "title": "StringList", "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "type": { "title": "V6SubnetType", "type": "string", "xml": { "name": "V6SubnetType", "attribute": false, "wrapped": false }, "example": "STATEFULL" }, "poolName": { "type": "string", "xml": { "name": "poolName", "attribute": false, "wrapped": false } }, "blockName": { "type": "string", "xml": { "name": "blockName", "attribute": false, "wrapped": false } }, "standPrimDHCPServer": { "type": "string", "xml": { "name": "standPrimDHCPServer", "attribute": false, "wrapped": false } }, "failoverSecondDHCPServer": { "type": "string", "xml": { "name": "failoverSecondDHCPServer", "attribute": false, "wrapped": false } }, "optTemplate": { "type": "string", "xml": { "name": "optTemplate", "attribute": false, "wrapped": false } }, "algorithmType": { "title": "V6DefaultAlgorithmType", "type": "string", "description": "depend on using Algorithm value for createSubnet", "xml": { "name": "V6DefaultAlgorithmType", "attribute": false, "wrapped": false }, "example": "BEST_FIT_FROM_START" }, "rangePrefixLength": { "type": "integer", "xml": { "name": "rangePrefixLength", "attribute": false, "wrapped": false } }, "addressSelection": { "title": "V6AddressSelectionType", "type": "string", "example": "NEXT_AVAILABLE" }, "dhcpParams": { "title": "V6DhcpOptionsRec", "type": "object", "properties": { "informationRefreshTime": { "type": "string", "xml": { "name": "informationRefreshTime", "attribute": false, "wrapped": false } }, "preferredLifeTime": { "type": "string", "xml": { "name": "preferredLifeTime", "attribute": false, "wrapped": false } }, "rebindingTime": { "type": "string", "xml": { "name": "rebindingTime", "attribute": false, "wrapped": false } }, "renewalTime": { "type": "string", "xml": { "name": "renewalTime", "attribute": false, "wrapped": false } }, "validLifeTime": { "type": "string", "xml": { "name": "validLifeTime", "attribute": false, "wrapped": false } }, "bcmcsServerAddressList": { "type": "string", "xml": { "name": "bcmcsServerAddressList", "attribute": false, "wrapped": false } }, "bcmcsServerDomainNameList": { "type": "string", "xml": { "name": "bcmcsServerDomainNameList", "attribute": false, "wrapped": false } }, "dnsRecursiveNameServer": { "type": "string", "xml": { "name": "dnsRecursiveNameServer", "attribute": false, "wrapped": false } }, "domainSearchList": { "type": "string", "xml": { "name": "domainSearchList", "attribute": false, "wrapped": false } }, "nisServers": { "type": "string", "xml": { "name": "nisServers", "attribute": false, "wrapped": false } }, "nispDomainName": { "type": "string", "xml": { "name": "nispDomainName", "attribute": false, "wrapped": false } }, "panaAuthenticationAgents": { "type": "string", "xml": { "name": "panaAuthenticationAgents", "attribute": false, "wrapped": false } }, "posixTimeZone": { "type": "string", "xml": { "name": "posixTimeZone", "attribute": false, "wrapped": false } }, "sipServersDomainNameList": { "type": "string", "xml": { "name": "sipServersDomainNameList", "attribute": false, "wrapped": false } }, "sipServersIpv6AddressList": { "type": "string", "xml": { "name": "sipServersIpv6AddressList", "attribute": false, "wrapped": false } }, "sntpServers": { "type": "string", "xml": { "name": "sntpServers", "attribute": false, "wrapped": false } }, "tzdbTimeZone": { "type": "string", "xml": { "name": "tzdbTimeZone", "attribute": false, "wrapped": false } }, "vendorOptions": { "type": "string", "xml": { "name": "vendorOptions", "attribute": false, "wrapped": false } } } } }, "description": "V6 Subnet model" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getV6SubnetByAddress" }, "task": true }, { "name": "deleteV6SubnetByAddress", "summary": "deleteV6SubnetByAddress", "description": "Delete V6 Subnet by address and prefix length.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteV6SubnetByAddress" }, "task": true }, { "name": "getV6AddressInV6SubnetByAddress", "summary": "getV6AddressInV6SubnetByAddress", "description": "Get list v6 address in v6 subnet by address and prefixlength.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "title": "V6AddressRec", "type": "object", "properties": { "hostName": { "type": "string", "xml": { "name": "hostName", "attribute": false, "wrapped": false } }, "domainName": { "type": "string", "xml": { "name": "domainName", "attribute": false, "wrapped": false } }, "fqdn": { "type": "string", "xml": { "name": "fqdn", "attribute": false, "wrapped": false } }, "rangeAddress": { "type": "string", "xml": { "name": "rangeAddress", "attribute": false, "wrapped": false } }, "address": { "type": "string", "xml": { "name": "address", "attribute": false, "wrapped": false } }, "newAddress": { "type": "string", "xml": { "name": "newAddress", "attribute": false, "wrapped": false } }, "iaid": { "type": "string", "xml": { "name": "iaid", "attribute": false, "wrapped": false } }, "addressType": { "title": "V6AddressType", "type": "string", "example": "STATIC" }, "range": { "type": "string", "xml": { "name": "range", "attribute": false, "wrapped": false } }, "subnet": { "type": "string", "xml": { "name": "subnet", "attribute": false, "wrapped": false } }, "publishA": { "title": "V6PublishType", "type": "string", "example": "ALWAYS" }, "publishPTR": { "title": "V6PublishType", "type": "string", "example": "ALWAYS" }, "ttl": { "type": "integer", "xml": { "name": "ttl", "attribute": false, "wrapped": false } }, "nodeName": { "type": "string", "xml": { "name": "nodeName", "attribute": false, "wrapped": false } }, "classType": { "type": "string", "xml": { "name": "classType", "attribute": false, "wrapped": false } }, "uniqueId": { "type": "string", "xml": { "name": "uniqueId", "attribute": false, "wrapped": false } }, "duid": { "type": "string", "xml": { "name": "duid", "attribute": false, "wrapped": false } }, "useMACAddress": { "type": "boolean", "xml": { "name": "useMACAddress", "attribute": false, "wrapped": false } }, "macAddress": { "type": "string", "xml": { "name": "macAddress", "attribute": false, "wrapped": false } } } }, "description": "" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getV6AddressInV6SubnetByAddress" }, "task": true }, { "name": "getListRangeInV6SubnetByAddress", "summary": "getListRangeInV6SubnetByAddress", "description": "Get list range in v6 subnet by address and prefixlength.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "title": "V6AddressRec", "type": "object", "properties": { "hostName": { "type": "string", "xml": { "name": "hostName", "attribute": false, "wrapped": false } }, "domainName": { "type": "string", "xml": { "name": "domainName", "attribute": false, "wrapped": false } }, "fqdn": { "type": "string", "xml": { "name": "fqdn", "attribute": false, "wrapped": false } }, "rangeAddress": { "type": "string", "xml": { "name": "rangeAddress", "attribute": false, "wrapped": false } }, "address": { "type": "string", "xml": { "name": "address", "attribute": false, "wrapped": false } }, "newAddress": { "type": "string", "xml": { "name": "newAddress", "attribute": false, "wrapped": false } }, "iaid": { "type": "string", "xml": { "name": "iaid", "attribute": false, "wrapped": false } }, "addressType": { "title": "V6AddressType", "type": "string", "example": "STATIC" }, "range": { "type": "string", "xml": { "name": "range", "attribute": false, "wrapped": false } }, "subnet": { "type": "string", "xml": { "name": "subnet", "attribute": false, "wrapped": false } }, "publishA": { "title": "V6PublishType", "type": "string", "example": "ALWAYS" }, "publishPTR": { "title": "V6PublishType", "type": "string", "example": "ALWAYS" }, "ttl": { "type": "integer", "xml": { "name": "ttl", "attribute": false, "wrapped": false } }, "nodeName": { "type": "string", "xml": { "name": "nodeName", "attribute": false, "wrapped": false } }, "classType": { "type": "string", "xml": { "name": "classType", "attribute": false, "wrapped": false } }, "uniqueId": { "type": "string", "xml": { "name": "uniqueId", "attribute": false, "wrapped": false } }, "duid": { "type": "string", "xml": { "name": "duid", "attribute": false, "wrapped": false } }, "useMACAddress": { "type": "boolean", "xml": { "name": "useMACAddress", "attribute": false, "wrapped": false } }, "macAddress": { "type": "string", "xml": { "name": "macAddress", "attribute": false, "wrapped": false } } } }, "description": "" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getListRangeInV6SubnetByAddress" }, "task": true }, { "name": "getV6SubnetByName", "summary": "getV6SubnetByName", "description": "Get V6 subnet by name", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "V6SubnetRec", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "address": { "type": "string", "xml": { "name": "address", "attribute": false, "wrapped": false } }, "prefixLength": { "type": "integer", "xml": { "name": "prefixLength", "attribute": false, "wrapped": false } }, "domain": { "title": "StringList", "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "type": { "title": "V6SubnetType", "type": "string", "xml": { "name": "V6SubnetType", "attribute": false, "wrapped": false }, "example": "STATEFULL" }, "poolName": { "type": "string", "xml": { "name": "poolName", "attribute": false, "wrapped": false } }, "blockName": { "type": "string", "xml": { "name": "blockName", "attribute": false, "wrapped": false } }, "standPrimDHCPServer": { "type": "string", "xml": { "name": "standPrimDHCPServer", "attribute": false, "wrapped": false } }, "failoverSecondDHCPServer": { "type": "string", "xml": { "name": "failoverSecondDHCPServer", "attribute": false, "wrapped": false } }, "optTemplate": { "type": "string", "xml": { "name": "optTemplate", "attribute": false, "wrapped": false } }, "algorithmType": { "title": "V6DefaultAlgorithmType", "type": "string", "description": "depend on using Algorithm value for createSubnet", "xml": { "name": "V6DefaultAlgorithmType", "attribute": false, "wrapped": false }, "example": "BEST_FIT_FROM_START" }, "rangePrefixLength": { "type": "integer", "xml": { "name": "rangePrefixLength", "attribute": false, "wrapped": false } }, "addressSelection": { "title": "V6AddressSelectionType", "type": "string", "example": "NEXT_AVAILABLE" }, "dhcpParams": { "title": "V6DhcpOptionsRec", "type": "object", "properties": { "informationRefreshTime": { "type": "string", "xml": { "name": "informationRefreshTime", "attribute": false, "wrapped": false } }, "preferredLifeTime": { "type": "string", "xml": { "name": "preferredLifeTime", "attribute": false, "wrapped": false } }, "rebindingTime": { "type": "string", "xml": { "name": "rebindingTime", "attribute": false, "wrapped": false } }, "renewalTime": { "type": "string", "xml": { "name": "renewalTime", "attribute": false, "wrapped": false } }, "validLifeTime": { "type": "string", "xml": { "name": "validLifeTime", "attribute": false, "wrapped": false } }, "bcmcsServerAddressList": { "type": "string", "xml": { "name": "bcmcsServerAddressList", "attribute": false, "wrapped": false } }, "bcmcsServerDomainNameList": { "type": "string", "xml": { "name": "bcmcsServerDomainNameList", "attribute": false, "wrapped": false } }, "dnsRecursiveNameServer": { "type": "string", "xml": { "name": "dnsRecursiveNameServer", "attribute": false, "wrapped": false } }, "domainSearchList": { "type": "string", "xml": { "name": "domainSearchList", "attribute": false, "wrapped": false } }, "nisServers": { "type": "string", "xml": { "name": "nisServers", "attribute": false, "wrapped": false } }, "nispDomainName": { "type": "string", "xml": { "name": "nispDomainName", "attribute": false, "wrapped": false } }, "panaAuthenticationAgents": { "type": "string", "xml": { "name": "panaAuthenticationAgents", "attribute": false, "wrapped": false } }, "posixTimeZone": { "type": "string", "xml": { "name": "posixTimeZone", "attribute": false, "wrapped": false } }, "sipServersDomainNameList": { "type": "string", "xml": { "name": "sipServersDomainNameList", "attribute": false, "wrapped": false } }, "sipServersIpv6AddressList": { "type": "string", "xml": { "name": "sipServersIpv6AddressList", "attribute": false, "wrapped": false } }, "sntpServers": { "type": "string", "xml": { "name": "sntpServers", "attribute": false, "wrapped": false } }, "tzdbTimeZone": { "type": "string", "xml": { "name": "tzdbTimeZone", "attribute": false, "wrapped": false } }, "vendorOptions": { "type": "string", "xml": { "name": "vendorOptions", "attribute": false, "wrapped": false } } } } }, "description": "V6 Subnet model" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getV6SubnetByName" }, "task": true }, { "name": "deleteV6SubnetByName", "summary": "deleteV6SubnetByName", "description": "Delete V6 Subnet by name", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteV6SubnetByName" }, "task": true }, { "name": "addV6Subnet", "summary": "addV6Subnet", "description": "Creates a new V6 Subnet. Subnet Name and Address pairs are returned after adding subnets successfully.\n*Note:* Should not test this API on Swagger. Please use another REST Client (cURL, Postman).", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/addV6Subnet" }, "task": true }, { "name": "updateV6Subnet", "summary": "updateV6Subnet", "description": "Modify a V6 Subnet", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/updateV6Subnet" }, "task": true }, { "name": "searchV6Subnet", "summary": "searchV6Subnet", "description": "Search V6 subnet by name or address.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "title": "V6SubnetRec", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "address": { "type": "string", "xml": { "name": "address", "attribute": false, "wrapped": false } }, "prefixLength": { "type": "integer", "xml": { "name": "prefixLength", "attribute": false, "wrapped": false } }, "domain": { "title": "StringList", "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "type": { "title": "V6SubnetType", "type": "string", "xml": { "name": "V6SubnetType", "attribute": false, "wrapped": false }, "example": "STATEFULL" }, "poolName": { "type": "string", "xml": { "name": "poolName", "attribute": false, "wrapped": false } }, "blockName": { "type": "string", "xml": { "name": "blockName", "attribute": false, "wrapped": false } }, "standPrimDHCPServer": { "type": "string", "xml": { "name": "standPrimDHCPServer", "attribute": false, "wrapped": false } }, "failoverSecondDHCPServer": { "type": "string", "xml": { "name": "failoverSecondDHCPServer", "attribute": false, "wrapped": false } }, "optTemplate": { "type": "string", "xml": { "name": "optTemplate", "attribute": false, "wrapped": false } }, "algorithmType": { "title": "V6DefaultAlgorithmType", "type": "string", "description": "depend on using Algorithm value for createSubnet", "xml": { "name": "V6DefaultAlgorithmType", "attribute": false, "wrapped": false }, "example": "BEST_FIT_FROM_START" }, "rangePrefixLength": { "type": "integer", "xml": { "name": "rangePrefixLength", "attribute": false, "wrapped": false } }, "addressSelection": { "title": "V6AddressSelectionType", "type": "string", "example": "NEXT_AVAILABLE" }, "dhcpParams": { "title": "V6DhcpOptionsRec", "type": "object", "properties": { "informationRefreshTime": { "type": "string", "xml": { "name": "informationRefreshTime", "attribute": false, "wrapped": false } }, "preferredLifeTime": { "type": "string", "xml": { "name": "preferredLifeTime", "attribute": false, "wrapped": false } }, "rebindingTime": { "type": "string", "xml": { "name": "rebindingTime", "attribute": false, "wrapped": false } }, "renewalTime": { "type": "string", "xml": { "name": "renewalTime", "attribute": false, "wrapped": false } }, "validLifeTime": { "type": "string", "xml": { "name": "validLifeTime", "attribute": false, "wrapped": false } }, "bcmcsServerAddressList": { "type": "string", "xml": { "name": "bcmcsServerAddressList", "attribute": false, "wrapped": false } }, "bcmcsServerDomainNameList": { "type": "string", "xml": { "name": "bcmcsServerDomainNameList", "attribute": false, "wrapped": false } }, "dnsRecursiveNameServer": { "type": "string", "xml": { "name": "dnsRecursiveNameServer", "attribute": false, "wrapped": false } }, "domainSearchList": { "type": "string", "xml": { "name": "domainSearchList", "attribute": false, "wrapped": false } }, "nisServers": { "type": "string", "xml": { "name": "nisServers", "attribute": false, "wrapped": false } }, "nispDomainName": { "type": "string", "xml": { "name": "nispDomainName", "attribute": false, "wrapped": false } }, "panaAuthenticationAgents": { "type": "string", "xml": { "name": "panaAuthenticationAgents", "attribute": false, "wrapped": false } }, "posixTimeZone": { "type": "string", "xml": { "name": "posixTimeZone", "attribute": false, "wrapped": false } }, "sipServersDomainNameList": { "type": "string", "xml": { "name": "sipServersDomainNameList", "attribute": false, "wrapped": false } }, "sipServersIpv6AddressList": { "type": "string", "xml": { "name": "sipServersIpv6AddressList", "attribute": false, "wrapped": false } }, "sntpServers": { "type": "string", "xml": { "name": "sntpServers", "attribute": false, "wrapped": false } }, "tzdbTimeZone": { "type": "string", "xml": { "name": "tzdbTimeZone", "attribute": false, "wrapped": false } }, "vendorOptions": { "type": "string", "xml": { "name": "vendorOptions", "attribute": false, "wrapped": false } } } } }, "description": "V6 Subnet model" }, "description": "" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/searchV6Subnet" }, "task": true }, { "name": "addV6Address", "summary": "addV6Address", "description": "Creates V6 Address", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/addV6Address" }, "task": true }, { "name": "updateV6Address", "summary": "updateV6Address", "description": "Modify V6 Address", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/updateV6Address" }, "task": true }, { "name": "deleteV6Address", "summary": "deleteV6Address", "description": "Delete V6 Address by name or address. The trailing slash is required.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteV6Address" }, "task": true }, { "name": "getV6Address", "summary": "getV6Address", "description": "Get V6 address by address or by name", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "V6AddressRec", "type": "object", "properties": { "hostName": { "type": "string", "xml": { "name": "hostName", "attribute": false, "wrapped": false } }, "domainName": { "type": "string", "xml": { "name": "domainName", "attribute": false, "wrapped": false } }, "fqdn": { "type": "string", "xml": { "name": "fqdn", "attribute": false, "wrapped": false } }, "rangeAddress": { "type": "string", "xml": { "name": "rangeAddress", "attribute": false, "wrapped": false } }, "address": { "type": "string", "xml": { "name": "address", "attribute": false, "wrapped": false } }, "newAddress": { "type": "string", "xml": { "name": "newAddress", "attribute": false, "wrapped": false } }, "iaid": { "type": "string", "xml": { "name": "iaid", "attribute": false, "wrapped": false } }, "addressType": { "title": "V6AddressType", "type": "string", "example": "STATIC" }, "range": { "type": "string", "xml": { "name": "range", "attribute": false, "wrapped": false } }, "subnet": { "type": "string", "xml": { "name": "subnet", "attribute": false, "wrapped": false } }, "publishA": { "title": "V6PublishType", "type": "string", "example": "ALWAYS" }, "publishPTR": { "title": "V6PublishType", "type": "string", "example": "ALWAYS" }, "ttl": { "type": "integer", "xml": { "name": "ttl", "attribute": false, "wrapped": false } }, "nodeName": { "type": "string", "xml": { "name": "nodeName", "attribute": false, "wrapped": false } }, "classType": { "type": "string", "xml": { "name": "classType", "attribute": false, "wrapped": false } }, "uniqueId": { "type": "string", "xml": { "name": "uniqueId", "attribute": false, "wrapped": false } }, "duid": { "type": "string", "xml": { "name": "duid", "attribute": false, "wrapped": false } }, "useMACAddress": { "type": "boolean", "xml": { "name": "useMACAddress", "attribute": false, "wrapped": false } }, "macAddress": { "type": "string", "xml": { "name": "macAddress", "attribute": false, "wrapped": false } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getV6Address" }, "task": true }, { "name": "addV4Subnet", "summary": "addV4Subnet", "description": "Creates V4 Subnet", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/addV4Subnet" }, "task": true }, { "name": "updateV4Subnet", "summary": "updateV4Subnet", "description": "Modify V4 Subnet", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/updateV4Subnet" }, "task": true }, { "name": "searchV4Subnet", "summary": "searchV4Subnet", "description": "Search V4 subnet by name or address.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "title": "V4SubnetRec", "type": "object", "properties": { "subnetAddress": { "type": "string", "xml": { "name": "subnetAddress", "attribute": false, "wrapped": false } }, "subnetMask": { "type": "string", "xml": { "name": "subnetMask", "attribute": false, "wrapped": false } }, "networkAddress": { "type": "string", "xml": { "name": "networkAddress", "attribute": false, "wrapped": false } }, "subnetName": { "type": "string", "xml": { "name": "subnetName", "attribute": false, "wrapped": false } }, "subnetOrg": { "type": "string", "xml": { "name": "subnetOrg", "attribute": false, "wrapped": false } }, "application": { "type": "string", "xml": { "name": "application", "attribute": false, "wrapped": false } }, "location": { "title": "LocationRec", "type": "object", "properties": { "id": { "type": "integer", "xml": { "name": "id", "attribute": false, "wrapped": false } }, "street1": { "type": "string", "xml": { "name": "street1", "attribute": false, "wrapped": false } }, "street2": { "type": "string", "xml": { "name": "street2", "attribute": false, "wrapped": false } }, "city": { "type": "string", "xml": { "name": "city", "attribute": false, "wrapped": false } }, "state": { "type": "string", "xml": { "name": "state", "attribute": false, "wrapped": false } }, "zip": { "type": "string", "xml": { "name": "zip", "attribute": false, "wrapped": false } }, "country": { "type": "string", "xml": { "name": "country", "attribute": false, "wrapped": false } } } }, "contact": { "title": "ContactRec", "type": "object", "properties": { "id": { "type": "integer", "xml": { "name": "id", "attribute": false, "wrapped": false } }, "firstName": { "type": "string", "xml": { "name": "firstName", "attribute": false, "wrapped": false } }, "lastName": { "type": "string", "xml": { "name": "lastName", "attribute": false, "wrapped": false } }, "telephone": { "type": "string", "xml": { "name": "telephone", "attribute": false, "wrapped": false } }, "pager": { "type": "string", "xml": { "name": "pager", "attribute": false, "wrapped": false } }, "email": { "type": "string", "xml": { "name": "email", "attribute": false, "wrapped": false } } } }, "hardwareType": { "title": "HwType", "type": "string", "example": "ETHERNET" }, "tftpServerName": { "type": "string", "xml": { "name": "tftpServerName", "attribute": false, "wrapped": false } }, "allowDHCPClientsToModifyDynamicObjectRRs": { "title": "ModifyRrsType", "type": "string", "example": "SAME_AS_IN_GLOBAL_POLICIES" }, "domains": { "title": "StringList", "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "showUsage": { "type": "string", "xml": { "name": "showUsage", "attribute": false, "wrapped": false } }, "checkUsage": { "type": "string", "xml": { "name": "checkUsage", "attribute": false, "wrapped": false } }, "subnetDescription": { "type": "string", "xml": { "name": "subnetDescription", "attribute": false, "wrapped": false } }, "sharedNetwork": { "type": "string", "xml": { "name": "sharedNetwork", "attribute": false, "wrapped": false } }, "warningType": { "type": "integer", "xml": { "name": "warningType", "attribute": false, "wrapped": false } }, "warningPercentage": { "type": "integer", "xml": { "name": "warningPercentage", "attribute": false, "wrapped": false } }, "preferredDNSServers": { "title": "StringList", "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "preferredTimeServers": { "title": "StringList", "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "defaultRouters": { "title": "StringList", "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "defaultDHCPServer": { "type": "string", "xml": { "name": "defaultDHCPServer", "attribute": false, "wrapped": false } }, "defaultDHCPOptionTemplate": { "type": "string", "xml": { "name": "defaultDHCPOptionTemplate", "attribute": false, "wrapped": false } }, "defaultDHCPPolicyTemplate": { "type": "string", "xml": { "name": "defaultDHCPPolicyTemplate", "attribute": false, "wrapped": false } }, "primaryInterface": { "type": "boolean", "xml": { "name": "primaryInterface", "attribute": false, "wrapped": false } }, "optionalAttributeList": { "title": "UdaList", "type": "object", "properties": { "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } }, "groups": { "type": "array", "items": { "title": "UdaGroup", "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "addressTemplate": { "type": "string", "xml": { "name": "addressTemplate", "attribute": false, "wrapped": false } }, "localTotalDynamicObjects": { "type": "integer", "xml": { "name": "localTotalDynamicObjects", "attribute": false, "wrapped": false } }, "localLeasedDynamicObjects": { "type": "integer", "xml": { "name": "localLeasedDynamicObjects", "attribute": false, "wrapped": false } }, "localPercentDynamicObjectsUsed": { "type": "number", "xml": { "name": "localPercentDynamicObjectsUsed", "attribute": false, "wrapped": false } } } }, "description": "" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/searchV4Subnet" }, "task": true }, { "name": "getV4Subnet", "summary": "getV4Subnet", "description": "Get V4 subnet by subnet address. Get objects usage information of a subnet using ?usage parameter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "V4SubnetRec", "type": "object", "properties": { "subnetAddress": { "type": "string", "xml": { "name": "subnetAddress", "attribute": false, "wrapped": false } }, "subnetMask": { "type": "string", "xml": { "name": "subnetMask", "attribute": false, "wrapped": false } }, "networkAddress": { "type": "string", "xml": { "name": "networkAddress", "attribute": false, "wrapped": false } }, "subnetName": { "type": "string", "xml": { "name": "subnetName", "attribute": false, "wrapped": false } }, "subnetOrg": { "type": "string", "xml": { "name": "subnetOrg", "attribute": false, "wrapped": false } }, "application": { "type": "string", "xml": { "name": "application", "attribute": false, "wrapped": false } }, "location": { "title": "LocationRec", "type": "object", "properties": { "id": { "type": "integer", "xml": { "name": "id", "attribute": false, "wrapped": false } }, "street1": { "type": "string", "xml": { "name": "street1", "attribute": false, "wrapped": false } }, "street2": { "type": "string", "xml": { "name": "street2", "attribute": false, "wrapped": false } }, "city": { "type": "string", "xml": { "name": "city", "attribute": false, "wrapped": false } }, "state": { "type": "string", "xml": { "name": "state", "attribute": false, "wrapped": false } }, "zip": { "type": "string", "xml": { "name": "zip", "attribute": false, "wrapped": false } }, "country": { "type": "string", "xml": { "name": "country", "attribute": false, "wrapped": false } } } }, "contact": { "title": "ContactRec", "type": "object", "properties": { "id": { "type": "integer", "xml": { "name": "id", "attribute": false, "wrapped": false } }, "firstName": { "type": "string", "xml": { "name": "firstName", "attribute": false, "wrapped": false } }, "lastName": { "type": "string", "xml": { "name": "lastName", "attribute": false, "wrapped": false } }, "telephone": { "type": "string", "xml": { "name": "telephone", "attribute": false, "wrapped": false } }, "pager": { "type": "string", "xml": { "name": "pager", "attribute": false, "wrapped": false } }, "email": { "type": "string", "xml": { "name": "email", "attribute": false, "wrapped": false } } } }, "hardwareType": { "title": "HwType", "type": "string", "example": "ETHERNET" }, "tftpServerName": { "type": "string", "xml": { "name": "tftpServerName", "attribute": false, "wrapped": false } }, "allowDHCPClientsToModifyDynamicObjectRRs": { "title": "ModifyRrsType", "type": "string", "example": "SAME_AS_IN_GLOBAL_POLICIES" }, "domains": { "title": "StringList", "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "showUsage": { "type": "string", "xml": { "name": "showUsage", "attribute": false, "wrapped": false } }, "checkUsage": { "type": "string", "xml": { "name": "checkUsage", "attribute": false, "wrapped": false } }, "subnetDescription": { "type": "string", "xml": { "name": "subnetDescription", "attribute": false, "wrapped": false } }, "sharedNetwork": { "type": "string", "xml": { "name": "sharedNetwork", "attribute": false, "wrapped": false } }, "warningType": { "type": "integer", "xml": { "name": "warningType", "attribute": false, "wrapped": false } }, "warningPercentage": { "type": "integer", "xml": { "name": "warningPercentage", "attribute": false, "wrapped": false } }, "preferredDNSServers": { "title": "StringList", "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "preferredTimeServers": { "title": "StringList", "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "defaultRouters": { "title": "StringList", "type": "object", "properties": { "name": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "defaultDHCPServer": { "type": "string", "xml": { "name": "defaultDHCPServer", "attribute": false, "wrapped": false } }, "defaultDHCPOptionTemplate": { "type": "string", "xml": { "name": "defaultDHCPOptionTemplate", "attribute": false, "wrapped": false } }, "defaultDHCPPolicyTemplate": { "type": "string", "xml": { "name": "defaultDHCPPolicyTemplate", "attribute": false, "wrapped": false } }, "primaryInterface": { "type": "boolean", "xml": { "name": "primaryInterface", "attribute": false, "wrapped": false } }, "optionalAttributeList": { "title": "UdaList", "type": "object", "properties": { "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } }, "groups": { "type": "array", "items": { "title": "UdaGroup", "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "addressTemplate": { "type": "string", "xml": { "name": "addressTemplate", "attribute": false, "wrapped": false } }, "localTotalDynamicObjects": { "type": "integer", "xml": { "name": "localTotalDynamicObjects", "attribute": false, "wrapped": false } }, "localLeasedDynamicObjects": { "type": "integer", "xml": { "name": "localLeasedDynamicObjects", "attribute": false, "wrapped": false } }, "localPercentDynamicObjectsUsed": { "type": "number", "xml": { "name": "localPercentDynamicObjectsUsed", "attribute": false, "wrapped": false } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getV4Subnet" }, "task": true }, { "name": "deleteV4SubnetByName", "summary": "deleteV4SubnetByName", "description": "Delete V4 Subnet by name or by address. The trailing slash is required.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteV4SubnetByName" }, "task": true }, { "name": "getListAddressV4Subnet", "summary": "getListAddressV4Subnet", "description": "Get list V4 address of a V4 Subnet by subnet address", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "title": "V4AddrRec", "type": "object", "properties": { "objectAddr": { "type": "string", "description": "The hostname of the object. Not fully-qualified.", "xml": { "name": "objectAddr", "attribute": false, "wrapped": false } }, "subnetAddr": { "type": "string", "xml": { "name": "subnetAddr", "attribute": false, "wrapped": false } }, "objectName": { "type": "string", "xml": { "name": "objectName", "attribute": false, "wrapped": false } }, "objectClass": { "type": "string", "description": "ObjectClass is a value of Workstation, X-terminal, PC, Printer, Server, Wiring_HUB, Router, Bridge, Terminal_Server, Switch, Legacy_System, Gateway, Test_Equipment, Undefined, Others, Any user-defined object class name.", "xml": { "name": "objectClass", "attribute": false, "wrapped": false } }, "domainName": { "type": "string", "description": "The domain of the object. If no value is provided, the Domain Name is identified as the default domain of the subnet the Object is on.", "xml": { "name": "domainName", "attribute": false, "wrapped": false } }, "expiredDate": { "type": "string", "description": "The date when a reserved object expires and is no longer reserved.", "xml": { "name": "expiredDate", "attribute": false, "wrapped": false } }, "serverType": { "type": "string", "description": "Only applicable if ObjectClass is 'server': TimeServer- If object is a time server, TftpServer- If object is a Tftp server, TftpServer\\&TimeServer- If object is a TftpServer and TimeServer.", "xml": { "name": "serverType", "attribute": false, "wrapped": false } }, "applName": { "type": "string", "description": "The 'Primary Application' of the object.", "xml": { "name": "applName", "attribute": false, "wrapped": false } }, "objectTag": { "type": "string", "description": "Tag field", "xml": { "name": "objectTag", "attribute": false, "wrapped": false } }, "roomId": { "type": "string", "description": "Room ID field", "xml": { "name": "roomId", "attribute": false, "wrapped": false } }, "manufacturer": { "type": "string", "description": "Manufacturer Name", "xml": { "name": "manufacturer", "attribute": false, "wrapped": false } }, "modelType": { "type": "string", "description": "Model Name", "xml": { "name": "modelType", "attribute": false, "wrapped": false } }, "serialNumber": { "type": "string", "description": "Serial Number of Object", "xml": { "name": "serialNumber", "attribute": false, "wrapped": false } }, "assetNumber": { "type": "string", "description": "Asset Number of object", "xml": { "name": "assetNumber", "attribute": false, "wrapped": false } }, "hostId": { "type": "string", "description": "Host ID of object", "xml": { "name": "hostId", "attribute": false, "wrapped": false } }, "purchaseDate": { "type": "string", "description": "Purchase Date/Time of object. Must be in yyyy-mm-dd format", "xml": { "name": "purchaseDate", "attribute": false, "wrapped": false } }, "objectDesc": { "type": "string", "description": "Object Description", "xml": { "name": "objectDesc", "attribute": false, "wrapped": false } }, "hubName": { "type": "string", "description": "Hub Name(s) assigned to object.", "xml": { "name": "hubName", "attribute": false, "wrapped": false } }, "slotName": { "type": "string", "description": "Slot Name(s) assigned to object.", "xml": { "name": "slotName", "attribute": false, "wrapped": false } }, "portNumber": { "type": "string", "description": "Port Numbers assigned to object.", "xml": { "name": "portNumber", "attribute": false, "wrapped": false } }, "locationId": { "type": "string", "description": "The Location ID. If no Location ID is specified, an attempt is made to match the record EXACTLY with the Street1, Street2, City, State, Zip and/or Country information that is supplied. If a match is not found, a new record is added without an ID.", "xml": { "name": "locationId", "attribute": false, "wrapped": false } }, "street1": { "type": "string", "description": "Street1 field of the location.", "xml": { "name": "street1", "attribute": false, "wrapped": false } }, "street2": { "type": "string", "description": "Street2 field of the location.", "xml": { "name": "street2", "attribute": false, "wrapped": false } }, "city": { "type": "string", "description": "City of the location.", "xml": { "name": "city", "attribute": false, "wrapped": false } }, "state": { "type": "string", "description": "State of the location.", "xml": { "name": "state", "attribute": false, "wrapped": false } }, "zip": { "type": "string", "description": "Zip of the location.", "xml": { "name": "zip", "attribute": false, "wrapped": false } }, "country": { "type": "string", "description": "Country of the location.", "xml": { "name": "country", "attribute": false, "wrapped": false } }, "contactId": { "type": "string", "description": "The Contact ID. If no Contact ID is specified, an attempt is made to match the record EXACTLY with the ContactLastName and ContactFirstName information that is supplied. If no match is found, a new record is added without an ID.", "xml": { "name": "contactId", "attribute": false, "wrapped": false } }, "contactLastName": { "type": "string", "description": "Contact last name.", "xml": { "name": "contactLastName", "attribute": false, "wrapped": false } }, "contactFirstName": { "type": "string", "description": "Contact first name.", "xml": { "name": "contactFirstName", "attribute": false, "wrapped": false } }, "contactEmail": { "type": "string", "description": "Contact email address.", "xml": { "name": "contactEmail", "attribute": false, "wrapped": false } }, "contactPhone": { "type": "string", "description": "Contact phone number.", "xml": { "name": "contactPhone", "attribute": false, "wrapped": false } }, "contactPager": { "type": "string", "description": "Contact pager number.", "xml": { "name": "contactPager", "attribute": false, "wrapped": false } }, "routerGroup": { "type": "string", "description": "Router Group of object. Only applicable if the object class is \"router\".", "xml": { "name": "routerGroup", "attribute": false, "wrapped": false } }, "dynamicConfig": { "type": "string", "description": "Dynamic Configuration of Object include Blank - Static object, None- Dynamic (none), M-DHCP- Manual DHCP, A-DHCP- Automatic DHCP, D-DHCP- Dynamic DHCP, M-BOOTP- Manual Bootp, A-BOOTP- Automatic Bootp, Reserved - To reserve an object (the IP must be unused)", "xml": { "name": "dynamicConfig", "attribute": false, "wrapped": false } }, "macAddr": { "type": "string", "description": "The Mac Address of Object. Exclude the colons (:) when entering a MAC address.", "xml": { "name": "macAddr", "attribute": false, "wrapped": false } }, "tftpServer": { "type": "string", "description": "TFTP Server of object. Only applicable if object type is M-BOOTP.", "xml": { "name": "tftpServer", "attribute": false, "wrapped": false } }, "bootFileName": { "type": "string", "description": "Bootfile name of object. Only applicable if object type is MBOOTP.", "xml": { "name": "bootFileName", "attribute": false, "wrapped": false } }, "hardwareType": { "type": "string", "description": "NONE, ETHERNET, TOKEN_RING, AX25, PRONET, CHAOS, IEEE802, ARCNET.", "xml": { "name": "hardwareType", "attribute": false, "wrapped": false } }, "aliases": { "type": "string", "xml": { "name": "aliases", "attribute": false, "wrapped": false } }, "mailForwarders": { "type": "string", "xml": { "name": "mailForwarders", "attribute": false, "wrapped": false } }, "mailHosts": { "type": "string", "xml": { "name": "mailHosts", "attribute": false, "wrapped": false } }, "hubSlots": { "type": "string", "xml": { "name": "hubSlots", "attribute": false, "wrapped": false } }, "dnsServers": { "type": "string", "description": "DNS Servers attached to this object. If multiple, separate by space. Only applicable for M-BOOTP objects.", "xml": { "name": "dnsServers", "attribute": false, "wrapped": false } }, "timeServers": { "type": "string", "description": "Time Servers attached to this object. If multiple, separate by space. Only applicable for M-BOOTP objects.", "xml": { "name": "timeServers", "attribute": false, "wrapped": false } }, "defaultRouters": { "type": "string", "description": "IP Address(es) of Default routers, separated by space if multiples.", "xml": { "name": "defaultRouters", "attribute": false, "wrapped": false } }, "userClasses": { "type": "string", "description": "Specific categories of user options. To enter one or more user classes for this object, enclose a list of users in double quotes (for example, user1, user2, user3).", "xml": { "name": "userClasses", "attribute": false, "wrapped": false } }, "users": { "type": "string", "xml": { "name": "users", "attribute": false, "wrapped": false } }, "nameService": { "type": "string", "description": "Name Services selection:\n- No: Name Services checked off.\n- Yes: Name Services checked on.\n- A: Name Services checked on, A record checked on.\n- PTR: Name Services checked on, PTR record checked on.\n- A PTR: Name Services checked on, A record checked on, PTR record checked on.", "xml": { "name": "nameService", "attribute": false, "wrapped": false } }, "dynamicDnsUpdate": { "type": "string", "description": "Dynamic Update selection:\n - A- Dynamic updates for A records.\n - PTR- Dynamic updates for PTR records.\n - CNAME- Dynamic updates for CNAME records.\n - MX- Dynamic updates for MX records.", "xml": { "name": "dynamicDnsUpdate", "attribute": false, "wrapped": false } }, "dhcpServer": { "type": "string", "description": "The DHCP Server assigned to this object. Only applicable for dynamic objects.", "xml": { "name": "dhcpServer", "attribute": false, "wrapped": false } }, "dhcpOptionTemplate": { "type": "string", "description": "The DHCP Option Template assigned to this object. Only applicable for dynamic objects.", "xml": { "name": "dhcpOptionTemplate", "attribute": false, "wrapped": false } }, "dhcpPolicyTemplate": { "type": "string", "description": "The DHCP Policy template assigned to this object. Only applicable for dynamic objects.", "xml": { "name": "dhcpPolicyTemplate", "attribute": false, "wrapped": false } }, "leaseTime": { "type": "string", "description": "The lease time (in seconds assigned) to this object. Only applicable for dynamic objects.", "xml": { "name": "leaseTime", "attribute": false, "wrapped": false } }, "ttlTime": { "type": "string", "description": "Time to live (TTL) value, in seconds. Since 0 is a valid value, a value of-1 indicates no TTL set.", "xml": { "name": "ttlTime", "attribute": false, "wrapped": false } }, "vendorClass": { "type": "string", "description": "The Vendor Class assigned to this object. Only applicable for dynamic objects.", "xml": { "name": "vendorClass", "attribute": false, "wrapped": false } }, "clientId": { "type": "string", "description": "The unique value assigned to DHCP client.", "xml": { "name": "clientId", "attribute": false, "wrapped": false } }, "dualProtocol": { "type": "string", "xml": { "name": "dualProtocol", "attribute": false, "wrapped": false } }, "decNetArea": { "type": "string", "description": "DECNet Area. (Valid values are 1-63) Only applicable if Dual Protocol is set to DECNet. The DECNet Address is calculated on the input in the DECNetArea and the DECNet Node.", "xml": { "name": "decNetArea", "attribute": false, "wrapped": false } }, "decNetAddr": { "type": "string", "description": "DECNet Address. (Valid values are 1-1024) Only applicable if Dual Protocol set to DECNet. The DECNet Address is calculated on the input in the DECNetArea and the DECNet Node.", "xml": { "name": "decNetAddr", "attribute": false, "wrapped": false } }, "decNetNode": { "type": "string", "xml": { "name": "decNetNode", "attribute": false, "wrapped": false } }, "talkType": { "type": "string", "xml": { "name": "talkType", "attribute": false, "wrapped": false } }, "ipxNode": { "type": "string", "description": "IPX Node. Only applicable if Dual Protocol is set to IPX.", "xml": { "name": "ipxNode", "attribute": false, "wrapped": false } }, "ipxNetworkNumber": { "type": "string", "description": "IPX Network number. Only applicable if Dual Protocol is set to IPX.", "xml": { "name": "ipxNetworkNumber", "attribute": false, "wrapped": false } }, "netBiosDomain": { "type": "string", "description": "NetBIOS Name. Only applicable when dual protocol is set to NETBIOS.", "xml": { "name": "netBiosDomain", "attribute": false, "wrapped": false } }, "netBiosName": { "type": "string", "description": "NetBIOS Domain. Only applicable when dual protocol set to NETBIOS.", "xml": { "name": "netBiosName", "attribute": false, "wrapped": false } }, "usageBillServices": { "type": "string", "xml": { "name": "usageBillServices", "attribute": false, "wrapped": false } }, "usageBillLocation": { "type": "string", "xml": { "name": "usageBillLocation", "attribute": false, "wrapped": false } }, "usageBillUserGroup": { "type": "string", "xml": { "name": "usageBillUserGroup", "attribute": false, "wrapped": false } }, "usageBillObjectClass": { "type": "string", "xml": { "name": "usageBillObjectClass", "attribute": false, "wrapped": false } }, "allowModifyDynamicRRs": { "type": "string", "xml": { "name": "allowModifyDynamicRRs", "attribute": false, "wrapped": false } }, "tombstoned": { "type": "string", "description": "1 indicates that this is a tombstoned external record. 0 indicates that it is not a tombstoned external record.", "xml": { "name": "tombstoned", "attribute": false, "wrapped": false } }, "externalComment": { "type": "string", "description": "text (up to 255 characters), a comment indicating the history of this external add.", "xml": { "name": "externalComment", "attribute": false, "wrapped": false } }, "externalTimestamp": { "type": "string", "description": "ExternalTimestamp must be in \"yyyy-mm-dd\" format", "xml": { "name": "externalTimestamp", "attribute": false, "wrapped": false } }, "manualFlag": { "type": "string", "description": "Determines whether MACAddress/ClientID is set based on its value. If value is 0, MACAddress is set, if value is 1, ClientID is set.", "xml": { "name": "manualFlag", "attribute": false, "wrapped": false } }, "nodeId": { "type": "string", "xml": { "name": "nodeId", "attribute": false, "wrapped": false } }, "uniqueNodeId": { "type": "string", "xml": { "name": "uniqueNodeId", "attribute": false, "wrapped": false } }, "aTTL": { "type": "string", "xml": { "name": "aTTL", "attribute": false, "wrapped": false } }, "ptrTTL": { "type": "string", "xml": { "name": "ptrTTL", "attribute": false, "wrapped": false } }, "publishA": { "type": "string", "description": "A resource record option (Always | None | Push Only).", "xml": { "name": "publishA", "attribute": false, "wrapped": false } }, "publishPTR": { "type": "string", "description": "PTR resource record option (Always | None | Push Only).", "xml": { "name": "publishPTR", "attribute": false, "wrapped": false } }, "dhcpClientClass": { "type": "string", "xml": { "name": "dhcpClientClass", "attribute": false, "wrapped": false } }, "isUpdate": { "type": "string", "xml": { "name": "isUpdate", "attribute": false, "wrapped": false } }, "isAddSelected": { "type": "string", "xml": { "name": "isAddSelected", "attribute": false, "wrapped": false } }, "isCheckDupName": { "type": "string", "xml": { "name": "isCheckDupName", "attribute": false, "wrapped": false } }, "isCheckOnlyFQDNDups": { "type": "string", "xml": { "name": "isCheckOnlyFQDNDups", "attribute": false, "wrapped": false } }, "isSwapAliasAndObjectName": { "type": "string", "xml": { "name": "isSwapAliasAndObjectName", "attribute": false, "wrapped": false } }, "localManualFlag": { "type": "string", "xml": { "name": "localManualFlag", "attribute": false, "wrapped": false } } } }, "description": "" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getListAddressV4Subnet" }, "task": true }, { "name": "addV4Address", "summary": "addV4Address", "description": "Creates V4 Address", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/addV4Address" }, "task": true }, { "name": "updateV4Address", "summary": "updateV4Address", "description": "Modify V4 Address", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/updateV4Address" }, "task": true }, { "name": "deleteV4Address", "summary": "deleteV4Address", "description": "Delete V4 Address by name or address. The trailing slash is required.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteV4Address" }, "task": true }, { "name": "getV4Address", "summary": "getV4Address", "description": "Get V4 address by name or by address", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "V4AddrRec", "type": "object", "properties": { "objectAddr": { "type": "string", "description": "The hostname of the object. Not fully-qualified.", "xml": { "name": "objectAddr", "attribute": false, "wrapped": false } }, "subnetAddr": { "type": "string", "xml": { "name": "subnetAddr", "attribute": false, "wrapped": false } }, "objectName": { "type": "string", "xml": { "name": "objectName", "attribute": false, "wrapped": false } }, "objectClass": { "type": "string", "description": "ObjectClass is a value of Workstation, X-terminal, PC, Printer, Server, Wiring_HUB, Router, Bridge, Terminal_Server, Switch, Legacy_System, Gateway, Test_Equipment, Undefined, Others, Any user-defined object class name.", "xml": { "name": "objectClass", "attribute": false, "wrapped": false } }, "domainName": { "type": "string", "description": "The domain of the object. If no value is provided, the Domain Name is identified as the default domain of the subnet the Object is on.", "xml": { "name": "domainName", "attribute": false, "wrapped": false } }, "expiredDate": { "type": "string", "description": "The date when a reserved object expires and is no longer reserved.", "xml": { "name": "expiredDate", "attribute": false, "wrapped": false } }, "serverType": { "type": "string", "description": "Only applicable if ObjectClass is 'server': TimeServer- If object is a time server, TftpServer- If object is a Tftp server, TftpServer\\&TimeServer- If object is a TftpServer and TimeServer.", "xml": { "name": "serverType", "attribute": false, "wrapped": false } }, "applName": { "type": "string", "description": "The 'Primary Application' of the object.", "xml": { "name": "applName", "attribute": false, "wrapped": false } }, "objectTag": { "type": "string", "description": "Tag field", "xml": { "name": "objectTag", "attribute": false, "wrapped": false } }, "roomId": { "type": "string", "description": "Room ID field", "xml": { "name": "roomId", "attribute": false, "wrapped": false } }, "manufacturer": { "type": "string", "description": "Manufacturer Name", "xml": { "name": "manufacturer", "attribute": false, "wrapped": false } }, "modelType": { "type": "string", "description": "Model Name", "xml": { "name": "modelType", "attribute": false, "wrapped": false } }, "serialNumber": { "type": "string", "description": "Serial Number of Object", "xml": { "name": "serialNumber", "attribute": false, "wrapped": false } }, "assetNumber": { "type": "string", "description": "Asset Number of object", "xml": { "name": "assetNumber", "attribute": false, "wrapped": false } }, "hostId": { "type": "string", "description": "Host ID of object", "xml": { "name": "hostId", "attribute": false, "wrapped": false } }, "purchaseDate": { "type": "string", "description": "Purchase Date/Time of object. Must be in yyyy-mm-dd format", "xml": { "name": "purchaseDate", "attribute": false, "wrapped": false } }, "objectDesc": { "type": "string", "description": "Object Description", "xml": { "name": "objectDesc", "attribute": false, "wrapped": false } }, "hubName": { "type": "string", "description": "Hub Name(s) assigned to object.", "xml": { "name": "hubName", "attribute": false, "wrapped": false } }, "slotName": { "type": "string", "description": "Slot Name(s) assigned to object.", "xml": { "name": "slotName", "attribute": false, "wrapped": false } }, "portNumber": { "type": "string", "description": "Port Numbers assigned to object.", "xml": { "name": "portNumber", "attribute": false, "wrapped": false } }, "locationId": { "type": "string", "description": "The Location ID. If no Location ID is specified, an attempt is made to match the record EXACTLY with the Street1, Street2, City, State, Zip and/or Country information that is supplied. If a match is not found, a new record is added without an ID.", "xml": { "name": "locationId", "attribute": false, "wrapped": false } }, "street1": { "type": "string", "description": "Street1 field of the location.", "xml": { "name": "street1", "attribute": false, "wrapped": false } }, "street2": { "type": "string", "description": "Street2 field of the location.", "xml": { "name": "street2", "attribute": false, "wrapped": false } }, "city": { "type": "string", "description": "City of the location.", "xml": { "name": "city", "attribute": false, "wrapped": false } }, "state": { "type": "string", "description": "State of the location.", "xml": { "name": "state", "attribute": false, "wrapped": false } }, "zip": { "type": "string", "description": "Zip of the location.", "xml": { "name": "zip", "attribute": false, "wrapped": false } }, "country": { "type": "string", "description": "Country of the location.", "xml": { "name": "country", "attribute": false, "wrapped": false } }, "contactId": { "type": "string", "description": "The Contact ID. If no Contact ID is specified, an attempt is made to match the record EXACTLY with the ContactLastName and ContactFirstName information that is supplied. If no match is found, a new record is added without an ID.", "xml": { "name": "contactId", "attribute": false, "wrapped": false } }, "contactLastName": { "type": "string", "description": "Contact last name.", "xml": { "name": "contactLastName", "attribute": false, "wrapped": false } }, "contactFirstName": { "type": "string", "description": "Contact first name.", "xml": { "name": "contactFirstName", "attribute": false, "wrapped": false } }, "contactEmail": { "type": "string", "description": "Contact email address.", "xml": { "name": "contactEmail", "attribute": false, "wrapped": false } }, "contactPhone": { "type": "string", "description": "Contact phone number.", "xml": { "name": "contactPhone", "attribute": false, "wrapped": false } }, "contactPager": { "type": "string", "description": "Contact pager number.", "xml": { "name": "contactPager", "attribute": false, "wrapped": false } }, "routerGroup": { "type": "string", "description": "Router Group of object. Only applicable if the object class is \"router\".", "xml": { "name": "routerGroup", "attribute": false, "wrapped": false } }, "dynamicConfig": { "type": "string", "description": "Dynamic Configuration of Object include Blank - Static object, None- Dynamic (none), M-DHCP- Manual DHCP, A-DHCP- Automatic DHCP, D-DHCP- Dynamic DHCP, M-BOOTP- Manual Bootp, A-BOOTP- Automatic Bootp, Reserved - To reserve an object (the IP must be unused)", "xml": { "name": "dynamicConfig", "attribute": false, "wrapped": false } }, "macAddr": { "type": "string", "description": "The Mac Address of Object. Exclude the colons (:) when entering a MAC address.", "xml": { "name": "macAddr", "attribute": false, "wrapped": false } }, "tftpServer": { "type": "string", "description": "TFTP Server of object. Only applicable if object type is M-BOOTP.", "xml": { "name": "tftpServer", "attribute": false, "wrapped": false } }, "bootFileName": { "type": "string", "description": "Bootfile name of object. Only applicable if object type is MBOOTP.", "xml": { "name": "bootFileName", "attribute": false, "wrapped": false } }, "hardwareType": { "type": "string", "description": "NONE, ETHERNET, TOKEN_RING, AX25, PRONET, CHAOS, IEEE802, ARCNET.", "xml": { "name": "hardwareType", "attribute": false, "wrapped": false } }, "aliases": { "type": "string", "xml": { "name": "aliases", "attribute": false, "wrapped": false } }, "mailForwarders": { "type": "string", "xml": { "name": "mailForwarders", "attribute": false, "wrapped": false } }, "mailHosts": { "type": "string", "xml": { "name": "mailHosts", "attribute": false, "wrapped": false } }, "hubSlots": { "type": "string", "xml": { "name": "hubSlots", "attribute": false, "wrapped": false } }, "dnsServers": { "type": "string", "description": "DNS Servers attached to this object. If multiple, separate by space. Only applicable for M-BOOTP objects.", "xml": { "name": "dnsServers", "attribute": false, "wrapped": false } }, "timeServers": { "type": "string", "description": "Time Servers attached to this object. If multiple, separate by space. Only applicable for M-BOOTP objects.", "xml": { "name": "timeServers", "attribute": false, "wrapped": false } }, "defaultRouters": { "type": "string", "description": "IP Address(es) of Default routers, separated by space if multiples.", "xml": { "name": "defaultRouters", "attribute": false, "wrapped": false } }, "userClasses": { "type": "string", "description": "Specific categories of user options. To enter one or more user classes for this object, enclose a list of users in double quotes (for example, user1, user2, user3).", "xml": { "name": "userClasses", "attribute": false, "wrapped": false } }, "users": { "type": "string", "xml": { "name": "users", "attribute": false, "wrapped": false } }, "nameService": { "type": "string", "description": "Name Services selection:\n- No: Name Services checked off.\n- Yes: Name Services checked on.\n- A: Name Services checked on, A record checked on.\n- PTR: Name Services checked on, PTR record checked on.\n- A PTR: Name Services checked on, A record checked on, PTR record checked on.", "xml": { "name": "nameService", "attribute": false, "wrapped": false } }, "dynamicDnsUpdate": { "type": "string", "description": "Dynamic Update selection:\n - A- Dynamic updates for A records.\n - PTR- Dynamic updates for PTR records.\n - CNAME- Dynamic updates for CNAME records.\n - MX- Dynamic updates for MX records.", "xml": { "name": "dynamicDnsUpdate", "attribute": false, "wrapped": false } }, "dhcpServer": { "type": "string", "description": "The DHCP Server assigned to this object. Only applicable for dynamic objects.", "xml": { "name": "dhcpServer", "attribute": false, "wrapped": false } }, "dhcpOptionTemplate": { "type": "string", "description": "The DHCP Option Template assigned to this object. Only applicable for dynamic objects.", "xml": { "name": "dhcpOptionTemplate", "attribute": false, "wrapped": false } }, "dhcpPolicyTemplate": { "type": "string", "description": "The DHCP Policy template assigned to this object. Only applicable for dynamic objects.", "xml": { "name": "dhcpPolicyTemplate", "attribute": false, "wrapped": false } }, "leaseTime": { "type": "string", "description": "The lease time (in seconds assigned) to this object. Only applicable for dynamic objects.", "xml": { "name": "leaseTime", "attribute": false, "wrapped": false } }, "ttlTime": { "type": "string", "description": "Time to live (TTL) value, in seconds. Since 0 is a valid value, a value of-1 indicates no TTL set.", "xml": { "name": "ttlTime", "attribute": false, "wrapped": false } }, "vendorClass": { "type": "string", "description": "The Vendor Class assigned to this object. Only applicable for dynamic objects.", "xml": { "name": "vendorClass", "attribute": false, "wrapped": false } }, "clientId": { "type": "string", "description": "The unique value assigned to DHCP client.", "xml": { "name": "clientId", "attribute": false, "wrapped": false } }, "dualProtocol": { "type": "string", "xml": { "name": "dualProtocol", "attribute": false, "wrapped": false } }, "decNetArea": { "type": "string", "description": "DECNet Area. (Valid values are 1-63) Only applicable if Dual Protocol is set to DECNet. The DECNet Address is calculated on the input in the DECNetArea and the DECNet Node.", "xml": { "name": "decNetArea", "attribute": false, "wrapped": false } }, "decNetAddr": { "type": "string", "description": "DECNet Address. (Valid values are 1-1024) Only applicable if Dual Protocol set to DECNet. The DECNet Address is calculated on the input in the DECNetArea and the DECNet Node.", "xml": { "name": "decNetAddr", "attribute": false, "wrapped": false } }, "decNetNode": { "type": "string", "xml": { "name": "decNetNode", "attribute": false, "wrapped": false } }, "talkType": { "type": "string", "xml": { "name": "talkType", "attribute": false, "wrapped": false } }, "ipxNode": { "type": "string", "description": "IPX Node. Only applicable if Dual Protocol is set to IPX.", "xml": { "name": "ipxNode", "attribute": false, "wrapped": false } }, "ipxNetworkNumber": { "type": "string", "description": "IPX Network number. Only applicable if Dual Protocol is set to IPX.", "xml": { "name": "ipxNetworkNumber", "attribute": false, "wrapped": false } }, "netBiosDomain": { "type": "string", "description": "NetBIOS Name. Only applicable when dual protocol is set to NETBIOS.", "xml": { "name": "netBiosDomain", "attribute": false, "wrapped": false } }, "netBiosName": { "type": "string", "description": "NetBIOS Domain. Only applicable when dual protocol set to NETBIOS.", "xml": { "name": "netBiosName", "attribute": false, "wrapped": false } }, "usageBillServices": { "type": "string", "xml": { "name": "usageBillServices", "attribute": false, "wrapped": false } }, "usageBillLocation": { "type": "string", "xml": { "name": "usageBillLocation", "attribute": false, "wrapped": false } }, "usageBillUserGroup": { "type": "string", "xml": { "name": "usageBillUserGroup", "attribute": false, "wrapped": false } }, "usageBillObjectClass": { "type": "string", "xml": { "name": "usageBillObjectClass", "attribute": false, "wrapped": false } }, "allowModifyDynamicRRs": { "type": "string", "xml": { "name": "allowModifyDynamicRRs", "attribute": false, "wrapped": false } }, "tombstoned": { "type": "string", "description": "1 indicates that this is a tombstoned external record. 0 indicates that it is not a tombstoned external record.", "xml": { "name": "tombstoned", "attribute": false, "wrapped": false } }, "externalComment": { "type": "string", "description": "text (up to 255 characters), a comment indicating the history of this external add.", "xml": { "name": "externalComment", "attribute": false, "wrapped": false } }, "externalTimestamp": { "type": "string", "description": "ExternalTimestamp must be in \"yyyy-mm-dd\" format", "xml": { "name": "externalTimestamp", "attribute": false, "wrapped": false } }, "manualFlag": { "type": "string", "description": "Determines whether MACAddress/ClientID is set based on its value. If value is 0, MACAddress is set, if value is 1, ClientID is set.", "xml": { "name": "manualFlag", "attribute": false, "wrapped": false } }, "nodeId": { "type": "string", "xml": { "name": "nodeId", "attribute": false, "wrapped": false } }, "uniqueNodeId": { "type": "string", "xml": { "name": "uniqueNodeId", "attribute": false, "wrapped": false } }, "aTTL": { "type": "string", "xml": { "name": "aTTL", "attribute": false, "wrapped": false } }, "ptrTTL": { "type": "string", "xml": { "name": "ptrTTL", "attribute": false, "wrapped": false } }, "publishA": { "type": "string", "description": "A resource record option (Always | None | Push Only).", "xml": { "name": "publishA", "attribute": false, "wrapped": false } }, "publishPTR": { "type": "string", "description": "PTR resource record option (Always | None | Push Only).", "xml": { "name": "publishPTR", "attribute": false, "wrapped": false } }, "dhcpClientClass": { "type": "string", "xml": { "name": "dhcpClientClass", "attribute": false, "wrapped": false } }, "isUpdate": { "type": "string", "xml": { "name": "isUpdate", "attribute": false, "wrapped": false } }, "isAddSelected": { "type": "string", "xml": { "name": "isAddSelected", "attribute": false, "wrapped": false } }, "isCheckDupName": { "type": "string", "xml": { "name": "isCheckDupName", "attribute": false, "wrapped": false } }, "isCheckOnlyFQDNDups": { "type": "string", "xml": { "name": "isCheckOnlyFQDNDups", "attribute": false, "wrapped": false } }, "isSwapAliasAndObjectName": { "type": "string", "xml": { "name": "isSwapAliasAndObjectName", "attribute": false, "wrapped": false } }, "localManualFlag": { "type": "string", "xml": { "name": "localManualFlag", "attribute": false, "wrapped": false } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getV4Address" }, "task": true }, { "name": "deleteASingleRr", "summary": "deleteASingleRr", "description": "Delete a single RR", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteASingleRr" }, "task": true }, { "name": "deleteRRbyInfraTypebyNameOrAddress", "summary": "deleteRRbyInfraTypebyNameOrAddress", "description": "Delete All RRs by infraType and by name or address. The trailing slash is required.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteRRbyInfraTypebyNameOrAddress" }, "task": true }, { "name": "deleteRRsbyNameOrAddress", "summary": "deleteRRsbyNameOrAddress", "description": "Delete All RRs by name or address. The trailing slash is required.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteRRsbyNameOrAddress" }, "task": true }, { "name": "getRRByName", "summary": "getRRByName", "description": "Search RR by name or address.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "title": "RRRec", "type": "object", "properties": { "owner": { "type": "string", "description": "Owner name for the resource record.", "xml": { "name": "owner", "attribute": false, "wrapped": false } }, "classType": { "type": "string", "description": "Class type of records pertains to a type of network or software.", "xml": { "name": "classType", "attribute": false, "wrapped": false } }, "rrType": { "type": "string", "description": "Type of resource record.", "xml": { "name": "rrType", "attribute": false, "wrapped": false } }, "data1": { "type": "string", "description": "The data associated with the specific resource record type.", "xml": { "name": "data1", "attribute": false, "wrapped": false } }, "publishing": { "type": "string", "description": "Publishing type.", "xml": { "name": "publishing", "attribute": false, "wrapped": false } }, "ttl": { "type": "string", "description": "The length of time (in seconds) the name server will hold this information. If no TTL is defined, the value is inherited from the zone.", "xml": { "name": "ttl", "attribute": false, "wrapped": false } }, "infraType": { "type": "string", "description": "Type of infrastructure: OBJECT|V6ADDRESS|ZONE|V4REVERSEZONE|V6REVERSEZONE", "xml": { "name": "infraType", "attribute": false, "wrapped": false } }, "infraFQDN": { "type": "string", "description": "Infrastrucutre FQDN.", "xml": { "name": "infraFQDN", "attribute": false, "wrapped": false } }, "data2": { "type": "string", "description": "The data associated with the specific resource record type.", "xml": { "name": "data2", "attribute": false, "wrapped": false } }, "data3": { "type": "string", "description": "The data associated with the specific resource record type.", "xml": { "name": "data3", "attribute": false, "wrapped": false } }, "data4": { "type": "string", "description": "The data associated with the specific resource record type.", "xml": { "name": "data4", "attribute": false, "wrapped": false } }, "infraAddr": { "type": "string", "description": "Address of infrastructure.", "xml": { "name": "infraAddr", "attribute": false, "wrapped": false } }, "isCreatingReverseZoneRR": { "type": "boolean", "description": "When creating or updating PTR resource record in Object/Node level, if this property is set to true, the PTR resource record will be created in Reverse zone. Otherwise, resource record will be created in Object as normally. Default value of this property is false. This property will be hidden when users get resource record.", "xml": { "name": "isCreatingReverseZoneRR", "attribute": false, "wrapped": false } } }, "description": "RR model", "xml": { "name": "RRRec", "attribute": false, "wrapped": false } }, "description": "" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getRRByName" }, "task": true }, { "name": "addRR", "summary": "addRR", "description": "Creates a new RR", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/addRR" }, "task": true }, { "name": "deleteRR", "summary": "DeleteRR", "description": "Delete All RRs or Delete Single RR using request body", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteRR" }, "task": true }, { "name": "updateRR", "summary": "updateRR", "description": "Update a RR", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/updateRR" }, "task": true }, { "name": "deleteSelectedV4address", "summary": "DeleteSelectedV4address", "description": "Delete selected V4 address by address", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteSelectedV4address" }, "task": true }, { "name": "selectedV4addressWithRange", "summary": "selectedV4addressWithRange", "description": "Get allows to select an IPv4 from a specific IPv4 subnet or Get next Ipv4 address (getting a next address from a subnet can take an optional set of start/end address pairs)", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "NextV4AddrRec", "type": "object", "properties": { "objectAddr": { "type": "string", "xml": { "name": "objectAddr", "attribute": false, "wrapped": false } } }, "description": "NextV4AddrRec model", "xml": { "name": "NextV4AddrRec", "attribute": false, "wrapped": false } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/selectedV4addressWithRange" }, "task": true }, { "name": "deleteSelectedV6address", "summary": "DeleteSelectedV6address", "description": "Delete selected V6 address by address", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteSelectedV6address" }, "task": true }, { "name": "selectedV6addressWithRange", "summary": "selectedV6addressWithRange", "description": "Get allows you to get the detailed information for one IPv6 address. Get next Ipv6address (getting a next address from a subnet can take an optional set of start/end address pairs)", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "V6GetIpAddressRec", "type": "object", "properties": { "ipV6AddrStr": { "type": "string", "xml": { "name": "ipV6AddrStr", "attribute": false, "wrapped": false } } }, "description": "V6GetIpAddressRec model", "xml": { "name": "V6GetIpAddressRec", "attribute": false, "wrapped": false } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/selectedV6addressWithRange" }, "task": true }, { "name": "addZone", "summary": "addZone", "description": "Create a new DNS zone", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/addZone" }, "task": true }, { "name": "modifyZone", "summary": "modifyZone", "description": "Modify a global zone.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/modifyZone" }, "task": true }, { "name": "searchZone", "summary": "searchZone", "description": "Search zones by name. It just return basic information of Dns zone such as name, email, defaultTtl, exprireTime, nagativeCacheTtl, refreshTime and retryTime", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "title": "DNSZoneRec", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the zone.", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "newName": { "type": "string", "description": "New name of the zone. This is used for updating a new name for a zone.", "xml": { "name": "newName", "attribute": false, "wrapped": false } }, "parentAddress": { "type": "string", "description": "Parent address of the splitted reverse zone.", "xml": { "name": "parentAddress", "attribute": false, "wrapped": false } }, "networkAddress": { "type": "string", "description": "Network address of the reverse zone.", "xml": { "name": "networkAddress", "attribute": false, "wrapped": false } }, "dnsServers": { "type": "array", "items": { "title": "DNSServer", "type": "object", "properties": { "name": { "type": "string", "description": "name", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "role": { "type": "string", "description": "Primary/Secondary DNS Server:\nWith P is for Primary and S is for Secondary", "xml": { "name": "role", "attribute": false, "wrapped": false } }, "secureUpdate": { "type": "boolean", "description": "1 is turn on the flag of sending secure update 0 is not", "xml": { "name": "secureUpdate", "attribute": false, "wrapped": false } } }, "description": "Name of DNS server" }, "description": "", "xml": { "attribute": false, "wrapped": false } }, "defaultTtl": { "type": "integer", "description": "DNS default TTL.", "xml": { "name": "defaultTtl", "attribute": false, "wrapped": false } }, "email": { "type": "string", "description": "Email contact.", "xml": { "name": "email", "attribute": false, "wrapped": false } }, "expireTime": { "type": "integer", "description": "Email contact.", "xml": { "name": "expireTime", "attribute": false, "wrapped": false } }, "negativeCacheTtl": { "type": "integer", "description": "DNS negative cache TTL.", "xml": { "name": "negativeCacheTtl", "attribute": false, "wrapped": false } }, "postfixZoneExtension": { "type": "string", "description": "DNS postfix extension.", "xml": { "name": "postfixZoneExtension", "attribute": false, "wrapped": false } }, "prefixZoneExtension": { "type": "string", "description": "DNS prefix extention.", "xml": { "name": "prefixZoneExtension", "attribute": false, "wrapped": false } }, "refreshTime": { "type": "integer", "description": "DNS refresh time.", "xml": { "name": "refreshTime", "attribute": false, "wrapped": false } }, "retryTime": { "type": "integer", "description": "DNS retry time.", "xml": { "name": "retryTime", "attribute": false, "wrapped": false } }, "udas": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "groups": { "title": "UdaGroup", "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "dnsZoneOptions": { "type": "array", "items": { "title": "DNSZoneOptionGroups", "type": "object", "properties": { "name": { "type": "string", "description": "name", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "option": { "type": "array", "items": { "title": "DNSZoneOption", "type": "object", "properties": { "name": { "type": "string", "description": "name", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "description": "value", "xml": { "name": "value", "attribute": false, "wrapped": false } }, "subOption": { "type": "array", "items": { "title": "DNSZoneSubOption", "type": "object", "properties": { "name": { "type": "string", "description": "name", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "description": "value", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } }, "description": "This section defines a group of operations for adding a global zone. Different messages, \nand capabilities, are provided to handle the adding. Add, Get and Update actions support \nare supported." }, "description": "" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/searchZone" }, "task": true }, { "name": "getZone", "summary": "getZone", "description": "Get full profile of a Dns zone by name", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "DNSZoneRec", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the zone.", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "newName": { "type": "string", "description": "New name of the zone. This is used for updating a new name for a zone.", "xml": { "name": "newName", "attribute": false, "wrapped": false } }, "parentAddress": { "type": "string", "description": "Parent address of the splitted reverse zone.", "xml": { "name": "parentAddress", "attribute": false, "wrapped": false } }, "networkAddress": { "type": "string", "description": "Network address of the reverse zone.", "xml": { "name": "networkAddress", "attribute": false, "wrapped": false } }, "dnsServers": { "type": "array", "items": { "title": "DNSServer", "type": "object", "properties": { "name": { "type": "string", "description": "name", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "role": { "type": "string", "description": "Primary/Secondary DNS Server:\nWith P is for Primary and S is for Secondary", "xml": { "name": "role", "attribute": false, "wrapped": false } }, "secureUpdate": { "type": "boolean", "description": "1 is turn on the flag of sending secure update 0 is not", "xml": { "name": "secureUpdate", "attribute": false, "wrapped": false } } }, "description": "Name of DNS server" }, "description": "", "xml": { "attribute": false, "wrapped": false } }, "defaultTtl": { "type": "integer", "description": "DNS default TTL.", "xml": { "name": "defaultTtl", "attribute": false, "wrapped": false } }, "email": { "type": "string", "description": "Email contact.", "xml": { "name": "email", "attribute": false, "wrapped": false } }, "expireTime": { "type": "integer", "description": "Email contact.", "xml": { "name": "expireTime", "attribute": false, "wrapped": false } }, "negativeCacheTtl": { "type": "integer", "description": "DNS negative cache TTL.", "xml": { "name": "negativeCacheTtl", "attribute": false, "wrapped": false } }, "postfixZoneExtension": { "type": "string", "description": "DNS postfix extension.", "xml": { "name": "postfixZoneExtension", "attribute": false, "wrapped": false } }, "prefixZoneExtension": { "type": "string", "description": "DNS prefix extention.", "xml": { "name": "prefixZoneExtension", "attribute": false, "wrapped": false } }, "refreshTime": { "type": "integer", "description": "DNS refresh time.", "xml": { "name": "refreshTime", "attribute": false, "wrapped": false } }, "retryTime": { "type": "integer", "description": "DNS retry time.", "xml": { "name": "retryTime", "attribute": false, "wrapped": false } }, "udas": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "groups": { "title": "UdaGroup", "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "dnsZoneOptions": { "type": "array", "items": { "title": "DNSZoneOptionGroups", "type": "object", "properties": { "name": { "type": "string", "description": "name", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "option": { "type": "array", "items": { "title": "DNSZoneOption", "type": "object", "properties": { "name": { "type": "string", "description": "name", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "description": "value", "xml": { "name": "value", "attribute": false, "wrapped": false } }, "subOption": { "type": "array", "items": { "title": "DNSZoneSubOption", "type": "object", "properties": { "name": { "type": "string", "description": "name", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "description": "value", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } }, "description": "This section defines a group of operations for adding a global zone. Different messages, \nand capabilities, are provided to handle the adding. Add, Get and Update actions support \nare supported." } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getZone" }, "task": true }, { "name": "deleteZone", "summary": "deleteZone", "description": "Delete a global zone by name. The trailing slash is required.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteZone" }, "task": true }, { "name": "addV6BlockToPool", "summary": "addV6BlockToPool", "description": "Add V6 Block to V6 Pool.\n*Note:* Should not test this API on Swagger. Please use another REST Client (cURL, Postman).", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/addV6BlockToPool" }, "task": true }, { "name": "modifyV6Block", "summary": "modifyV6Block", "description": "Modify V6 Block", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/modifyV6Block" }, "task": true }, { "name": "searchV6Block", "summary": "searchV6Block", "description": "Search V6 Block by name or address - Support search wildcard.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "title": "V6BlockRec", "type": "object", "properties": { "name": { "type": "string", "description": "Block", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "address": { "type": "string", "description": "IPv6 address", "xml": { "name": "address", "attribute": false, "wrapped": false } }, "prefixLength": { "type": "integer", "description": "Length of the seed block", "xml": { "name": "prefixLength", "attribute": false, "wrapped": false } }, "minPrefix": { "type": "integer", "description": "Smallest block that can be assigned", "xml": { "name": "minPrefix", "attribute": false, "wrapped": false } }, "maxPrefix": { "type": "integer", "description": "Largest block that can be assigned", "xml": { "name": "maxPrefix", "attribute": false, "wrapped": false } }, "defaultPrefix": { "type": "integer", "description": "Default size of the block assigned", "xml": { "name": "defaultPrefix", "attribute": false, "wrapped": false } }, "algorithmType": { "type": "string", "description": "BEST_FIT_FROM_START | BEST_FIT_FROM_END | SPARSE | CONTIGUOUS_SPARSE", "xml": { "name": "algorithmType", "attribute": false, "wrapped": false } }, "poolName": { "type": "string", "description": "Name of the pool", "xml": { "name": "poolName", "attribute": false, "wrapped": false } }, "createType": { "type": "integer", "description": "Keep value as 1 which refers to user initiated operation. It's required when create a V6Block", "xml": { "name": "createType", "attribute": false, "wrapped": false } }, "createReverseZone": { "type": "boolean", "description": "true for create V6 Reverse Zone and vice versa (default is true)." }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } }, "groups": { "type": "array", "items": { "title": "UdaGroup", "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/searchV6Block" }, "task": true }, { "name": "getV6BlockByUUID", "summary": "getV6BlockByUUID", "description": "Get V6 Block by UUID", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "V6BlockRec", "type": "object", "properties": { "name": { "type": "string", "description": "Block", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "address": { "type": "string", "description": "IPv6 address", "xml": { "name": "address", "attribute": false, "wrapped": false } }, "prefixLength": { "type": "integer", "description": "Length of the seed block", "xml": { "name": "prefixLength", "attribute": false, "wrapped": false } }, "minPrefix": { "type": "integer", "description": "Smallest block that can be assigned", "xml": { "name": "minPrefix", "attribute": false, "wrapped": false } }, "maxPrefix": { "type": "integer", "description": "Largest block that can be assigned", "xml": { "name": "maxPrefix", "attribute": false, "wrapped": false } }, "defaultPrefix": { "type": "integer", "description": "Default size of the block assigned", "xml": { "name": "defaultPrefix", "attribute": false, "wrapped": false } }, "algorithmType": { "type": "string", "description": "BEST_FIT_FROM_START | BEST_FIT_FROM_END | SPARSE | CONTIGUOUS_SPARSE", "xml": { "name": "algorithmType", "attribute": false, "wrapped": false } }, "poolName": { "type": "string", "description": "Name of the pool", "xml": { "name": "poolName", "attribute": false, "wrapped": false } }, "createType": { "type": "integer", "description": "Keep value as 1 which refers to user initiated operation. It's required when create a V6Block", "xml": { "name": "createType", "attribute": false, "wrapped": false } }, "createReverseZone": { "type": "boolean", "description": "true for create V6 Reverse Zone and vice versa (default is true)." }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } }, "groups": { "type": "array", "items": { "title": "UdaGroup", "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getV6BlockByUUID" }, "task": true }, { "name": "deleteV6BlockByBlockInfo", "summary": "deleteV6BlockByBlockInfo", "description": "Delete V6 Block by UUID or Name or Name and Pool Path.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteV6BlockByBlockInfo" }, "task": true }, { "name": "deleteV6BlockByAddress", "summary": "deleteV6BlockByAddress", "description": "Delete V6 Block by Address.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteV6BlockByAddress" }, "task": true }, { "name": "assignV6Block", "summary": "assignV6Block", "description": "Assign V6 Block", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/assignV6Block" }, "task": true }, { "name": "searchV6Range", "summary": "searchV6Range", "description": "Search an IPv6 range by name or address.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "title": "V6RangeRec", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "startAddress": { "type": "string", "xml": { "name": "startAddress", "attribute": false, "wrapped": false } }, "newStartAddress": { "type": "string", "xml": { "name": "newStartAddress", "attribute": false, "wrapped": false } }, "rangePrefixLength": { "type": "integer", "xml": { "name": "rangePrefixLength", "attribute": false, "wrapped": false } }, "rangeType": { "title": "V6RangeType", "type": "string", "example": "DYNAMIC" }, "standPrimDHCPServer": { "type": "string", "xml": { "name": "standPrimDHCPServer", "attribute": false, "wrapped": false } }, "failoverSecondDHCPServer": { "type": "string", "xml": { "name": "failoverSecondDHCPServer", "attribute": false, "wrapped": false } }, "optTemplate": { "type": "string", "xml": { "name": "optTemplate", "attribute": false, "wrapped": false } }, "addressSelection": { "title": "V6AddressSelectionType", "type": "string", "example": "NEXT_AVAILABLE" }, "subnetName": { "type": "string", "xml": { "name": "subnetName", "attribute": false, "wrapped": false } }, "subnetAddress": { "type": "string", "xml": { "name": "subnetAddress", "attribute": false, "wrapped": false } }, "subnetPrefixLength": { "type": "integer", "xml": { "name": "subnetPrefixLength", "attribute": false, "wrapped": false } }, "dhcpParams": { "title": "V6DhcpOptionsRec", "type": "object", "properties": { "informationRefreshTime": { "type": "string", "xml": { "name": "informationRefreshTime", "attribute": false, "wrapped": false } }, "preferredLifeTime": { "type": "string", "xml": { "name": "preferredLifeTime", "attribute": false, "wrapped": false } }, "rebindingTime": { "type": "string", "xml": { "name": "rebindingTime", "attribute": false, "wrapped": false } }, "renewalTime": { "type": "string", "xml": { "name": "renewalTime", "attribute": false, "wrapped": false } }, "validLifeTime": { "type": "string", "xml": { "name": "validLifeTime", "attribute": false, "wrapped": false } }, "bcmcsServerAddressList": { "type": "string", "xml": { "name": "bcmcsServerAddressList", "attribute": false, "wrapped": false } }, "bcmcsServerDomainNameList": { "type": "string", "xml": { "name": "bcmcsServerDomainNameList", "attribute": false, "wrapped": false } }, "dnsRecursiveNameServer": { "type": "string", "xml": { "name": "dnsRecursiveNameServer", "attribute": false, "wrapped": false } }, "domainSearchList": { "type": "string", "xml": { "name": "domainSearchList", "attribute": false, "wrapped": false } }, "nisServers": { "type": "string", "xml": { "name": "nisServers", "attribute": false, "wrapped": false } }, "nispDomainName": { "type": "string", "xml": { "name": "nispDomainName", "attribute": false, "wrapped": false } }, "panaAuthenticationAgents": { "type": "string", "xml": { "name": "panaAuthenticationAgents", "attribute": false, "wrapped": false } }, "posixTimeZone": { "type": "string", "xml": { "name": "posixTimeZone", "attribute": false, "wrapped": false } }, "sipServersDomainNameList": { "type": "string", "xml": { "name": "sipServersDomainNameList", "attribute": false, "wrapped": false } }, "sipServersIpv6AddressList": { "type": "string", "xml": { "name": "sipServersIpv6AddressList", "attribute": false, "wrapped": false } }, "sntpServers": { "type": "string", "xml": { "name": "sntpServers", "attribute": false, "wrapped": false } }, "tzdbTimeZone": { "type": "string", "xml": { "name": "tzdbTimeZone", "attribute": false, "wrapped": false } }, "vendorOptions": { "type": "string", "xml": { "name": "vendorOptions", "attribute": false, "wrapped": false } } } }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } }, "groups": { "type": "array", "items": { "title": "UdaGroup", "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/searchV6Range" }, "task": true }, { "name": "addV6Range", "summary": "addV6Range", "description": "Create an IPv6 range.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/addV6Range" }, "task": true }, { "name": "deleteV6Range", "summary": "deleteV6Range", "description": "Delete an IPv6 range from an IPv6 subnet by name or address.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteV6Range" }, "task": true }, { "name": "modifyV6Range", "summary": "modifyV6Range", "description": "Modify an IPv6 range.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/modifyV6Range" }, "task": true }, { "name": "searchV6Pool", "summary": "searchV6Pool", "description": "Search V6 pool by name.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "title": "V6PoolRec", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the pool.\nYou should not enter a pool name with the last character is \\ \n\nThis will make the parent pool name get parsed incorrectly.", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "newName": { "type": "string", "description": "Name of the pool - support change name of pool.", "xml": { "name": "newName", "attribute": false, "wrapped": false } }, "fullQualifiedParentPoolName": { "type": "string", "description": "full Qualified Parent name of Pool", "xml": { "name": "fullQualifiedParentPoolName", "attribute": false, "wrapped": false } }, "parentName": { "type": "string", "description": "Name of parent pool.\nIf you want the / character to be a part of the pool name, it must be escaped using slash \\ character.", "xml": { "name": "parentName", "attribute": false, "wrapped": false } }, "contact": { "type": "string", "description": "E-mail ID of the contact", "xml": { "name": "contact", "attribute": false, "wrapped": false } }, "assignBlockType": { "type": "string", "description": "APPROVAL_REQUIRED AUTOMATIC_ASSIGNMENT", "xml": { "name": "assignBlockType", "attribute": false, "wrapped": false } }, "notificationType": { "type": "string", "description": "NONE REQUESTS_AND_ASSIGNMENTS REQUESTS_ONLY ASSIGNMENTS_ONLY", "xml": { "name": "notificationType", "attribute": false, "wrapped": false } }, "algorithmType": { "type": "string", "description": "BEST_FIT_FROM_START BEST_FIT_FROM_END SPARSE", "xml": { "name": "algorithmType", "attribute": false, "wrapped": false } }, "minPrefix": { "type": "integer", "description": "Smallest block that can be assigned", "xml": { "name": "minPrefix", "attribute": false, "wrapped": false } }, "maxPrefix": { "type": "integer", "description": "Largest block that can be assigned", "xml": { "name": "maxPrefix", "attribute": false, "wrapped": false } }, "defaultPrefix": { "type": "integer", "description": "Default size of the block assigned", "xml": { "name": "defaultPrefix", "attribute": false, "wrapped": false } }, "blockReqType": { "type": "string", "description": "MANUAL_PARENT_REQUEST AUTOMATIC_PARENT_REQUEST", "xml": { "name": "blockReqType", "attribute": false, "wrapped": false } }, "createReverseZone": { "type": "boolean", "description": "true for create V6 Reverse Zone and vice versa (default is false).", "xml": { "name": "createReverseZone", "attribute": false, "wrapped": false } }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } }, "groups": { "type": "array", "items": { "title": "UdaGroup", "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/searchV6Pool" }, "task": true }, { "name": "getV6PoolByUUID", "summary": "getV6PoolByUUID", "description": "Get V6 Pool by UUID", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "V6PoolRec", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the pool.\nYou should not enter a pool name with the last character is \\ \n\nThis will make the parent pool name get parsed incorrectly.", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "newName": { "type": "string", "description": "Name of the pool - support change name of pool.", "xml": { "name": "newName", "attribute": false, "wrapped": false } }, "fullQualifiedParentPoolName": { "type": "string", "description": "full Qualified Parent name of Pool", "xml": { "name": "fullQualifiedParentPoolName", "attribute": false, "wrapped": false } }, "parentName": { "type": "string", "description": "Name of parent pool.\nIf you want the / character to be a part of the pool name, it must be escaped using slash \\ character.", "xml": { "name": "parentName", "attribute": false, "wrapped": false } }, "contact": { "type": "string", "description": "E-mail ID of the contact", "xml": { "name": "contact", "attribute": false, "wrapped": false } }, "assignBlockType": { "type": "string", "description": "APPROVAL_REQUIRED AUTOMATIC_ASSIGNMENT", "xml": { "name": "assignBlockType", "attribute": false, "wrapped": false } }, "notificationType": { "type": "string", "description": "NONE REQUESTS_AND_ASSIGNMENTS REQUESTS_ONLY ASSIGNMENTS_ONLY", "xml": { "name": "notificationType", "attribute": false, "wrapped": false } }, "algorithmType": { "type": "string", "description": "BEST_FIT_FROM_START BEST_FIT_FROM_END SPARSE", "xml": { "name": "algorithmType", "attribute": false, "wrapped": false } }, "minPrefix": { "type": "integer", "description": "Smallest block that can be assigned", "xml": { "name": "minPrefix", "attribute": false, "wrapped": false } }, "maxPrefix": { "type": "integer", "description": "Largest block that can be assigned", "xml": { "name": "maxPrefix", "attribute": false, "wrapped": false } }, "defaultPrefix": { "type": "integer", "description": "Default size of the block assigned", "xml": { "name": "defaultPrefix", "attribute": false, "wrapped": false } }, "blockReqType": { "type": "string", "description": "MANUAL_PARENT_REQUEST AUTOMATIC_PARENT_REQUEST", "xml": { "name": "blockReqType", "attribute": false, "wrapped": false } }, "createReverseZone": { "type": "boolean", "description": "true for create V6 Reverse Zone and vice versa (default is false).", "xml": { "name": "createReverseZone", "attribute": false, "wrapped": false } }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } }, "groups": { "type": "array", "items": { "title": "UdaGroup", "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "title": "NameValue", "type": "object", "properties": { "name": { "type": "string", "xml": { "name": "name", "attribute": false, "wrapped": false } }, "value": { "type": "string", "xml": { "name": "value", "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } }, "description": "", "xml": { "attribute": false, "wrapped": false } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getV6PoolByUUID" }, "task": true }, { "name": "addV6Pool", "summary": "addV6Pool", "description": "Create V6 Pool. It will return the UUID.\n*Note:* Should not test this API on Swagger. Please use another REST Client (cURL, Postman).", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/addV6Pool" }, "task": true }, { "name": "modifyV6Pool", "summary": "modifyV6Pool", "description": "Modify V6 Pool", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/modifyV6Pool" }, "task": true }, { "name": "deleteV6Pool", "summary": "deleteV6Pool", "description": "Delete V6 Pool. You can delete V6 Pool by pool name (FQDN) or UUID", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteV6Pool" }, "task": true }, { "name": "modifyV4Network", "summary": "Update V4 network", "description": "Modify V4 network name, warning type, warning percent...", "input": [ { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"address\": \"string\", \"maskLength\": 123, \"email\": \"string\", \"warningPercent\": 123, \"warningType\": \"string\", \"name\": \"string\", \"dnsServer\": \"string\", \"cidr\": \"string\", \"optionalAttributeList\": {\"udas\": [{\"name\": \"string\", \"value\": \"string\"}], \"groups\": [{\"name\": \"string\", \"udas\": [{\"name\": \"string\", \"value\": \"string\"}]}]}, \"optionalAddrRangeList\": {\"addrRange\": [{\"startAddress\": \"string\", \"endAddress\": \"string\"}]}}", "required": true, "schema": { "description": "V4 Network model", "required": [ "address", "maskLength", "email", "warningPercent", "warningType" ], "properties": { "address": { "type": "string", "description": "V4 Network address" }, "maskLength": { "type": "integer", "description": "Mask length of v4 network. This field is required when create, but must not be changed when modify" }, "email": { "type": "string", "description": "email to contact. This field is required when create, but must not be changed when modify" }, "warningPercent": { "type": "integer", "description": "Warning percent" }, "warningType": { "type": "string", "description": "warnning type (1 or 2 or 3)" }, "name": { "type": "string", "description": "Network name" }, "dnsServer": { "type": "string", "description": "Name of DNS Server. This field is required when create, but must not be changed when modify" }, "cidr": { "type": "string", "description": "CIDR (Y or N). This field is required when create, but must not be changed when modify" }, "optionalAttributeList": { "type": "object", "properties": { "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } }, "optionalAddrRangeList": { "type": "object", "properties": { "addrRange": { "type": "array", "items": { "type": "object", "properties": { "startAddress": { "type": "string" }, "endAddress": { "type": "string" } } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyV4Network" }, "task": true }, { "name": "splitV4Subnet", "summary": "Split V4 Subnet", "description": "Split V4 subnet.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"fromSubnet\": \"string\", \"toSubnets\": \"array\", \"newMask\": \"string\"}", "required": true, "schema": { "type": "object", "required": [ "fromSubnet", "toSubnets", "newMask" ], "properties": { "fromSubnet": { "type": "string" }, "toSubnets": { "type": "array", "items": { "type": "string" } }, "newMask": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/splitV4Subnet" }, "task": true }, { "name": "joinV4Subnet", "summary": "Join V4 Subnet", "description": "Join V4 subnet.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"fromSubnets\": \"array\", \"toSubnet\": \"string\", \"newMask\": \"string\", \"subnetProperties\": \"string\"}", "required": true, "schema": { "type": "object", "required": [ "fromSubnets", "toSubnet", "newMask" ], "properties": { "fromSubnets": { "type": "array", "items": { "type": "string" } }, "toSubnet": { "type": "string" }, "newMask": { "type": "string" }, "subnetProperties": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/joinV4Subnet" }, "task": true }, { "name": "generateObjectName", "summary": "Generate hostname automatically", "description": "Generate hostname automatically", "input": [ { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "objectClass", "type": "string", "info": "Object class: string", "required": true, "schema": { "title": "objectClass", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/generateObjectName" }, "task": true }, { "name": "updateV4Addresses", "summary": "Update V4 Addresses", "description": "Modify V4 Addresses", "input": [ { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"objectAddr\": \"array\", \"v4AddrRec\": {\"objectAddr\": \"string\", \"subnetAddr\": \"string\", \"objectName\": \"string\", \"objectClass\": \"string\", \"domainName\": \"string\", \"expiredDate\": \"string\", \"serverType\": \"string\", \"applName\": \"string\", \"objectTag\": \"string\", \"roomId\": \"string\", \"manufacturer\": \"string\", \"modelType\": \"string\", \"serialNumber\": \"string\", \"assetNumber\": \"string\", \"hostId\": \"string\", \"purchaseDate\": \"string\", \"objectDesc\": \"string\", \"hubName\": \"string\", \"slotName\": \"string\", \"portNumber\": \"string\", \"locationId\": \"string\", \"street1\": \"string\", \"street2\": \"string\", \"city\": \"string\", \"state\": \"string\", \"zip\": \"string\", \"country\": \"string\", \"contactId\": \"string\", \"contactLastName\": \"string\", \"contactFirstName\": \"string\", \"contactEmail\": \"string\", \"contactPhone\": \"string\", \"contactPager\": \"string\", \"routerGroup\": \"string\", \"dynamicConfig\": \"string\", \"macAddr\": \"string\", \"tftpServer\": \"string\", \"bootFileName\": \"string\", \"hardwareType\": \"string\", \"aliases\": \"string\", \"mailForwarders\": \"string\", \"mailHosts\": \"string\", \"hubSlots\": \"string\", \"dnsServers\": \"string\", \"timeServers\": \"string\", \"defaultRouters\": \"string\", \"userClasses\": \"string\", \"users\": \"string\", \"nameService\": \"string\", \"dynamicDnsUpdate\": \"string\", \"dhcpServer\": \"string\", \"dhcpOptionTemplate\": \"string\", \"dhcpPolicyTemplate\": \"string\", \"leaseTime\": \"string\", \"ttlTime\": \"string\", \"vendorClass\": \"string\", \"clientId\": \"string\", \"dualProtocol\": \"string\", \"decNetArea\": \"string\", \"decNetAddr\": \"string\", \"decNetNode\": \"string\", \"talkType\": \"string\", \"ipxNode\": \"string\", \"ipxNetworkNumber\": \"string\", \"netBiosDomain\": \"string\", \"netBiosName\": \"string\", \"usageBillServices\": \"string\", \"usageBillLocation\": \"string\", \"usageBillUserGroup\": \"string\", \"usageBillObjectClass\": \"string\", \"allowModifyDynamicRRs\": \"string\", \"tombstoned\": \"string\", \"externalComment\": \"string\", \"externalTimestamp\": \"string\", \"manualFlag\": \"string\", \"nodeId\": \"string\", \"uniqueNodeId\": \"string\", \"aTTL\": \"string\", \"ptrTTL\": \"string\", \"publishA\": \"string\", \"publishPTR\": \"string\", \"dhcpClientClass\": \"string\", \"isUpdate\": \"string\", \"isAddSelected\": \"string\", \"isCheckDupName\": \"string\", \"isCheckOnlyFQDNDups\": \"string\", \"isSwapAliasAndObjectName\": \"string\", \"localManualFlag\": \"string\"}}", "required": true, "schema": { "type": "object", "required": [ "objectAddr" ], "properties": { "objectAddr": { "type": "array", "items": { "type": "string" } }, "v4AddrRec": { "type": "object", "required": [ "objectAddr", "subnetAddr" ], "properties": { "objectAddr": { "type": "string", "description": "The hostname of the object. Not fully-qualified." }, "subnetAddr": { "type": "string" }, "objectName": { "type": "string" }, "objectClass": { "type": "string", "description": "ObjectClass is a value of Workstation, X-terminal, PC, Printer, Server, Wiring_HUB, Router, Bridge, Terminal_Server, Switch, Legacy_System, Gateway, Test_Equipment, Undefined, Others, Any user-defined object class name." }, "domainName": { "type": "string", "description": "The domain of the object. If no value is provided, the Domain Name is identified as the default domain of the subnet the Object is on." }, "expiredDate": { "type": "string", "description": "The date when a reserved object expires and is no longer reserved." }, "serverType": { "type": "string", "description": "Only applicable if ObjectClass is 'server': TimeServer- If object is a time server, TftpServer- If object is a Tftp server, TftpServer\\&TimeServer- If object is a TftpServer and TimeServer.\n" }, "applName": { "type": "string", "description": "The 'Primary Application' of the object." }, "objectTag": { "type": "string", "description": "Tag field" }, "roomId": { "type": "string", "description": "Room ID field" }, "manufacturer": { "type": "string", "description": "Manufacturer Name" }, "modelType": { "type": "string", "description": "Model Name" }, "serialNumber": { "type": "string", "description": "Serial Number of Object" }, "assetNumber": { "type": "string", "description": "Asset Number of object" }, "hostId": { "type": "string", "description": "Host ID of object" }, "purchaseDate": { "type": "string", "description": "Purchase Date/Time of object. Must be in yyyy-mm-dd format" }, "objectDesc": { "type": "string", "description": "Object Description" }, "hubName": { "type": "string", "description": "Hub Name(s) assigned to object." }, "slotName": { "type": "string", "description": "Slot Name(s) assigned to object." }, "portNumber": { "type": "string", "description": "Port Numbers assigned to object." }, "locationId": { "type": "string", "description": "The Location ID. If no Location ID is specified, an attempt is made to match the record EXACTLY with the Street1, Street2, City, State, Zip and/or Country information that is supplied. If a match is not found, a new record is added without an ID." }, "street1": { "type": "string", "description": "Street1 field of the location." }, "street2": { "type": "string", "description": "Street2 field of the location." }, "city": { "type": "string", "description": "City of the location." }, "state": { "type": "string", "description": "State of the location." }, "zip": { "type": "string", "description": "Zip of the location." }, "country": { "type": "string", "description": "Country of the location." }, "contactId": { "type": "string", "description": "The Contact ID. If no Contact ID is specified, an attempt is made to match the record EXACTLY with the ContactLastName and ContactFirstName information that is supplied. If no match is found, a new record is added without an ID." }, "contactLastName": { "type": "string", "description": "Contact last name." }, "contactFirstName": { "type": "string", "description": "Contact first name." }, "contactEmail": { "type": "string", "description": "Contact email address." }, "contactPhone": { "type": "string", "description": "Contact phone number." }, "contactPager": { "type": "string", "description": "Contact pager number." }, "routerGroup": { "type": "string", "description": "Router Group of object. Only applicable if the object class is \"router\"." }, "dynamicConfig": { "type": "string", "description": "Dynamic Configuration of Object include Blank - Static object, None- Dynamic (none), M-DHCP- Manual DHCP, A-DHCP- Automatic DHCP, D-DHCP- Dynamic DHCP, M-BOOTP- Manual Bootp, A-BOOTP- Automatic Bootp, Reserved - To reserve an object (the IP must be unused)" }, "macAddr": { "type": "string", "description": "The Mac Address of Object. Exclude the colons (:) when entering a MAC address." }, "tftpServer": { "type": "string", "description": "TFTP Server of object. Only applicable if object type is M-BOOTP." }, "bootFileName": { "type": "string", "description": "Bootfile name of object. Only applicable if object type is MBOOTP." }, "hardwareType": { "type": "string", "description": "NONE, ETHERNET, TOKEN_RING, AX25, PRONET, CHAOS, IEEE802, ARCNET." }, "aliases": { "type": "string" }, "mailForwarders": { "type": "string" }, "mailHosts": { "type": "string" }, "hubSlots": { "type": "string" }, "dnsServers": { "type": "string", "description": "DNS Servers attached to this object. If multiple, separate by space. Only applicable for M-BOOTP objects." }, "timeServers": { "type": "string", "description": "Time Servers attached to this object. If multiple, separate by space. Only applicable for M-BOOTP objects." }, "defaultRouters": { "type": "string", "description": "IP Address(es) of Default routers, separated by space if multiples." }, "userClasses": { "type": "string", "description": "Specific categories of user options. To enter one or more user classes for this object, enclose a list of users in double quotes (for example, user1, user2, user3)." }, "users": { "type": "string" }, "nameService": { "type": "string", "description": "Name Services selection:\n- No: Name Services checked off.\n- Yes: Name Services checked on.\n- A: Name Services checked on, A record checked on.\n- PTR: Name Services checked on, PTR record checked on.\n- A PTR: Name Services checked on, A record checked on, PTR record checked on.\n" }, "dynamicDnsUpdate": { "type": "string", "description": "Dynamic Update selection:\n - A- Dynamic updates for A records.\n - PTR- Dynamic updates for PTR records.\n - CNAME- Dynamic updates for CNAME records.\n - MX- Dynamic updates for MX records.\n" }, "dhcpServer": { "type": "string", "description": "The DHCP Server assigned to this object. Only applicable for dynamic objects." }, "dhcpOptionTemplate": { "type": "string", "description": "The DHCP Option Template assigned to this object. Only applicable for dynamic objects." }, "dhcpPolicyTemplate": { "type": "string", "description": "The DHCP Policy template assigned to this object. Only applicable for dynamic objects." }, "leaseTime": { "type": "string", "description": "The lease time (in seconds assigned) to this object. Only applicable for dynamic objects." }, "ttlTime": { "type": "string", "description": "Time to live (TTL) value, in seconds. Since 0 is a valid value, a value of-1 indicates no TTL set." }, "vendorClass": { "type": "string", "description": "The Vendor Class assigned to this object. Only applicable for dynamic objects." }, "clientId": { "type": "string", "description": "The unique value assigned to DHCP client." }, "dualProtocol": { "type": "string" }, "decNetArea": { "type": "string", "description": "DECNet Area. (Valid values are 1-63) Only applicable if Dual Protocol is set to DECNet. The DECNet Address is calculated on the input in the DECNetArea and the DECNet Node." }, "decNetAddr": { "type": "string", "description": "DECNet Address. (Valid values are 1-1024) Only applicable if Dual Protocol set to DECNet. The DECNet Address is calculated on the input in the DECNetArea and the DECNet Node." }, "decNetNode": { "type": "string" }, "talkType": { "type": "string" }, "ipxNode": { "type": "string", "description": "IPX Node. Only applicable if Dual Protocol is set to IPX." }, "ipxNetworkNumber": { "type": "string", "description": "IPX Network number. Only applicable if Dual Protocol is set to IPX." }, "netBiosDomain": { "type": "string", "description": "NetBIOS Name. Only applicable when dual protocol is set to NETBIOS." }, "netBiosName": { "type": "string", "description": "NetBIOS Domain. Only applicable when dual protocol set to NETBIOS." }, "usageBillServices": { "type": "string" }, "usageBillLocation": { "type": "string" }, "usageBillUserGroup": { "type": "string" }, "usageBillObjectClass": { "type": "string" }, "allowModifyDynamicRRs": { "type": "string" }, "tombstoned": { "type": "string", "description": "1 indicates that this is a tombstoned external record. 0 indicates that it is not a tombstoned external record.\n" }, "externalComment": { "type": "string", "description": "text (up to 255 characters), a comment indicating the history of this external add." }, "externalTimestamp": { "type": "string", "description": "ExternalTimestamp must be in \"yyyy-mm-dd\" format" }, "manualFlag": { "type": "string", "description": "Determines whether MACAddress/ClientID is set based on its value. If value is 0, MACAddress is set, if value is 1, ClientID is set." }, "nodeId": { "type": "string" }, "uniqueNodeId": { "type": "string" }, "aTTL": { "type": "string" }, "ptrTTL": { "type": "string" }, "publishA": { "type": "string", "description": "A resource record option (Always | None | Push Only)." }, "publishPTR": { "type": "string", "description": "PTR resource record option (Always | None | Push Only)." }, "dhcpClientClass": { "type": "string" }, "isUpdate": { "type": "string" }, "isAddSelected": { "type": "string" }, "isCheckDupName": { "type": "string" }, "isCheckOnlyFQDNDups": { "type": "string" }, "isSwapAliasAndObjectName": { "type": "string" }, "localManualFlag": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateV4Addresses" }, "task": true }, { "name": "searchV4Address", "summary": "Search V4 Address", "description": "Search V4 address UDA value.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "address", "type": "string", "info": "V4 Address: string", "required": false, "schema": { "title": "address", "type": "string" } }, { "name": "name", "type": "string", "info": "V4 Address name: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "udaName", "type": "string", "info": "udaName: string", "required": false, "schema": { "title": "udaName", "type": "string" } }, { "name": "udaValue", "type": "string", "info": "udaValue: string", "required": false, "schema": { "title": "udaValue", "type": "string" } }, { "name": "pageSize", "type": "string", "info": "page size of response: string", "required": false, "schema": { "title": "pageSize", "type": "string" } }, { "name": "pageIndex", "type": "string", "info": "page index of response: string", "required": false, "schema": { "title": "pageIndex", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "required": [ "objectAddr", "subnetAddr" ], "properties": { "objectAddr": { "type": "string", "description": "The hostname of the object. Not fully-qualified." }, "subnetAddr": { "type": "string" }, "objectName": { "type": "string" }, "objectClass": { "type": "string", "description": "ObjectClass is a value of Workstation, X-terminal, PC, Printer, Server, Wiring_HUB, Router, Bridge, Terminal_Server, Switch, Legacy_System, Gateway, Test_Equipment, Undefined, Others, Any user-defined object class name." }, "domainName": { "type": "string", "description": "The domain of the object. If no value is provided, the Domain Name is identified as the default domain of the subnet the Object is on." }, "expiredDate": { "type": "string", "description": "The date when a reserved object expires and is no longer reserved." }, "serverType": { "type": "string", "description": "Only applicable if ObjectClass is 'server': TimeServer- If object is a time server, TftpServer- If object is a Tftp server, TftpServer\\&TimeServer- If object is a TftpServer and TimeServer.\n" }, "applName": { "type": "string", "description": "The 'Primary Application' of the object." }, "objectTag": { "type": "string", "description": "Tag field" }, "roomId": { "type": "string", "description": "Room ID field" }, "manufacturer": { "type": "string", "description": "Manufacturer Name" }, "modelType": { "type": "string", "description": "Model Name" }, "serialNumber": { "type": "string", "description": "Serial Number of Object" }, "assetNumber": { "type": "string", "description": "Asset Number of object" }, "hostId": { "type": "string", "description": "Host ID of object" }, "purchaseDate": { "type": "string", "description": "Purchase Date/Time of object. Must be in yyyy-mm-dd format" }, "objectDesc": { "type": "string", "description": "Object Description" }, "hubName": { "type": "string", "description": "Hub Name(s) assigned to object." }, "slotName": { "type": "string", "description": "Slot Name(s) assigned to object." }, "portNumber": { "type": "string", "description": "Port Numbers assigned to object." }, "locationId": { "type": "string", "description": "The Location ID. If no Location ID is specified, an attempt is made to match the record EXACTLY with the Street1, Street2, City, State, Zip and/or Country information that is supplied. If a match is not found, a new record is added without an ID." }, "street1": { "type": "string", "description": "Street1 field of the location." }, "street2": { "type": "string", "description": "Street2 field of the location." }, "city": { "type": "string", "description": "City of the location." }, "state": { "type": "string", "description": "State of the location." }, "zip": { "type": "string", "description": "Zip of the location." }, "country": { "type": "string", "description": "Country of the location." }, "contactId": { "type": "string", "description": "The Contact ID. If no Contact ID is specified, an attempt is made to match the record EXACTLY with the ContactLastName and ContactFirstName information that is supplied. If no match is found, a new record is added without an ID." }, "contactLastName": { "type": "string", "description": "Contact last name." }, "contactFirstName": { "type": "string", "description": "Contact first name." }, "contactEmail": { "type": "string", "description": "Contact email address." }, "contactPhone": { "type": "string", "description": "Contact phone number." }, "contactPager": { "type": "string", "description": "Contact pager number." }, "routerGroup": { "type": "string", "description": "Router Group of object. Only applicable if the object class is \"router\"." }, "dynamicConfig": { "type": "string", "description": "Dynamic Configuration of Object include Blank - Static object, None- Dynamic (none), M-DHCP- Manual DHCP, A-DHCP- Automatic DHCP, D-DHCP- Dynamic DHCP, M-BOOTP- Manual Bootp, A-BOOTP- Automatic Bootp, Reserved - To reserve an object (the IP must be unused)" }, "macAddr": { "type": "string", "description": "The Mac Address of Object. Exclude the colons (:) when entering a MAC address." }, "tftpServer": { "type": "string", "description": "TFTP Server of object. Only applicable if object type is M-BOOTP." }, "bootFileName": { "type": "string", "description": "Bootfile name of object. Only applicable if object type is MBOOTP." }, "hardwareType": { "type": "string", "description": "NONE, ETHERNET, TOKEN_RING, AX25, PRONET, CHAOS, IEEE802, ARCNET." }, "aliases": { "type": "string" }, "mailForwarders": { "type": "string" }, "mailHosts": { "type": "string" }, "hubSlots": { "type": "string" }, "dnsServers": { "type": "string", "description": "DNS Servers attached to this object. If multiple, separate by space. Only applicable for M-BOOTP objects." }, "timeServers": { "type": "string", "description": "Time Servers attached to this object. If multiple, separate by space. Only applicable for M-BOOTP objects." }, "defaultRouters": { "type": "string", "description": "IP Address(es) of Default routers, separated by space if multiples." }, "userClasses": { "type": "string", "description": "Specific categories of user options. To enter one or more user classes for this object, enclose a list of users in double quotes (for example, user1, user2, user3)." }, "users": { "type": "string" }, "nameService": { "type": "string", "description": "Name Services selection:\n- No: Name Services checked off.\n- Yes: Name Services checked on.\n- A: Name Services checked on, A record checked on.\n- PTR: Name Services checked on, PTR record checked on.\n- A PTR: Name Services checked on, A record checked on, PTR record checked on.\n" }, "dynamicDnsUpdate": { "type": "string", "description": "Dynamic Update selection:\n - A- Dynamic updates for A records.\n - PTR- Dynamic updates for PTR records.\n - CNAME- Dynamic updates for CNAME records.\n - MX- Dynamic updates for MX records.\n" }, "dhcpServer": { "type": "string", "description": "The DHCP Server assigned to this object. Only applicable for dynamic objects." }, "dhcpOptionTemplate": { "type": "string", "description": "The DHCP Option Template assigned to this object. Only applicable for dynamic objects." }, "dhcpPolicyTemplate": { "type": "string", "description": "The DHCP Policy template assigned to this object. Only applicable for dynamic objects." }, "leaseTime": { "type": "string", "description": "The lease time (in seconds assigned) to this object. Only applicable for dynamic objects." }, "ttlTime": { "type": "string", "description": "Time to live (TTL) value, in seconds. Since 0 is a valid value, a value of-1 indicates no TTL set." }, "vendorClass": { "type": "string", "description": "The Vendor Class assigned to this object. Only applicable for dynamic objects." }, "clientId": { "type": "string", "description": "The unique value assigned to DHCP client." }, "dualProtocol": { "type": "string" }, "decNetArea": { "type": "string", "description": "DECNet Area. (Valid values are 1-63) Only applicable if Dual Protocol is set to DECNet. The DECNet Address is calculated on the input in the DECNetArea and the DECNet Node." }, "decNetAddr": { "type": "string", "description": "DECNet Address. (Valid values are 1-1024) Only applicable if Dual Protocol set to DECNet. The DECNet Address is calculated on the input in the DECNetArea and the DECNet Node." }, "decNetNode": { "type": "string" }, "talkType": { "type": "string" }, "ipxNode": { "type": "string", "description": "IPX Node. Only applicable if Dual Protocol is set to IPX." }, "ipxNetworkNumber": { "type": "string", "description": "IPX Network number. Only applicable if Dual Protocol is set to IPX." }, "netBiosDomain": { "type": "string", "description": "NetBIOS Name. Only applicable when dual protocol is set to NETBIOS." }, "netBiosName": { "type": "string", "description": "NetBIOS Domain. Only applicable when dual protocol set to NETBIOS." }, "usageBillServices": { "type": "string" }, "usageBillLocation": { "type": "string" }, "usageBillUserGroup": { "type": "string" }, "usageBillObjectClass": { "type": "string" }, "allowModifyDynamicRRs": { "type": "string" }, "tombstoned": { "type": "string", "description": "1 indicates that this is a tombstoned external record. 0 indicates that it is not a tombstoned external record.\n" }, "externalComment": { "type": "string", "description": "text (up to 255 characters), a comment indicating the history of this external add." }, "externalTimestamp": { "type": "string", "description": "ExternalTimestamp must be in \"yyyy-mm-dd\" format" }, "manualFlag": { "type": "string", "description": "Determines whether MACAddress/ClientID is set based on its value. If value is 0, MACAddress is set, if value is 1, ClientID is set." }, "nodeId": { "type": "string" }, "uniqueNodeId": { "type": "string" }, "aTTL": { "type": "string" }, "ptrTTL": { "type": "string" }, "publishA": { "type": "string", "description": "A resource record option (Always | None | Push Only)." }, "publishPTR": { "type": "string", "description": "PTR resource record option (Always | None | Push Only)." }, "dhcpClientClass": { "type": "string" }, "isUpdate": { "type": "string" }, "isAddSelected": { "type": "string" }, "isCheckDupName": { "type": "string" }, "isCheckOnlyFQDNDups": { "type": "string" }, "isSwapAliasAndObjectName": { "type": "string" }, "localManualFlag": { "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchV4Address" }, "task": true }, { "name": "deleteARrByRrId", "summary": "Delete RR", "description": "Delete a RR by rrId", "input": [ { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "rrId", "type": "number", "info": "rrId of resource record - Required\n Note: Do not support for Route53 resource record: 123", "required": true, "schema": { "title": "rrId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteARrByRrId" }, "task": true }, { "name": "moveV4Object", "summary": "Move an object by IP address.", "description": "Move an object by IP address.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"DNSZoneRec\": [{\"name\": \"string\", \"newName\": \"string\", \"parentAddress\": \"string\", \"networkAddress\": \"string\", \"dnsServers\": [{\"name\": \"string\", \"role\": \"string\", \"secureUpdate\": \"boolean\"}], \"defaultTtl\": 123, \"email\": \"string\", \"expireTime\": 123, \"negativeCacheTtl\": 123, \"postfixZoneExtension\": \"string\", \"prefixZoneExtension\": \"string\", \"refreshTime\": 123, \"retryTime\": 123, \"udas\": {\"name\": \"string\", \"value\": \"string\"}, \"groups\": {\"name\": \"string\", \"udas\": [{\"name\": \"string\", \"value\": \"string\"}]}, \"dnsZoneOptions\": [{\"name\": \"string\", \"option\": [{\"name\": \"string\", \"value\": \"string\", \"subOption\": [{\"name\": \"string\", \"value\": \"string\"}]}]}]}]}", "required": true, "schema": { "type": "object", "properties": { "DNSZoneRec": { "type": "array", "items": { "type": "object", "required": [ "name", "email", "expireTime", "negativeCacheTtl", "refreshTime", "retryTime", "defaultTtl" ], "description": "This section defines a group of operations for adding a global zone. Different messages, \nand capabilities, are provided to handle the adding. Add, Get and Update actions support \nare supported. \n", "properties": { "name": { "type": "string", "description": "Name of the zone.\n" }, "newName": { "type": "string", "description": "New name of the zone. This is used for updating a new name for a zone.\n" }, "parentAddress": { "type": "string", "description": "Parent address of the splitted reverse zone.\n" }, "networkAddress": { "type": "string", "description": "Network address of the reverse zone.\n" }, "dnsServers": { "type": "array", "items": { "type": "object", "description": "Name of DNS server", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "name" }, "role": { "type": "string", "description": "Primary/Secondary DNS Server:\nWith P is for Primary and S is for Secondary\n" }, "secureUpdate": { "type": "boolean", "description": "1 is turn on the flag of sending secure update 0 is not" } } } }, "defaultTtl": { "type": "integer", "description": "DNS default TTL.\n" }, "email": { "type": "string", "description": "Email contact.\n" }, "expireTime": { "type": "integer", "description": "Email contact.\n" }, "negativeCacheTtl": { "type": "integer", "description": "DNS negative cache TTL.\n" }, "postfixZoneExtension": { "type": "string", "description": "DNS postfix extension.\n" }, "prefixZoneExtension": { "type": "string", "description": "DNS prefix extention.\n" }, "refreshTime": { "type": "integer", "description": "DNS refresh time. \n" }, "retryTime": { "type": "integer", "description": "DNS retry time.\n" }, "udas": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "groups": { "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } }, "dnsZoneOptions": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "name" }, "option": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "name" }, "value": { "type": "string", "description": "value" }, "subOption": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "name" }, "value": { "type": "string", "description": "value" } } } } } } } } } } }, "example": { "name": "nokia.com", "dnsServers": [ { "name": "dns.example.com", "role": "P", "secureUpdate": false }, { "name": "dnsSecondary.example.com", "role": "S", "secureUpdate": false }, { "name": "zone1.example.com", "role": "P", "secureUpdate": true }, { "name": "dnsSecondary.example.com", "role": "S", "secureUpdate": false } ], "defaultTtl": 86400, "email": "support@nokia.com", "expireTime": 604800, "negativeCacheTtl": 600, "refreshTime": 21600, "retryTime": 3600, "udas": [ { "name": "at1", "value": "true" }, { "name": "test", "value": "vietnam" } ], "groups": [ { "name": "gr1", "udas": [ { "name": "at1", "value": "false" } ] }, { "name": "gr2", "udas": [ { "name": "testUDA", "value": "false" } ] } ], "dnsZoneOptions": [ { "name": "Extensions", "options": [ { "name": "Prefix of zone db file", "value": "Zone prefix comments" }, { "name": "Postfix of zone db file", "value": "Zone postfix comments" } ] }, { "name": "ALU DNS 6.0 Options", "options": [ { "name": "allow-transfer", "value": "Use Server Value", "subOptions": [ { "name": "other" }, { "name": "ACL Templates" } ] }, { "name": "allow-notify", "value": "Any", "subOptions": [ { "name": "other" }, { "name": "ACL Templates" } ] }, { "name": "zone block of named.conf", "value": "zone block of named.conf comments" }, { "name": "Import External Updates", "value": "True", "subOptions": [ { "name": "CNAME (Canonical Name)", "value": "True" }, { "name": "AAAA (Host IPV6)", "value": "True" }, { "name": "SRV (Server Resource Record)", "value": "True" }, { "name": "A (Host IPV4)", "value": "True" }, { "name": "PTR (Pointer)", "value": "True" }, { "name": "TXT (Text)", "value": "True" } ] }, { "name": "allow-query", "value": "Use Server Value", "subOptions": [ { "name": "other" }, { "name": "ACL Templates" } ] }, { "name": "forwarders", "subOptions": [ { "name": "forward", "value": "Use Server Value" } ] }, { "name": "allow-update", "value": "Use Server Value", "subOptions": [ { "name": "other" }, { "name": "ACL Templates" } ] }, { "name": "notify", "value": "No", "subOptions": [ { "name": "also-notify" } ] } ] } ] } } } }, "example": { "list": [ { "name": "nokiaFirst.com", "dnsServers": [ { "name": "dns.example.com", "role": "P", "secureUpdate": false }, { "name": "dnsSecondary.example.com", "role": "S", "secureUpdate": false }, { "name": "zone1.example.com", "role": "P", "secureUpdate": true }, { "name": "dnsSecondary.example.com", "role": "S", "secureUpdate": false } ], "defaultTtl": 86400, "email": "support@nokia.com", "expireTime": 604800, "negativeCacheTtl": 600, "refreshTime": 21600, "retryTime": 3600, "udas": [ { "name": "at1", "value": "true" }, { "name": "test", "value": "vietnam" } ], "groups": [ { "name": "gr1", "udas": [ { "name": "at1", "value": "false" } ] }, { "name": "gr2", "udas": [ { "name": "testUDA", "value": "false" } ] } ], "dnsZoneOptions": [ { "name": "Extensions", "options": [ { "name": "Prefix of zone db file", "value": "Zone prefix comments" }, { "name": "Postfix of zone db file", "value": "Zone postfix comments" } ] }, { "name": "ALU DNS 6.0 Options", "options": [ { "name": "allow-transfer", "value": "Use Server Value", "subOptions": [ { "name": "other" }, { "name": "ACL Templates" } ] }, { "name": "allow-notify", "value": "Any", "subOptions": [ { "name": "other" }, { "name": "ACL Templates" } ] }, { "name": "zone block of named.conf", "value": "zone block of named.conf comments" }, { "name": "Import External Updates", "value": "True", "subOptions": [ { "name": "CNAME (Canonical Name)", "value": "True" }, { "name": "AAAA (Host IPV6)", "value": "True" }, { "name": "SRV (Server Resource Record)", "value": "True" }, { "name": "A (Host IPV4)", "value": "True" }, { "name": "PTR (Pointer)", "value": "True" }, { "name": "TXT (Text)", "value": "True" } ] }, { "name": "allow-query", "value": "Use Server Value", "subOptions": [ { "name": "other" }, { "name": "ACL Templates" } ] }, { "name": "forwarders", "subOptions": [ { "name": "forward", "value": "Use Server Value" } ] }, { "name": "allow-update", "value": "Use Server Value", "subOptions": [ { "name": "other" }, { "name": "ACL Templates" } ] }, { "name": "notify", "value": "No", "subOptions": [ { "name": "also-notify" } ] } ] } ] }, { "name": "nokiaSecond.com", "dnsServers": [ { "name": "dns.example.com", "role": "P", "secureUpdate": false }, { "name": "dnsSecondary.example.com", "role": "S", "secureUpdate": false }, { "name": "zone1.example.com", "role": "P", "secureUpdate": true }, { "name": "dnsSecondary.example.com", "role": "S", "secureUpdate": false } ], "defaultTtl": 86400, "email": "support@nokia.com", "expireTime": 604800, "negativeCacheTtl": 600, "refreshTime": 21600, "retryTime": 3600, "udas": [ { "name": "at1", "value": "true" }, { "name": "test", "value": "vietnam" } ], "groups": [ { "name": "gr1", "udas": [ { "name": "at1", "value": "false" } ] }, { "name": "gr2", "udas": [ { "name": "testUDA", "value": "false" } ] } ], "dnsZoneOptions": [ { "name": "Extensions", "options": [ { "name": "Prefix of zone db file", "value": "Zone prefix comments" }, { "name": "Postfix of zone db file", "value": "Zone postfix comments" } ] }, { "name": "ALU DNS 6.0 Options", "options": [ { "name": "allow-transfer", "value": "Use Server Value", "subOptions": [ { "name": "other" }, { "name": "ACL Templates" } ] }, { "name": "allow-notify", "value": "Any", "subOptions": [ { "name": "other" }, { "name": "ACL Templates" } ] }, { "name": "zone block of named.conf", "value": "zone block of named.conf comments" }, { "name": "Import External Updates", "value": "True", "subOptions": [ { "name": "CNAME (Canonical Name)", "value": "True" }, { "name": "AAAA (Host IPV6)", "value": "True" }, { "name": "SRV (Server Resource Record)", "value": "True" }, { "name": "A (Host IPV4)", "value": "True" }, { "name": "PTR (Pointer)", "value": "True" }, { "name": "TXT (Text)", "value": "True" } ] }, { "name": "allow-query", "value": "Use Server Value", "subOptions": [ { "name": "other" }, { "name": "ACL Templates" } ] }, { "name": "forwarders", "subOptions": [ { "name": "forward", "value": "Use Server Value" } ] }, { "name": "allow-update", "value": "Use Server Value", "subOptions": [ { "name": "other" }, { "name": "ACL Templates" } ] }, { "name": "notify", "value": "No", "subOptions": [ { "name": "also-notify" } ] } ] } ] } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "description": "Response entity", "properties": { "headers": { "type": "string" }, "body": { "type": "string" }, "statusCode": { "type": "string" } }, "example": { "list": [ { "message": "Moving V4 Object from 192.168.88.2 to 192.168.99.10 is sucessful.", "messageDetail": "Moved from: 192.168.88.2 to: 192.168.99.10" }, { "message": "Moving V4 Object from 192.168.88.5 to 192.168.77.0 is failed.", "messageDetail": "Destination subnet does not exist 192.168.77.0" }, { "message": "Moving V4 Object from 192.168.88.5 to 192.168.77.1 is failed.", "messageDetail": "Subnet Move CLI qip-move error C:\\qip\\cli\\qip-move\r\nSubnet for 192.168.77.1 does not exist!\r\nNot found in database!\r\n" }, { "message": "Moving V4 Object from 192.168.88.5 to 192.168.77.1 is failed.", "messageDetail": "Invalid fields [moveOption] when moving object from [192.168.88.2] to [192.168.99.0]." }, { "message": "Moving V4 Object from 192.168.99.3 to 192.168.99.99 is failed.", "messageDetail": "Subnet Move CLI qip-move error [SERVERERROR] Error from Server: ORA-20000: 77: This IP address is used.\r\nORA-06512: at \"QIPADMIN.QSIDBERROR\", line 67\r\nORA-06512: at \"QIPADMIN.CREATEPLACEHOLDER\", line 69\r\nORA-06512: at line 1\r\n\r\n\r\nC:\\qip\\cli\\qip-move ERROR: move failed!\r\nC:\\qip\\cli\\qip-move\r\n192.168.99.3\r\nError code = -1\r\n" }, { "message": "Moving V4 Object from 192.168.88.1 to 192.168.99.0 is failed.", "messageDetail": "Could not find IPv4 Address 192.168.088.001." }, { "message": "Moving V4 Object from 192.168.88.5 to 192.168.88.12 is failed.", "messageDetail": "The scheduled time is not in a date format." }, { "message": "Moving V4 Object from 192.168.88.5 to 192.168.88.12 is failed.", "messageDetail": "Subnet Move CLI qip-move error C:\\qip\\cli\\qip-move\r\ntime must be at least one hour from now\r\nInvalid parameter passed!\r\n" }, { "message": "Moving V4 Object from 192.168.88.2 to 192.168.99.9 is failed.", "messageDetail": "Subnet Move CLI qip-move error C:\\qip\\cli\\qip-move\r\nDateTime must be in the future.\r\nInvalid parameter passed!\r\n" } ] } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/moveV4Object" }, "task": true }, { "name": "getipv4address", "summary": "Select an IPv4 Address from a specific IPv4 Subnet.", "description": "Select an IPv4 Address from a specific IPv4 Subnet. This IPv4 Address is marked as Selected", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "subnetAddress", "type": "string", "info": "IPv4 Subnet Address: string", "required": true, "schema": { "title": "subnetAddress", "type": "string" } }, { "name": "startExcludedAddress", "type": "string", "info": "Start address of excluded range. If user only provides excludedAddressCount, \nthe default value of startExcludedAddress is the first IP in the subnet.: string", "required": false, "schema": { "title": "startExcludedAddress", "type": "string" } }, { "name": "excludedAddressCount", "type": "number", "info": "Number of addresses excluded. The default value is 1: 123", "required": false, "schema": { "title": "excludedAddressCount", "type": "number" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "ipAddrStr": { "type": "string", "description": "ipv4 address is selected from a specific IPv4 Subnet" } }, "example": { "objectAddr": "192.168.32.15" } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getipv4address" }, "task": true }, { "name": "getV1OrgNameV4addressGenerateauditreport", "summary": "Download audit report file", "description": "Use this URL to download v4 Object audit report file.\n\nWhen using cURL with this API specify \"-o fileName.extension\" to download file contents.\n\nInternet Explorer browser users: to download the report please right click the \"Download file\" link and select \"Save as\" then input the desired file name with the correct extension.\n\nExample: qipman-V4ObjectAuditReport-20190328_103238_523_0700.html or qipman-V4ObjectAuditReport-20190328_103238_523_0700.pdf", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "startDate", "type": "string", "info": "Start date\nFormat: mm/dd/yyyy hh:mm: string", "required": false, "schema": { "title": "startDate", "type": "string" } }, { "name": "endDate", "type": "string", "info": "End date\nFormat: mm/dd/yyyy hh:mm: string", "required": false, "schema": { "title": "endDate", "type": "string" } }, { "name": "name", "type": "string", "info": "v4 address name: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "address", "type": "string", "info": "v4 address: string", "required": false, "schema": { "title": "address", "type": "string" } }, { "name": "udaName", "type": "string", "info": "UDA name: string", "required": false, "schema": { "title": "udaName", "type": "string" } }, { "name": "udaValue", "type": "string", "info": "UDA value: string", "required": false, "schema": { "title": "udaValue", "type": "string" } }, { "name": "reportFormat", "type": "string", "info": "Report Format: Must be one of [html, pdf]", "required": true, "schema": { "title": "reportFormat", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getV1OrgNameV4addressGenerateauditreport" }, "task": true }, { "name": "getfreesubnetlist", "summary": "Get all available existing or new subnets in the IPv4 Network", "description": "Get all available existing or new subnets in the specified IPv4 Network Address with a specified subnet mask", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "networkAddress", "type": "string", "info": "IPv4 Network Address: string", "required": true, "schema": { "title": "networkAddress", "type": "string" } }, { "name": "subnetMask", "type": "string", "info": "Subnet Mask: string", "required": true, "schema": { "title": "subnetMask", "type": "string" } }, { "name": "type", "type": "string", "info": "Specifies whether to retrieve the available existing or new subnets.: Must be one of [New, Existing]", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "startAddress", "type": "string", "info": "Start subnet address: string", "required": false, "schema": { "title": "startAddress", "type": "string" } }, { "name": "numberOfSubnet", "type": "number", "info": "Number of subnet in the result list: 123", "required": false, "schema": { "title": "numberOfSubnet", "type": "number" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getfreesubnetlist" }, "task": true }, { "name": "movev6object", "summary": "Move one or more object(s) by IPv6 address.", "description": "Move one or more object(s) by IPv6 address.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"V6ObjectMoveRest\": [{\"objIPAddress\": \"string\", \"destinationAddress\": \"string\", \"moveOption\": \"string\", \"force\": \"string\", \"scheduleDate\": \"string\"}]}", "required": true, "schema": { "type": "object", "xml": { "name": "list" }, "properties": { "V6ObjectMoveRest": { "type": "array", "items": { "type": "object", "description": "V6 Address Rest Model", "required": [ "objIPAddress", "destinationAddress", "moveOption" ], "properties": { "objIPAddress": { "type": "string", "description": "Object IP address." }, "destinationAddress": { "type": "string", "description": "Destination address." }, "moveOption": { "type": "string", "description": "IPv6 address move option. It has two values: Assign, Auto" }, "force": { "type": "string", "description": "Force to move an IPv6 address which is associated to the server. It has two values: true, false. The default value is false." }, "scheduleDate": { "type": "string", "description": "If you including this filed in the request body that mean the IPv6 will move with scheduled. The date format allow such as MM/dd/yyyy hh:mm, yyyy-MM-dd'T'HH:mm:ss.SSSZ, yyyy-MM-dd hh:mm, yyyy-MM-dd hh:mm z, yyyyMMdd'T'hhmmZ, yyyy-MM-dd'T'HH:mm:ss.SSSX, yyyy-MM-dd h:mma, MMM d HH:mm yyyy, EEE MMM d HH:mm:ss zzz yyyy" } } } } }, "example": { "list": [ { "objIPAddress": "2005::2", "destinationAddress": "2009::2", "moveOption": "Assign" }, { "objIPAddress": "2005::1", "destinationAddress": "1000::", "moveOption": "Auto", "force": "true" }, { "objIPAddress": "2005::3", "destinationAddress": "2008::", "moveOption": "Auto", "scheduleDate": "08/30/2019 00:00" } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "description": "Response entity", "xml": { "name": "ResponseEntity" }, "properties": { "headers": { "type": "string" }, "body": { "type": "string" }, "statusCode": { "type": "string" } }, "example": { "list": [ { "message": "Moving V6 Object from 2005::2 to 2008::6 is successful." }, { "message": "Moving V6 Object from 2005::3 to 2006:: is successful.", "messageDetail": "Destination Address: 2006::2. Scheduled At: Move V6 Object from 2005::3 to 2006::1. Job id is: 20." }, { "message": "Moving V6 Object from 2005::8 to 2006:: is failed.", "messageDetail": "Cannot move the IPv6 Address 2005::8 which has associated with server(s)." }, { "message": "Moving V6 Object from 2005::1 to 2006::6 is failed.", "messageDetail": "Could not find IPv6 Address 2005::1." }, { "message": "Moving V6 Object from 2005::5 to 2007::12 is failed.", "messageDetail": "The scheduled time is not in a date format." } ] } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/movev6object" }, "task": true }, { "name": "addForwardedZone", "summary": "Create forwarded zone", "description": "Create a new forwarded zone\n", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "The forwarded zone request body: {\"name\": \"string\", \"forwardersList\": [{\"ipAddress\": \"string\", \"port\": 123}], \"forward\": \"string\", \"dnsServers\": [{\"name\": \"string\", \"role\": \"string\", \"secureUpdate\": \"boolean\"}], \"udas\": {\"name\": \"string\", \"value\": \"string\"}, \"groups\": {\"name\": \"string\", \"udas\": [{\"name\": \"string\", \"value\": \"string\"}]}}", "required": true, "schema": { "type": "object", "required": [ "name" ], "description": "This section defines a group of operations for adding a forwarded zone. Different messages, \nand capabilities, are provided to handle the adding. Add, Get and Update actions support \nare supported. \n", "properties": { "name": { "type": "string", "description": "Name of the forwarded zone.\n" }, "forwardersList": { "type": "array", "items": { "type": "object", "description": "Address", "required": [ "ipAddress" ], "properties": { "ipAddress": { "type": "string", "description": "ipAddress" }, "port": { "type": "integer", "description": "port" } } } }, "forward": { "type": "string", "description": "Forward options: Use Server Value|forward only| forward first\n" }, "dnsServers": { "type": "array", "items": { "type": "object", "description": "Name of DNS server", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "name" }, "role": { "type": "string", "description": "Primary/Secondary DNS Server:\nWith P is for Primary and S is for Secondary\n" }, "secureUpdate": { "type": "boolean", "description": "1 is turn on the flag of sending secure update 0 is not" } } } }, "udas": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "groups": { "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } }, "example": { "name": "nokia.com", "forwardersList": [ { "ipAddress": "192.168.99.98", "port": 5000 }, { "ipAddress": "2000::1", "port": 5001 } ], "forward": "Use Server Value", "dnsServers": [ "dns.example.com", "dnsserver.example.com" ], "udas": [ { "name": "at1", "value": "true" }, { "name": "test", "value": "vietnam" } ], "groups": [ { "name": "gr1", "udas": [ { "name": "at1", "value": "false" } ] }, { "name": "gr2", "udas": [ { "name": "testUDA", "value": "false" } ] } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addForwardedZone" }, "task": true }, { "name": "modifyForwardedZone", "summary": "Modify a forwarded zone", "description": "Modify a forwarded zone.\n", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "forwardedZoneName", "type": "string", "info": "Forwarded zone name: string", "required": true, "schema": { "title": "forwardedZoneName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "The zone request body: {\"forwardersList\": [{\"ipAddress\": \"string\", \"port\": 123}], \"forward\": \"string\", \"dnsServers\": [{\"name\": \"string\", \"role\": \"string\", \"secureUpdate\": \"boolean\"}], \"udas\": {\"name\": \"string\", \"value\": \"string\"}, \"groups\": {\"name\": \"string\", \"udas\": [{\"name\": \"string\", \"value\": \"string\"}]}}", "required": true, "schema": { "type": "object", "required": [ "name" ], "description": "This section defines a group of operations for adding a forwarded zone. Different messages, \nand capabilities, are provided to handle the adding. Add, Get and Update actions support \nare supported. \n", "xml": { "name": "ForwardedZone" }, "properties": { "forwardersList": { "type": "array", "items": { "type": "object", "description": "Address", "required": [ "ipAddress" ], "properties": { "ipAddress": { "type": "string", "description": "ipAddress" }, "port": { "type": "integer", "description": "port" } } } }, "forward": { "type": "string", "description": "Forward options: Use Server Value|forward only| forward first\n" }, "dnsServers": { "type": "array", "items": { "type": "object", "description": "Name of DNS server", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "name" }, "role": { "type": "string", "description": "Primary/Secondary DNS Server:\nWith P is for Primary and S is for Secondary\n" }, "secureUpdate": { "type": "boolean", "description": "1 is turn on the flag of sending secure update 0 is not" } } } }, "udas": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "groups": { "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } }, "example": { "forwardersList": [ { "ipAddress": "192.168.99.98", "port": 5000 }, { "ipAddress": "2000::1", "port": 5001 } ], "forward": "Use Server Value", "dnsServers": [ "dns.example.com", "dnsserver.example.com" ], "udas": [ { "name": "at1", "value": "true" }, { "name": "test", "value": "vietnam" } ], "groups": [ { "name": "gr1", "udas": [ { "name": "at1", "value": "false" } ] }, { "name": "gr2", "udas": [ { "name": "testUDA", "value": "false" } ] } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyForwardedZone" }, "task": true }, { "name": "deleteForwardedZone", "summary": "Delete a forwarded zone.", "description": "Delete a forwarded zone by name.\n", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "forwardedZoneName", "type": "string", "info": "Forwarded zone name: string", "required": true, "schema": { "title": "forwardedZoneName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteForwardedZone" }, "task": true }, { "name": "getForwardedZone", "summary": "Get Forwarded Zone", "description": "Get profile of a forwarded zone by name", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "forwardedZoneName", "type": "string", "info": "Forwarded zone name: string", "required": true, "schema": { "title": "forwardedZoneName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getForwardedZone" }, "task": true }, { "name": "signzone", "summary": "Sign a Zone", "description": "Sign a zone by name.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"zoneName\": \"string\", \"generatePushScheduler\": {\"runMode\": \"Must be one of [IN_BACKGROUND, IN_FOREGROUND]\", \"description\": \"string\", \"sendEmail\": \"boolean\", \"toEmail\": \"string\", \"ccEmail\": \"string\"}}", "required": true, "schema": { "type": "object", "description": "Sign Zone Rest Model", "required": [ "zoneName" ], "properties": { "zoneName": { "type": "string", "description": "Name of the zone." }, "generatePushScheduler": { "type": "object", "description": "If the user provides value for this field, after zone is signed successfully, the server will also perform the Generate Push for all DNS Servers associated with the signed zone.", "xml": { "name": "SchedulerOptions" }, "properties": { "runMode": { "type": "string", "description": "IN_FOREGROUND: run the job immediately.\n\nIN_BACKGROUND: run the job in background.", "enum": [ "IN_BACKGROUND", "IN_FOREGROUND" ] }, "description": { "type": "string", "description": "Description of the job." }, "sendEmail": { "type": "boolean", "description": "If the value is set to true then an email to be send when the job completed, it will require an email address is exist in toEmail field. The default is false." }, "toEmail": { "type": "string", "description": "An email address of up to 255 characters. Multiple email addresses must be separated by a comma (,)." }, "ccEmail": { "type": "string", "description": "An email address of up to 255 characters. Multiple email addresses must be separated by a comma (,)." } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/signzone" }, "task": true }, { "name": "unsignzone", "summary": "Unsign a Zone", "description": "Unsign a zone by name.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "zoneName", "type": "string", "info": "Zone Name: string", "required": true, "schema": { "title": "zoneName", "type": "string" } }, { "name": "emergency", "type": "string", "info": "Emergency Unsign Zone Warning: Performing an emergency unsign operation,\nnot waiting for propagation times and cache expiration, may break DNSSEC\nvalidation and resolutio...(description truncated): Must be one of [true, false]", "required": false, "schema": { "title": "emergency", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/unsignzone" }, "task": true }, { "name": "pushDNS", "summary": "Generate DNS Server Configuration", "description": "Use this procedure to generate DNS server configuration files. This call will return a token that can used to check the status of the operation.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "DNSGenerationRequest.: {\"serverName\": \"string\", \"pushDnsOptions\": {\"pushType\": \"Must be one of [CONFIG_AND_DATA, UPDATE, ALL_RECORDS, CHANGED_RECORDS_ONLY]\", \"targetZones\": \"Must be one of [ALL_ZONES, CHANGED_ZONES_ONLY, SELECTED_ZONES]\", \"generateTo\": \"Must be one of [SERVER, PREVIEW]\", \"selectedZones\": \"array\", \"force\": \"boolean\"}, \"schedulerOptions\": {\"runMode\": \"Must be one of [IN_FOREGROUND, IN_BACKGROUND, SCHEDULED_AT]\", \"scheduledTime\": \"string\", \"description\": \"string\", \"sendEmail\": \"boolean\", \"toEmail\": \"string\", \"ccEmail\": \"string\"}}", "required": true, "schema": { "type": "object", "required": [ "serverName" ], "properties": { "serverName": { "type": "string", "description": "Fully-qualified domain name of the server - The name of the server that the generation." }, "pushDnsOptions": { "type": "object", "properties": { "pushType": { "type": "string", "description": "CONFIG_AND_DATA: Generates the DNS configuration and data files without increasing the SOA serial number or reloading the server.\n\nUPDATE: The SOA serial number will be increased and the server will be reloaded.\n\nThe default value is UPDATE.\n\nIf you have selected a Microsoft DNS server, the above options are not displayed. Instead, you can select one of the following:\n\nALL_RECORDS: Generates the Microsoft DNS configuration and data files, including incrementing the SOA serial number and reloading the server.\n\nCHANGED_RECORDS_ONLY: Generates files for only changed records.\n\nThe default value is CHANGED_RECORDS_ONLY", "default": "UPDATE", "enum": [ "CONFIG_AND_DATA", "UPDATE", "ALL_RECORDS", "CHANGED_RECORDS_ONLY" ] }, "targetZones": { "type": "string", "description": "ALL_ZONES: Update all zone.\n\nCHANGED_ZONES_ONLY: Only update zones that have changed since the last push.\n\nSELECTED_ZONES: Update zones will be selected. \n\nThe default value is ALL_ZONES.", "default": "ALL_ZONES", "enum": [ "ALL_ZONES", "CHANGED_ZONES_ONLY", "SELECTED_ZONES" ] }, "generateTo": { "type": "string", "description": "SERVER: Files are generated to the DNS sever.\n\nPREVIEW: Files are generated to the web server for reviewing.\n\nThe default value is SERVER.", "default": "SERVER", "enum": [ "SERVER", "PREVIEW" ] }, "selectedZones": { "type": "array", "items": { "type": "string" }, "description": "Only update the zones that appear in this list." }, "force": { "type": "boolean", "description": "Forces a push to the DNS server if the DNS server was locked previously. If it is still locked, an error message is returned." } } }, "schedulerOptions": { "type": "object", "properties": { "runMode": { "type": "string", "description": "IN_FOREGROUND: run the job immediately.\n\nIN_BACKGROUND: run the job in background.\n\nSCHEDULED_AT: run the job for later.\n\nThe default value is IN_FOREGROUND for server push and IN_BACKGROUND for preview push.", "default": "IN_FOREGROUND", "enum": [ "IN_FOREGROUND", "IN_BACKGROUND", "SCHEDULED_AT" ] }, "scheduledTime": { "type": "string", "description": "Specify a date and time run the push, support the following date formats: yyyy-MM-dd'T'HH:mm:ss.SSSZ; MM/dd/yyyy hh:mm; EEE, yyyy-MM-dd hh:mm; yyyy-MM-dd hh:mm z; yyyyMMdd'T'hhmmZ; yyyy-MM-dd h:mma; MMM d HH:mm yyyy; EEE MMM d HH:mm:ss zzz yyyy" }, "description": { "type": "string", "description": "Description of the job." }, "sendEmail": { "type": "boolean", "description": "If the value is set to true then an email to be send when the job completed, it will require an email address is exist in toEmail field. The default is false." }, "toEmail": { "type": "string", "description": "An email address of up to 255 characters. Multiple email addresses must be separated by a comma (,)." }, "ccEmail": { "type": "string", "description": "An email address of up to 255 characters. Multiple email addresses must be separated by a comma (,)." } } } }, "example": { "serverName": "srv91.test.com", "pushDnsOptions": { "pushType": "CONFIG_AND_DATA", "targetZones": "SELECTED_ZONES", "generateTo": "SERVER", "force": "false", "selectedZones": [ "test2.com", "zoneAt1.com" ] }, "schedulerOptions": { "runMode": "SCHEDULED_AT", "scheduledTime": "05/15/2017 15:20", "description": "Run job on 15th May 2017", "sendEmail": "true", "toEmail": "a@a.com", "ccEmail": "b@a.com" } }, "definitions": {} } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pushDNS" }, "task": true }, { "name": "getDNSServer", "summary": "Get DNS Server by FQDN", "description": "Get DNS Server by fully qualified domain name (FQDN).", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "fqdn", "type": "string", "info": "Fully qualified domain name of server: string", "required": true, "schema": { "title": "fqdn", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDNSServer" }, "task": true }, { "name": "searchDNSServer", "summary": "Search DNS Server by Name or Address", "description": "Search DNS Server by Name or Address. Wildcards are supported. \n*Notes:* If the number of returned DNS Servers is less than or equal to the page size, the page index parameter is not honored.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "name", "type": "string", "info": "Server Name. Support the wildcard search with following forms: ✱ or ✱abc or abc✱ or a✱c \n \nThe default value is ✱: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "address", "type": "string", "info": "IPV4 Address. Support the wildcard search with following forms: ✱ or ✱.1 or 1.✱ or 1.✱.1 \n \nThe default value is ✱.: string", "required": false, "schema": { "title": "address", "type": "string" } }, { "name": "pageSize", "type": "number", "info": "Page size of response. The default value is 25: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "pageIndex", "type": "number", "info": "Page index of response. The default value is 1: 123", "required": false, "schema": { "title": "pageIndex", "type": "number" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchDNSServer" }, "task": true }, { "name": "createDNS", "summary": "Create a DNS Server", "description": "Create DNS Server", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Contain server information and parameters, UDA, UDA groups. Provide at least server information and required parameters: Default Directory, Email address for local and re...(description truncated): {\"serverName\": \"string\", \"domainName\": \"string\", \"serverType\": \"string\", \"ipv4Address\": \"string\", \"ipv6Address\": \"string\", \"serverTemplate\": \"string\", \"attributeList\": {\"udas\": [{\"name\": \"string\", \"value\": \"string\"}], \"groups\": [{\"name\": \"string\", \"udas\": [{\"name\": \"string\", \"value\": \"string\"}]}]}, \"parameters\": [{\"paramName\": \"string\", \"paramValue\": \"string\", \"childParams\": \"undefined\"}]}", "required": true, "schema": { "type": "object", "required": [ "serverName", "domainName", "serverType", "parameters" ], "properties": { "serverName": { "type": "string", "description": "Name of DNS server - not FQDN" }, "domainName": { "type": "string", "description": "Name of DNS zone" }, "serverType": { "type": "string", "description": "Type of DNS server. One of following values:\n\n'ALU DNS 6.0',
'ALU DNS 6.1',
'ALU DNS 6.2',
'BIND-4.9.X',
'BIND-8.X',
'BIND-9.X',
'LUCENT DNS 3.X',
'LUCENT DNS 4.X',
'LUCENT DNS 5.X',
'MICROSOFT DNS',
'MICROSOFT-NT4.0'" }, "ipv4Address": { "type": "string", "description": "IPv4 address of this server. If it already exists, the object name should match serverName. Otherwise, new object will be created" }, "ipv6Address": { "type": "string", "description": "IPv6 address of this server. The address need to exist in database" }, "serverTemplate": { "type": "string", "description": "The template name for using to create new DNS server" }, "attributeList": { "type": "object", "properties": { "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } }, "parameters": { "type": "array", "description": "The DNS server parameters to be created with DNS server", "items": { "type": "object", "required": [ "paramName" ], "properties": { "paramName": { "type": "string", "description": "Parameter name" }, "paramValue": { "type": "string", "description": "Parameter value" }, "childParams": { "description": "Child parameter array of this parameter. Have the same structure as this parameter" } } } } }, "example": { "serverName": "example", "domainName": "test.com", "serverType": "ALU DNS 6.2", "ipv4Address": "192.168.88.1", "ipv6Address": "", "attributeList": { "udas": [ { "name": "general attribute", "value": "this is multiple text" }, { "name": "dropdown", "value": "item2" } ], "groups": [ { "name": "agroup", "udas": [ { "name": "tobeingroup", "value": "5" } ] } ] }, "parameters": [ { "paramName": "Default Directory", "paramValue": "C:\\qip\\named" }, { "paramName": "Email address for local and reverse zones", "paramValue": "mail@test.com" }, { "paramName": "RNDC Key", "paramValue": "123456" }, { "paramName": "RNDC Path", "paramValue": "C:\\qip\\named\\bin" }, { "paramName": "DNSSEC", "paramValue": "Enabled", "childParams": [ { "paramName": "Authoritative Zones", "childParams": [ { "paramName": "DNSSEC Check Duplicate Records", "paramValue": "Warn" }, { "paramName": "DNSSEC Load Keys Interval", "paramValue": "60" }, { "paramName": "Key Directory", "paramValue": "keys" }, { "paramName": "Sign DNSKEY Records with KSK only", "paramValue": "No" }, { "paramName": "Sign zone with ZSK only", "paramValue": "Yes" } ] }, { "paramName": "Caching/Recursive", "childParams": [ { "paramName": "DNSSEC Accept Expired Signatures", "paramValue": "No" }, { "paramName": "DNSSEC BINDkeys File", "paramValue": "bind.keys" }, { "paramName": "DNSSEC Validation", "paramValue": "Yes" } ] } ] } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDNS" }, "task": true }, { "name": "deleteDNSServer", "summary": "Delete DNS Server", "description": "Delete a DNS server by FQDN", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "serverFQDN", "type": "string", "info": "FQDN of DNS server: string", "required": true, "schema": { "title": "serverFQDN", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDNSServer" }, "task": true }, { "name": "modifyDNS", "summary": "Modify a DNS Server", "description": "Modify a DNS Server. This call will update server based on information in the request body.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "serverFQDN", "type": "string", "info": "The fully qualified domain name of the DNS server: string", "required": true, "schema": { "title": "serverFQDN", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Contain server information and parameters, UDA, UDA groups. Provide any information that need to be updated.: {\"serverName\": \"string\", \"domainName\": \"string\", \"serverType\": \"string\", \"ipv4Address\": \"string\", \"ipv6Address\": \"string\", \"serverTemplate\": \"string\", \"attributeList\": {\"udas\": [{\"name\": \"string\", \"value\": \"string\"}], \"groups\": [{\"name\": \"string\", \"udas\": [{\"name\": \"string\", \"value\": \"string\"}]}]}, \"parameters\": [{\"paramName\": \"string\", \"paramValue\": \"string\", \"childParams\": \"undefined\"}]}", "required": true, "schema": { "type": "object", "required": [ "serverName", "domainName", "serverType", "parameters" ], "properties": { "serverName": { "type": "string", "description": "Name of DNS server - not FQDN" }, "domainName": { "type": "string", "description": "Name of DNS zone" }, "serverType": { "type": "string", "description": "Type of DNS server. One of following values:\n\n'ALU DNS 6.0',
'ALU DNS 6.1',
'ALU DNS 6.2',
'BIND-4.9.X',
'BIND-8.X',
'BIND-9.X',
'LUCENT DNS 3.X',
'LUCENT DNS 4.X',
'LUCENT DNS 5.X',
'MICROSOFT DNS',
'MICROSOFT-NT4.0'" }, "ipv4Address": { "type": "string", "description": "IPv4 address of this server. If it already exists, the object name should match serverName. Otherwise, new object will be created" }, "ipv6Address": { "type": "string", "description": "IPv6 address of this server. The address need to exist in database" }, "serverTemplate": { "type": "string", "description": "The template name for using to create new DNS server" }, "attributeList": { "type": "object", "properties": { "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } }, "parameters": { "type": "array", "description": "The DNS server parameters to be created with DNS server", "items": { "type": "object", "required": [ "paramName" ], "properties": { "paramName": { "type": "string", "description": "Parameter name" }, "paramValue": { "type": "string", "description": "Parameter value" }, "childParams": { "description": "Child parameter array of this parameter. Have the same structure as this parameter" } } } } }, "example": { "serverName": "example", "domainName": "test.com", "serverType": "ALU DNS 6.2", "ipv4Address": "192.168.88.1", "ipv6Address": "", "attributeList": { "udas": [ { "name": "general attribute", "value": "this is multiple text" }, { "name": "dropdown", "value": "item2" } ], "groups": [ { "name": "agroup", "udas": [ { "name": "tobeingroup", "value": "5" } ] } ] }, "parameters": [ { "paramName": "Default Directory", "paramValue": "C:\\qip\\named" }, { "paramName": "Email address for local and reverse zones", "paramValue": "mail@test.com" }, { "paramName": "RNDC Key", "paramValue": "123456" }, { "paramName": "RNDC Path", "paramValue": "C:\\qip\\named\\bin" }, { "paramName": "DNSSEC", "paramValue": "Enabled", "childParams": [ { "paramName": "Authoritative Zones", "childParams": [ { "paramName": "DNSSEC Check Duplicate Records", "paramValue": "Warn" }, { "paramName": "DNSSEC Load Keys Interval", "paramValue": "60" }, { "paramName": "Key Directory", "paramValue": "keys" }, { "paramName": "Sign DNSKEY Records with KSK only", "paramValue": "No" }, { "paramName": "Sign zone with ZSK only", "paramValue": "Yes" } ] }, { "paramName": "Caching/Recursive", "childParams": [ { "paramName": "DNSSEC Accept Expired Signatures", "paramValue": "No" }, { "paramName": "DNSSEC BINDkeys File", "paramValue": "bind.keys" }, { "paramName": "DNSSEC Validation", "paramValue": "Yes" } ] } ] } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyDNS" }, "task": true }, { "name": "getDNSServerZone", "summary": "Get DNS Server Zones", "description": "Get DNS Server Zones that associated with DNS Server. \n*Notes:* If the number of returned DNS Server Zones are less than or equal to the page size, the page index parameter is not honored.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "fqdn", "type": "string", "info": "Fully qualified domain name of server: string", "required": true, "schema": { "title": "fqdn", "type": "string" } }, { "name": "zoneName", "type": "string", "info": "Zone Name. Support the wildcard search with following forms: ✱ or ✱abc or abc✱ or a✱c \n \nThe default value is ✱: string", "required": false, "schema": { "title": "zoneName", "type": "string" } }, { "name": "pageSize", "type": "number", "info": "Page size of response. The default value is 25: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "pageIndex", "type": "number", "info": "Page index of response. The default value is 1: 123", "required": false, "schema": { "title": "pageIndex", "type": "number" } }, { "name": "sort", "type": "string", "info": "Sort direction of zone name response. The default value is ASC: string", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDNSServerZone" }, "task": true }, { "name": "managezone", "summary": "Manage/remove zones from the DNS Server.", "description": "Use to manage/remove zone(s) from the DNS Server.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "fqdn", "type": "string", "info": "Fully Qualified Domain Name: string", "required": true, "schema": { "title": "fqdn", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "1. To associate zones to DNS Server, provide at least these information: name, role. Primary server is needed if role is secondary.\n\n2. To disassociate zones from DNS Ser...(description truncated): {\"zoneType\": \"Must be one of [QIP Managed, Route 53]\", \"zones\": [{\"name\": \"string\", \"role\": \"Must be one of [PRIMARY, SECONDARY, FORWARDED]\", \"primary\": \"string\"}], \"removedZones\": [{\"name\": \"string\", \"role\": \"Must be one of [PRIMARY, SECONDARY, FORWARDED]\", \"primary\": \"string\"}]}", "required": true, "schema": { "type": "object", "properties": { "zoneType": { "type": "string", "description": "Zone type.", "enum": [ "QIP Managed", "Route 53" ] }, "zones": { "type": "array", "description": "contain zone information to be associated.", "items": { "type": "object", "required": [ "name", "role" ], "properties": { "name": { "type": "string", "description": "Domain name" }, "role": { "type": "string", "description": "Zone role.", "enum": [ "PRIMARY", "SECONDARY", "FORWARDED" ] }, "primary": { "type": "string", "description": "Fully Qualified Domain Name of Primary Server" } } } }, "removedZones": { "type": "array", "description": "contain zone information to be de-associated.", "items": { "type": "object", "required": [ "name", "role" ], "properties": { "name": { "type": "string", "description": "Domain name" }, "role": { "type": "string", "description": "Zone role.", "enum": [ "PRIMARY", "SECONDARY", "FORWARDED" ] }, "primary": { "type": "string", "description": "Fully Qualified Domain Name of Primary Server" } } } } }, "example": { "zoneType": "QIP Managed", "zones": [ { "name": "test1.com", "role": "secondary", "primary": "srv1.test.com" } ], "removedZones": [ { "name": "test2.com", "role": "secondary", "primary": "srv2.test.com" } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/managezone" }, "task": true }, { "name": "getDnsServerTemplate", "summary": "Get DNS Server Template", "description": "Get full profile of a DNS Server Template by name", "input": [ { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "name", "type": "string", "info": "Name of dns server template.: string", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDnsServerTemplate" }, "task": true }, { "name": "deleteDnsServerTemplate", "summary": "Delete DNS Server Template", "description": "Delete DNS Server Template by name", "input": [ { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "name", "type": "string", "info": "Name of dns server template.: string", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDnsServerTemplate" }, "task": true }, { "name": "createDNSServerTemplate", "summary": "Create DNS Server Template", "description": "Create DNS Server Template.", "input": [ { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "DNSServerTemplate.: {\"templateName\": \"string\", \"serverType\": \"string\", \"parameters\": [{\"paramName\": \"string\", \"paramValue\": \"string\", \"childParams\": \"undefined\"}]}", "required": true, "schema": { "type": "object", "required": [ "templateName", "serverType" ], "properties": { "templateName": { "type": "string", "description": "Name of DNS Server Template - not FQDN" }, "serverType": { "type": "string", "description": "Type of DNS server. One of following values:\n\n'ALU DNS 6.0',
'ALU DNS 6.1',
'ALU DNS 6.2',
'BIND-4.9.X',
'BIND-8.X',
'BIND-9.X',
'LUCENT DNS 3.X',
'LUCENT DNS 4.X',
'LUCENT DNS 5.X',
'MICROSOFT DNS',
'MICROSOFT-NT4.0',
'DNS 6.3'" }, "parameters": { "type": "array", "description": "The DNS Server parameters to be created with DNS server", "items": { "type": "object", "required": [ "paramName" ], "properties": { "paramName": { "type": "string", "description": "Parameter name" }, "paramValue": { "type": "string", "description": "Parameter value" }, "childParams": { "description": "Child parameter array of this parameter. Have the same structure as this parameter" } } } } }, "example": { "templateName": "template", "serverType": "DNS 6.3", "parameters": [ { "paramName": "Default Directory", "paramValue": "C:\\qip\\named" }, { "paramName": "Email address for local and reverse zones", "paramValue": "mail@test.com" }, { "paramName": "RNDC Key", "paramValue": "123456" }, { "paramName": "RNDC Path", "paramValue": "C:\\qip\\named\\bin" }, { "paramName": "DNSSEC", "paramValue": "Enabled", "childParams": [ { "paramName": "Authoritative Zones", "childParams": [ { "paramName": "DNSSEC Check Duplicate Records", "paramValue": "Warn" }, { "paramName": "DNSSEC Load Keys Interval", "paramValue": "60" }, { "paramName": "Key Directory", "paramValue": "keys" }, { "paramName": "Sign DNSKEY Records with KSK only", "paramValue": "No" }, { "paramName": "Sign zone with ZSK only", "paramValue": "Yes" } ] }, { "paramName": "Caching/Recursive", "childParams": [ { "paramName": "DNSSEC Accept Expired Signatures", "paramValue": "No" }, { "paramName": "DNSSEC BINDkeys File", "paramValue": "bind.keys" }, { "paramName": "DNSSEC Validation", "paramValue": "Yes" } ] } ] } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDNSServerTemplate" }, "task": true }, { "name": "modifyDnsServerTemplate", "summary": "Modify DNS Server Template", "description": "Modify DNS Server Template", "input": [ { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "name", "type": "string", "info": "Name of dns server template.: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "DNSServerTemplate.: {\"templateName\": \"string\", \"serverType\": \"string\", \"parameters\": [{\"paramName\": \"string\", \"paramValue\": \"string\", \"childParams\": \"undefined\"}]}", "required": true, "schema": { "type": "object", "required": [ "templateName", "serverType" ], "properties": { "templateName": { "type": "string", "description": "Name of DNS Server Template - not FQDN" }, "serverType": { "type": "string", "description": "Type of DNS server. One of following values:\n\n'ALU DNS 6.0',
'ALU DNS 6.1',
'ALU DNS 6.2',
'BIND-4.9.X',
'BIND-8.X',
'BIND-9.X',
'LUCENT DNS 3.X',
'LUCENT DNS 4.X',
'LUCENT DNS 5.X',
'MICROSOFT DNS',
'MICROSOFT-NT4.0',
'DNS 6.3'" }, "parameters": { "type": "array", "description": "The DNS Server parameters to be created with DNS server", "items": { "type": "object", "required": [ "paramName" ], "properties": { "paramName": { "type": "string", "description": "Parameter name" }, "paramValue": { "type": "string", "description": "Parameter value" }, "childParams": { "description": "Child parameter array of this parameter. Have the same structure as this parameter" } } } } }, "example": { "templateName": "template", "serverType": "DNS 6.3", "parameters": [ { "paramName": "Default Directory", "paramValue": "C:\\qip\\named" }, { "paramName": "Email address for local and reverse zones", "paramValue": "mail@test.com" }, { "paramName": "RNDC Key", "paramValue": "123456" }, { "paramName": "RNDC Path", "paramValue": "C:\\qip\\named\\bin" }, { "paramName": "DNSSEC", "paramValue": "Enabled", "childParams": [ { "paramName": "Authoritative Zones", "childParams": [ { "paramName": "DNSSEC Check Duplicate Records", "paramValue": "Warn" }, { "paramName": "DNSSEC Load Keys Interval", "paramValue": "60" }, { "paramName": "Key Directory", "paramValue": "keys" }, { "paramName": "Sign DNSKEY Records with KSK only", "paramValue": "No" }, { "paramName": "Sign zone with ZSK only", "paramValue": "Yes" } ] }, { "paramName": "Caching/Recursive", "childParams": [ { "paramName": "DNSSEC Accept Expired Signatures", "paramValue": "No" }, { "paramName": "DNSSEC BINDkeys File", "paramValue": "bind.keys" }, { "paramName": "DNSSEC Validation", "paramValue": "Yes" } ] } ] } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyDnsServerTemplate" }, "task": true }, { "name": "searchDnsServerTemplate", "summary": "Search DNS Server Template", "description": "Search DNS Server Template by name or zone or type", "input": [ { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "name", "type": "string", "info": "Name of dns server template.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "type", "type": "string", "info": "Type of dns server template.\nOne of following values:\n\n'ALU DNS 6.0', 'ALU DNS 6.1', 'ALU DNS 6.2', 'BIND-9.X', 'MICROSOFT DNS', 'DNS 6.3': string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "zone", "type": "string", "info": "which is managed by dns server template.: string", "required": false, "schema": { "title": "zone", "type": "string" } }, { "name": "pageSize", "type": "number", "info": "Page size of response.\nDefault: 25: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "pageIndex", "type": "number", "info": "Page index of response.\nDefault: 1: 123", "required": false, "schema": { "title": "pageIndex", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "properties": { "templateName": { "type": "string" }, "serverType": { "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchDnsServerTemplate" }, "task": true }, { "name": "generateDHCP", "summary": "Generate DHCP Server Configuration", "description": "Use this procedure to generate DHCP server configuration files. This call will return a token that can used to check the status of the operation.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "DHCPGenerationRequest: {\"serverName\": \"string\", \"dhcpV6\": \"boolean\", \"force\": \"boolean\", \"pushDHCPOptions\": {\"pushType\": \"Must be one of [SERVER, PREVIEW, DEBUG]\", \"debugType\": \"Must be one of [SET_DEBUG_LEVEL, CLEAR_DEBUG_LOG, STOP_DEBUG_LOG]\", \"debugLevelType\": \"Must be one of [LEVEL_CRITICAL, LEVEL_INFO, LEVEL_ERROR, LEVEL_DEBUG, LEVEL_WARNING]\", \"force\": \"boolean\"}, \"schedulerOptions\": {\"runMode\": \"Must be one of [IN_FOREGROUND, IN_BACKGROUND, SCHEDULED_AT]\", \"scheduledTime\": \"string\", \"description\": \"string\", \"sendEmail\": \"boolean\", \"toEmail\": \"string\", \"ccEmail\": \"string\"}}", "required": true, "schema": { "type": "object", "description": "Push DHCP Data", "required": [ "serverName" ], "properties": { "serverName": { "type": "string", "description": "Server name" }, "dhcpV6": { "type": "boolean", "description": "The DHCP Server is a dhcp v6 server. Default value is false." }, "force": { "type": "boolean", "description": "Force a generation to the DHCP Server. Default value is false." }, "pushDHCPOptions": { "type": "object", "description": "Push Server properties", "properties": { "pushType": { "type": "string", "description": "Push type. Valid values: SERVER, PREVIEW and DEBUG. Default value is SERVER.", "default": "SERVER", "enum": [ "SERVER", "PREVIEW", "DEBUG" ] }, "debugType": { "type": "string", "description": "Debug type. Valid values: SET_DEBUG_LEVEL, CLEAR_DEBUG_LOG and STOP_DEBUG_LOG. This field is required when push type is DEBUG and the default value is SET_DEBUG_LEVEL.", "enum": [ "SET_DEBUG_LEVEL", "CLEAR_DEBUG_LOG", "STOP_DEBUG_LOG" ] }, "debugLevelType": { "type": "string", "description": "Debug level type. Valid values: LEVEL_CRITICAL, LEVEL_INFO, LEVEL_ERROR, LEVEL_DEBUG and LEVEL_WARNING. This field is required when SET_DEBUG_LEVEL and the default is LEVEL_CRITICAL.", "enum": [ "LEVEL_CRITICAL", "LEVEL_INFO", "LEVEL_ERROR", "LEVEL_DEBUG", "LEVEL_WARNING" ] }, "force": { "type": "boolean", "description": "Force run push DHCP Server. Default value is false." } } }, "schedulerOptions": { "type": "object", "properties": { "runMode": { "type": "string", "description": "IN_FOREGROUND: run the job immediately.\n\nIN_BACKGROUND: run the job in background.\n\nSCHEDULED_AT: run the job for later.\n\nThe default value is IN_FOREGROUND for server push and IN_BACKGROUND for preview push.", "default": "IN_FOREGROUND", "enum": [ "IN_FOREGROUND", "IN_BACKGROUND", "SCHEDULED_AT" ] }, "scheduledTime": { "type": "string", "description": "Specify a date and time run the push, support the following date formats: yyyy-MM-dd'T'HH:mm:ss.SSSZ; MM/dd/yyyy hh:mm; EEE, yyyy-MM-dd hh:mm; yyyy-MM-dd hh:mm z; yyyyMMdd'T'hhmmZ; yyyy-MM-dd h:mma; MMM d HH:mm yyyy; EEE MMM d HH:mm:ss zzz yyyy" }, "description": { "type": "string", "description": "Description of the job." }, "sendEmail": { "type": "boolean", "description": "If the value is set to true then an email to be send when the job completed, it will require an email address is exist in toEmail field. The default is false." }, "toEmail": { "type": "string", "description": "An email address of up to 255 characters. Multiple email addresses must be separated by a comma (,)." }, "ccEmail": { "type": "string", "description": "An email address of up to 255 characters. Multiple email addresses must be separated by a comma (,)." } } } }, "example": { "serverName": "dhcp.example.com", "dhcpV6": false, "pushDHCPOptions": { "pushType": "DEBUG", "debugType": "SET_DEBUG_LEVEL", "debugLevelType": "LEVEL_INFO", "force": false }, "schedulerOptions": { "runMode": "IN_BACKGROUND", "description": "Description", "sendEmail": "true", "toEmail": "to@example.com", "ccEmail": "cc@example.com" } }, "definitions": {} } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/generateDHCP" }, "task": true }, { "name": "createScope", "summary": "Create a DHCP scope by selecting a set of addresses and assigning it an Object Profile", "description": "Use this procedure to create a DHCP scope", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "DHCPScope Request: {\"subnetAddress\": \"string\", \"startAddress\": \"string\", \"endAddress\": \"string\", \"domnName\": \"string\", \"nameService\": \"string\", \"dynamicUpdate\": \"string\", \"dhcpServer\": \"string\", \"dhcpTemplate\": \"string\", \"dhcpType\": \"string\", \"objectClass\": \"string\", \"vendorClass\": \"string\", \"leaseTime\": \"string\", \"userClass\": \"string\"}", "required": true, "schema": { "type": "object", "required": [ "subnetAddress", "dhcpType", "startAddress", "endAddress", "domnName", "dhcpServer", "dhcpTemplate" ], "properties": { "subnetAddress": { "type": "string", "description": "Specifies the subnet whose IP address(es) is associated with this DHCP scope." }, "startAddress": { "type": "string", "description": "Specifies the beginning address that defines the DHCP scope of addresses." }, "endAddress": { "type": "string", "description": "Specifies the ending address that defines the DHCP scope of addresses." }, "domnName": { "type": "string", "description": "Specifies the fully-qualified domain name." }, "nameService": { "type": "string", "description": "Specifies “Y� or “N� to register this object with the name service." }, "dynamicUpdate": { "type": "string", "description": "Specifies “Y� or “N� to turn on or off the dynamic update flags." }, "dhcpServer": { "type": "string", "description": "Specifies the fully-qualified DHCP server name to which you are assigning this scope." }, "dhcpTemplate": { "type": "string", "description": "Specifies the DHCP template to be assigned to this scope." }, "dhcpType": { "type": "string", "description": "Specifies a DHCP type. The options are A(automatic) or D(dynamic)." }, "objectClass": { "type": "string", "description": "Specifies the object class description." }, "vendorClass": { "type": "string", "description": "Specifies the vendor class to be assigned to this scope." }, "leaseTime": { "type": "string", "description": "Specifies the lease time to be assigned to this scope." }, "userClass": { "type": "string", "description": "QDHCP servers only: Specifies user class to be assigned to scope." } }, "example": { "subnetAddress": "192.168.1.0", "startAddress": "192.168.1.1", "endAddress": "192.168.1.2", "domnName": "nokia.com", "dhcpType": "D", "dynamicUpdate": "True", "dhcpServer": "dhcp.nokia.com", "dhcpTemplate": "general" }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createScope" }, "task": true }, { "name": "modifyScope", "summary": "Modify a DHCP scope", "description": "Use this procedure to modify a DHCP scope", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "startAddress", "type": "string", "info": "Start Address of an DHCP Scope: string", "required": true, "schema": { "title": "startAddress", "type": "string" } }, { "name": "endAddress", "type": "string", "info": "End Address of an DHCP Scope: string", "required": true, "schema": { "title": "endAddress", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Modifying DHCP Scope Request: {\"dhcpServer\": \"string\", \"dhcpType\": \"string\", \"dhcpOptionTemplate\": \"string\", \"dhcpPolicyTemplate\": \"string\", \"vendorClass\": \"string\", \"leaseTime\": 123, \"userClassList\": \"array\", \"clientClassList\": \"array\", \"dhcpFingerprintList\": \"array\"}", "required": true, "schema": { "type": "object", "properties": { "dhcpServer": { "type": "string", "description": "Specifies the fully-qualified DHCP server name to which you are assigning this scope." }, "dhcpType": { "type": "string", "description": "Specifies a DHCP type. The options are A(automatic) or D(dynamic)." }, "dhcpOptionTemplate": { "type": "string", "description": "Specifies the DHCP option template to be assigned to this scope." }, "dhcpPolicyTemplate": { "type": "string", "description": "Specifies the DHCP Policy template to be assigned to this scope." }, "vendorClass": { "type": "string", "description": "Specifies the vendor class to be assigned to this scope." }, "leaseTime": { "type": "integer", "description": "Specifies the lease time to be assigned to this scope." }, "userClassList": { "type": "array", "description": "Specifies user class list to be assigned to scope.", "items": { "type": "string" } }, "clientClassList": { "type": "array", "description": "Specifies client class list to be assigned to scope.", "items": { "type": "string" } }, "dhcpFingerprintList": { "type": "array", "description": "Specifies the DHCP fingerprint list to be assigned to this scope.", "items": { "type": "string" } } }, "example": { "dhcpServer": "DHCPServer.com", "dhcpType": "D", "dhcpOptionTemplate": "general", "dhcpFingerprintList": [ "F1", "F3" ], "dhcpPolicyTemplate": "nokia.com", "vendorClass": "newVendorCLass" }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyScope" }, "task": true }, { "name": "createDHCP", "summary": "Create a DHCP Server", "description": "Create DHCP Server", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Contain server information and parameters, UDA, UDA groups. Provide at least server information and required parameters: Default Directory, DHCP Template: {\"serverName\": \"string\", \"domainName\": \"string\", \"serverType\": \"string\", \"ipv4Address\": \"string\", \"ipv6Address\": \"string\", \"attributeList\": {\"udas\": [{\"name\": \"string\", \"value\": \"string\"}], \"groups\": [{\"name\": \"string\", \"udas\": [{\"name\": \"string\", \"value\": \"string\"}]}]}, \"parameters\": [{\"paramName\": \"string\", \"paramValue\": \"string\", \"childParams\": \"undefined\"}]}", "required": true, "schema": { "type": "object", "required": [ "serverName", "domainName", "serverType", "parameters" ], "properties": { "serverName": { "type": "string", "description": "Hostname of the DHCP Server - not FQDN" }, "domainName": { "type": "string", "description": "Domain Name of the DHCP Server" }, "serverType": { "type": "string", "description": "Type of DHCP server. One of following values:\n\n'LUCENT DHCP 5.4',
'LUCENT DHCP 5.5',
'LUCENT DHCP 5.6',
'LUCENT DHCP 6.0',
'MICROSOFT DHCP'" }, "ipv4Address": { "type": "string", "description": "IPv4 address of this server. If it already exists, the object name should match serverName. Otherwise, new object will be created" }, "ipv6Address": { "type": "string", "description": "IPv6 address of this server. The address need to exist in database" }, "attributeList": { "type": "object", "properties": { "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } }, "parameters": { "type": "array", "description": "The DHCP server parameters to be created with DHCP server", "items": { "type": "object", "required": [ "paramName" ], "properties": { "paramName": { "type": "string", "description": "Parameter name" }, "paramValue": { "type": "string", "description": "Parameter value" }, "childParams": { "description": "Child parameter array of this parameter. Have the same structure as this parameter" } } } } }, "example": { "serverName": "example", "domainName": "test.com", "ipv4Address": "192.168.88.1", "ipv6Address": "", "serverType": "Lucent DHCP 6.0", "attributeList": { "udas": [ { "name": "general attribute", "value": "this is multiple text" }, { "name": "dropdown", "value": "item2" } ], "groups": [ { "name": "agroup", "udas": [ { "name": "tobeingroup", "value": "5" } ] } ] }, "parameters": [ { "paramName": "Default Directory", "paramValue": "C:\\qip\\dhcp" }, { "paramName": "DHCP Template", "paramValue": "general" }, { "paramName": "Failover Server Type", "paramValue": "Standalone/Primary" }, { "paramName": "Managed Range", "paramValue": "Corporation" }, { "paramName": "Accept Client Names", "paramValue": "True" }, { "paramName": "Additional Policies", "paramValue": "" }, { "paramName": "Debug Information", "childParams": [ { "paramName": "Debug", "paramValue": "All" }, { "paramName": "DebugFile", "paramValue": "dhcpd.log" }, { "paramName": "MaxDebugFileSize", "paramValue": "-1" } ] }, { "paramName": "Remote Server Proxy", "paramValue": "" }, { "paramName": "Scheduled Automatic Updates", "paramValue": "None" }, { "paramName": "Support Bootp", "paramValue": "True" }, { "paramName": "Use Server Policy Template", "paramValue": "False" } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDHCP" }, "task": true }, { "name": "deleteDHCPServer", "summary": "Delete DHCP Server", "description": "Delete a DHCP server by FQDN", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "serverFQDN", "type": "string", "info": "FQDN of DHCP server: string", "required": true, "schema": { "title": "serverFQDN", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDHCPServer" }, "task": true }, { "name": "modifyDHCP", "summary": "Modify a DHCP Server", "description": "Modify a DHCP Server. This call will update server based on information in the request body.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "serverFQDN", "type": "string", "info": "The fully qualified domain name of the DHCP server: string", "required": true, "schema": { "title": "serverFQDN", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Contain server information and parameters, UDA, UDA groups. Provide any information that need to be updated.: {\"serverName\": \"string\", \"domainName\": \"string\", \"serverType\": \"string\", \"ipv4Address\": \"string\", \"ipv6Address\": \"string\", \"attributeList\": {\"udas\": [{\"name\": \"string\", \"value\": \"string\"}], \"groups\": [{\"name\": \"string\", \"udas\": [{\"name\": \"string\", \"value\": \"string\"}]}]}, \"parameters\": [{\"paramName\": \"string\", \"paramValue\": \"string\", \"childParams\": \"undefined\"}]}", "required": true, "schema": { "type": "object", "required": [ "serverName", "domainName", "serverType", "parameters" ], "properties": { "serverName": { "type": "string", "description": "Hostname of the DHCP Server - not FQDN" }, "domainName": { "type": "string", "description": "Domain Name of the DHCP Server" }, "serverType": { "type": "string", "description": "Type of DHCP server. One of following values:\n\n'LUCENT DHCP 5.4',
'LUCENT DHCP 5.5',
'LUCENT DHCP 5.6',
'LUCENT DHCP 6.0',
'MICROSOFT DHCP'" }, "ipv4Address": { "type": "string", "description": "IPv4 address of this server. If it already exists, the object name should match serverName. Otherwise, new object will be created" }, "ipv6Address": { "type": "string", "description": "IPv6 address of this server. The address need to exist in database" }, "attributeList": { "type": "object", "properties": { "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } }, "parameters": { "type": "array", "description": "The DHCP server parameters to be created with DHCP server", "items": { "type": "object", "required": [ "paramName" ], "properties": { "paramName": { "type": "string", "description": "Parameter name" }, "paramValue": { "type": "string", "description": "Parameter value" }, "childParams": { "description": "Child parameter array of this parameter. Have the same structure as this parameter" } } } } }, "example": { "serverName": "example", "domainName": "test.com", "ipv4Address": "192.168.88.1", "ipv6Address": "", "serverType": "Lucent DHCP 6.0", "attributeList": { "udas": [ { "name": "general attribute", "value": "this is multiple text" }, { "name": "dropdown", "value": "item2" } ], "groups": [ { "name": "agroup", "udas": [ { "name": "tobeingroup", "value": "5" } ] } ] }, "parameters": [ { "paramName": "Default Directory", "paramValue": "C:\\qip\\dhcp" }, { "paramName": "DHCP Template", "paramValue": "general" }, { "paramName": "Failover Server Type", "paramValue": "Standalone/Primary" }, { "paramName": "Managed Range", "paramValue": "Corporation" }, { "paramName": "Accept Client Names", "paramValue": "True" }, { "paramName": "Additional Policies", "paramValue": "" }, { "paramName": "Debug Information", "childParams": [ { "paramName": "Debug", "paramValue": "All" }, { "paramName": "DebugFile", "paramValue": "dhcpd.log" }, { "paramName": "MaxDebugFileSize", "paramValue": "-1" } ] }, { "paramName": "Remote Server Proxy", "paramValue": "" }, { "paramName": "Scheduled Automatic Updates", "paramValue": "None" }, { "paramName": "Support Bootp", "paramValue": "True" }, { "paramName": "Use Server Policy Template", "paramValue": "False" } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyDHCP" }, "task": true }, { "name": "searchDHCPServer", "summary": "Search DHCP Server by Name or Address", "description": "Search DHCP Server by Name or Address. Wildcards are supported. \n*Notes:* If the number of returned DHCP Servers is less than or equal to the page size, the page index parameter is not honored.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "name", "type": "string", "info": "Server Name. Support the wildcard search with following forms: ✱ or ✱abc or abc✱ or a✱c \n \nThe default value is ✱: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "address", "type": "string", "info": "IPV4 Address. Support the wildcard search with following forms: ✱ or ✱.1 or 1.✱ or 1.✱.1 \n \nThe default value is ✱.: string", "required": false, "schema": { "title": "address", "type": "string" } }, { "name": "pageSize", "type": "number", "info": "Page size of response. The default value is 25: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "pageIndex", "type": "number", "info": "Page index of response. The default value is 1: 123", "required": false, "schema": { "title": "pageIndex", "type": "number" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchDHCPServer" }, "task": true }, { "name": "getDHCPServer", "summary": "Get DHCP Server by FQDN", "description": "Get DHCP Server by fully qualified domain name (FQDN).", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "fqdn", "type": "string", "info": "Fully qualified domain name of server: string", "required": true, "schema": { "title": "fqdn", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDHCPServer" }, "task": true }, { "name": "explicitBlock", "summary": "Explicit block and send arin notify", "description": "Explicit block and send arin notify", "input": [ { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"startAddress\": \"string\", \"prefixLength\": 123, \"pool\": {\"name\": \"string\", \"parentName\": \"string\"}, \"blockStatus\": \"string\", \"addressType\": \"string\", \"subnetCreationOption\": \"string\", \"addressTemplate\": \"string\", \"subnetName\": \"string\", \"subnetProfileTemplateName\": \"string\", \"networkContact\": \"string\", \"ruleName\": \"string\", \"useDefaultRuleSize\": \"boolean\", \"arinReassignSimpleReportRec\": {\"registrationAction\": \"string\", \"originAs\": \"string\", \"privateValue\": \"boolean\", \"customerName\": \"string\", \"customerAddress\": \"string\", \"customerCity\": \"string\", \"customerState\": \"string\", \"customerPostalCode\": \"string\", \"customerCountryCode\": \"string\", \"publicComment\": \"string\", \"customizedInfo\": \"string\"}, \"arinReallocateOrReassignDetailedRec\": {\"arinType\": \"string\", \"organizationInfo\": {\"downStreamOrgID\": 123, \"orgName\": \"string\", \"orgAddress\": \"string\", \"orgCity\": \"string\", \"orgState\": \"string\", \"orgPostalCode\": \"string\", \"orgCountryCode\": \"string\", \"orgCustomizedInfo\": \"string\"}, \"contactInfo\": {\"orgPocHandle\": \"string\", \"orgPocContactType\": \"string\", \"orgPocLastNameOrRoleAccount\": \"string\", \"orgPocFirstName\": \"string\", \"orgPocCompanyName\": \"string\", \"orgPocAddress\": \"string\", \"orgPocCity\": \"string\", \"orgPocState\": \"string\", \"orgPocPostalCode\": \"string\", \"orgPocCountryCode\": \"string\", \"orgPocPhoneNumber\": \"string\", \"orgPocEmailAddress\": \"string\", \"orgPocCustomizedInfo\": \"string\"}, \"networkInfo\": {\"originAS\": \"string\", \"dnsHostName\": \"string\", \"networkCustomizedInfo\": \"string\"}, \"networkContactInfo\": {\"netPocType\": \"string\", \"netPocHandle\": \"string\", \"netPocContactType\": \"string\", \"netPocLastNameOrRoleAccount\": \"string\", \"netPocFirstName\": \"string\", \"netPocCompanyName\": \"string\", \"netPocAddress\": \"string\", \"netPocCity\": \"string\", \"netPocState\": \"string\", \"netPocPostalCode\": \"string\", \"netPocCountryCode\": \"string\", \"netPocPhoneNumber\": \"string\", \"netPocEmailAddress\": \"string\", \"netPocCustomizedInfo\": \"string\"}, \"publicComment\": \"string\", \"addInfo\": \"string\", \"othersCustomizedInfo\": \"string\"}}", "required": true, "schema": { "description": "ExplicitBlockArinNotification model", "required": [ "startAddress", "prefixLength", "pool", "blockStatus", "addressType", "ruleName" ], "properties": { "startAddress": { "type": "string", "description": "Start Address of Block" }, "prefixLength": { "type": "integer", "description": "Require when blockStatus is not SITE" }, "pool": { "type": "object", "required": [ "name", "parentName" ], "properties": { "name": { "type": "string" }, "parentName": { "type": "string" } } }, "blockStatus": { "type": "string", "description": "Use action value FREE | USED | RESERVED | SITE" }, "addressType": { "type": "string", "description": "Use action value V4" }, "subnetCreationOption": { "type": "string", "description": "Use action value CREATE NEW IF NECESSARY | CREATE NEW | LINK TO EXISTING | DO NOT CREATE OR LINK" }, "addressTemplate": { "type": "string" }, "subnetName": { "type": "string" }, "subnetProfileTemplateName": { "type": "string" }, "networkContact": { "type": "string" }, "ruleName": { "type": "string", "description": "Require when blockStatus is SITE" }, "useDefaultRuleSize": { "type": "boolean" }, "arinReassignSimpleReportRec": { "type": "object", "required": [ "registrationAction" ], "properties": { "registrationAction": { "type": "string", "description": "Use action value NEW | MODIFY | REMOVE" }, "originAs": { "type": "string" }, "privateValue": { "type": "boolean" }, "customerName": { "type": "string" }, "customerAddress": { "type": "string" }, "customerCity": { "type": "string" }, "customerState": { "type": "string" }, "customerPostalCode": { "type": "string" }, "customerCountryCode": { "type": "string" }, "publicComment": { "type": "string" }, "customizedInfo": { "type": "string" } } }, "arinReallocateOrReassignDetailedRec": { "type": "object", "required": [ "arinType", "organizationInfo", "contactInfo", "networkContactInfo" ], "properties": { "arinType": { "type": "string", "description": "Use type value ARIN-Reallocate | ARIN-Reassign-Detailed" }, "organizationInfo": { "type": "object", "required": [ "orgName", "orgAddress", "orgCity", "orgCountryCode" ], "properties": { "downStreamOrgID": { "type": "integer" }, "orgName": { "type": "string" }, "orgAddress": { "type": "string" }, "orgCity": { "type": "string" }, "orgState": { "type": "string" }, "orgPostalCode": { "type": "string" }, "orgCountryCode": { "type": "string" }, "orgCustomizedInfo": { "type": "string" } } }, "contactInfo": { "type": "object", "required": [ "orgPocContactType", "orgPocLastNameOrRoleAccount", "orgPocFirstName", "orgPocAddress", "orgPocCity", "orgPocCountryCode", "orgPocPhoneNumber", "orgPocEmailAddress" ], "properties": { "orgPocHandle": { "type": "string" }, "orgPocContactType": { "type": "string", "description": "Use type PERSON | ROLE" }, "orgPocLastNameOrRoleAccount": { "type": "string" }, "orgPocFirstName": { "type": "string" }, "orgPocCompanyName": { "type": "string" }, "orgPocAddress": { "type": "string" }, "orgPocCity": { "type": "string" }, "orgPocState": { "type": "string" }, "orgPocPostalCode": { "type": "string" }, "orgPocCountryCode": { "type": "string" }, "orgPocPhoneNumber": { "type": "string" }, "orgPocEmailAddress": { "type": "string" }, "orgPocCustomizedInfo": { "type": "string" } } }, "networkInfo": { "type": "object", "properties": { "originAS": { "type": "string" }, "dnsHostName": { "type": "string" }, "networkCustomizedInfo": { "type": "string" } } }, "networkContactInfo": { "type": "object", "required": [ "netPocContactType", "netPocLastNameOrRoleAccount", "netPocFirstName", "netPocAddress", "netPocCity", "netPocCountryCode", "netPocPhoneNumber", "netPocEmailAddress" ], "properties": { "netPocType": { "type": "string", "description": "Use type T (Resource Technical Contact) \n AB (Resource Abuse Contact) \n N (Resource NOC Contact) \n T,AB(T and AB) | T,N (T and N) | AB,N (AB and N) | T,AB,N (T,AB and N)" }, "netPocHandle": { "type": "string" }, "netPocContactType": { "type": "string", "description": "Use type PERSON | ROLE" }, "netPocLastNameOrRoleAccount": { "type": "string" }, "netPocFirstName": { "type": "string" }, "netPocCompanyName": { "type": "string" }, "netPocAddress": { "type": "string" }, "netPocCity": { "type": "string" }, "netPocState": { "type": "string" }, "netPocPostalCode": { "type": "string" }, "netPocCountryCode": { "type": "string" }, "netPocPhoneNumber": { "type": "string" }, "netPocEmailAddress": { "type": "string" }, "netPocCustomizedInfo": { "type": "string" } } }, "publicComment": { "type": "string" }, "addInfo": { "type": "string" }, "othersCustomizedInfo": { "type": "string" } }, "example": { "arinType": "ARIN-Reallocate", "organizationInfo": { "orgName": "VitalQIP Organization", "orgAddress": "600 Mountain Avenue", "orgCity": "Murray Hill", "orgState": "NJ", "orgPostalCode": "07974", "orgCountryCode": "US", "orgCustomizedInfo": "Customer Info" }, "contactInfo": { "orgPocContactType": "PERSON", "orgPocLastNameOrRoleAccount": "my org POC last name", "orgPocFirstName": "my org POC First Name", "orgPocCompanyName": "my company name", "orgPocAddress": "600 Mountain Avenue", "orgPocCity": "Murray Hill", "orgPocState": "NJ", "orgPocPostalCode": "7974", "orgPocCountryCode": "US", "orgPocPhoneNumber": "891-345-5678", "orgPocEmailAddress": "orgPOCEmail@mycompany.com", "orgPocCustomizedInfo": "Customer Info" }, "networkInfo": { "originAS": "192.168.0.0", "dnsHostName": "dns@example.com", "networkCustomizedInfo": "Customer Info" }, "networkContactInfo": { "netPocType": "T", "netPocContactType": "PERSON", "netPocLastNameOrRoleAccount": "net POC Last Name", "netPocFirstName": "net Contact First Name", "netPocCompanyName": "Company Name", "netPocAddress": "600 Mountain Avenue", "netPocCity": "Murray Hill", "netPocState": "NJ", "netPocPostalCode": "07974", "netPocCountryCode": "US", "netPocPhoneNumber": "891-234-4567", "netPocEmailAddress": "netContactEmail@mycompany.com", "netPocCustomizedInfo": "Customer Info" }, "publicComment": "This is a sample block via VitalQIP API", "addInfo": "this is additional information", "othersCustomizedInfo": "Other Customized Info" } } }, "example": { "startAddress": "10.0.0.0", "prefixLength": 16, "pool": { "name": "childPool", "parentName": "parentPool" }, "blockStatus": "FREE", "addressType": "V4", "subnetCreationOption": "CREATE NEW IF NECESSARY", "addressTemplate": "templateName", "subnetName": "subnetName", "subnetProfileTemplateName": "subnetProfileTemplate", "networkContact": "a@a.a", "useDefaultRuleSize": false, "arinReassignSimpleReportRec": { "registrationAction": "NEW", "originAs": "192.168.0.0", "privateValue": false, "customerName": "Customer Name", "customerAddress": "600 Mountain Avenue", "customerCity": "Murray Hill", "customerState": "NJ", "customerPostalCode": "07974", "customerCountryCode": "US", "publicComment": "This is a sample block via VitalQIP API", "customizedInfo": "customer info" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/explicitBlock" }, "task": true }, { "name": "allocateBlock", "summary": "Allocate block and send arin notify", "description": "Allocate block and send arin notify", "input": [ { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"pool\": {\"name\": \"string\", \"parentName\": \"string\"}, \"addressType\": \"string\", \"networkContact\": \"string\", \"requireSpecificBlock\": \"boolean\", \"prefixLength\": 123, \"startAddress\": \"string\", \"blockStatus\": \"string\", \"ruleName\": \"string\", \"arinReassignSimpleReportRec\": {\"registrationAction\": \"string\", \"originAs\": \"string\", \"privateValue\": \"boolean\", \"customerName\": \"string\", \"customerAddress\": \"string\", \"customerCity\": \"string\", \"customerState\": \"string\", \"customerPostalCode\": \"string\", \"customerCountryCode\": \"string\", \"publicComment\": \"string\", \"customizedInfo\": \"string\"}, \"arinReallocateOrReassignDetailedRec\": {\"arinType\": \"string\", \"organizationInfo\": {\"downStreamOrgID\": 123, \"orgName\": \"string\", \"orgAddress\": \"string\", \"orgCity\": \"string\", \"orgState\": \"string\", \"orgPostalCode\": \"string\", \"orgCountryCode\": \"string\", \"orgCustomizedInfo\": \"string\"}, \"contactInfo\": {\"orgPocHandle\": \"string\", \"orgPocContactType\": \"string\", \"orgPocLastNameOrRoleAccount\": \"string\", \"orgPocFirstName\": \"string\", \"orgPocCompanyName\": \"string\", \"orgPocAddress\": \"string\", \"orgPocCity\": \"string\", \"orgPocState\": \"string\", \"orgPocPostalCode\": \"string\", \"orgPocCountryCode\": \"string\", \"orgPocPhoneNumber\": \"string\", \"orgPocEmailAddress\": \"string\", \"orgPocCustomizedInfo\": \"string\"}, \"networkInfo\": {\"originAS\": \"string\", \"dnsHostName\": \"string\", \"networkCustomizedInfo\": \"string\"}, \"networkContactInfo\": {\"netPocType\": \"string\", \"netPocHandle\": \"string\", \"netPocContactType\": \"string\", \"netPocLastNameOrRoleAccount\": \"string\", \"netPocFirstName\": \"string\", \"netPocCompanyName\": \"string\", \"netPocAddress\": \"string\", \"netPocCity\": \"string\", \"netPocState\": \"string\", \"netPocPostalCode\": \"string\", \"netPocCountryCode\": \"string\", \"netPocPhoneNumber\": \"string\", \"netPocEmailAddress\": \"string\", \"netPocCustomizedInfo\": \"string\"}, \"publicComment\": \"string\", \"addInfo\": \"string\", \"othersCustomizedInfo\": \"string\"}}", "required": true, "schema": { "description": "Allocate Block To Pool model", "required": [ "pool", "addressType", "networkContact", "ruleName" ], "properties": { "pool": { "type": "object", "required": [ "name", "parentName" ], "properties": { "name": { "type": "string" }, "parentName": { "type": "string" } } }, "addressType": { "type": "string", "description": "Use address type V4" }, "networkContact": { "type": "string", "description": "Require if rule type is SITE or USED." }, "requireSpecificBlock": { "type": "boolean", "description": "Request enter value for prefixLength, startAddress, blockStatus if requireSpecificBlock is set true." }, "prefixLength": { "type": "integer" }, "startAddress": { "type": "string" }, "blockStatus": { "type": "string" }, "ruleName": { "type": "string" }, "arinReassignSimpleReportRec": { "type": "object", "required": [ "registrationAction" ], "properties": { "registrationAction": { "type": "string", "description": "Use action value NEW | MODIFY | REMOVE" }, "originAs": { "type": "string" }, "privateValue": { "type": "boolean" }, "customerName": { "type": "string" }, "customerAddress": { "type": "string" }, "customerCity": { "type": "string" }, "customerState": { "type": "string" }, "customerPostalCode": { "type": "string" }, "customerCountryCode": { "type": "string" }, "publicComment": { "type": "string" }, "customizedInfo": { "type": "string" } } }, "arinReallocateOrReassignDetailedRec": { "type": "object", "required": [ "arinType", "organizationInfo", "contactInfo", "networkContactInfo" ], "properties": { "arinType": { "type": "string", "description": "Use type value ARIN-Reallocate | ARIN-Reassign-Detailed" }, "organizationInfo": { "type": "object", "required": [ "orgName", "orgAddress", "orgCity", "orgCountryCode" ], "properties": { "downStreamOrgID": { "type": "integer" }, "orgName": { "type": "string" }, "orgAddress": { "type": "string" }, "orgCity": { "type": "string" }, "orgState": { "type": "string" }, "orgPostalCode": { "type": "string" }, "orgCountryCode": { "type": "string" }, "orgCustomizedInfo": { "type": "string" } } }, "contactInfo": { "type": "object", "required": [ "orgPocContactType", "orgPocLastNameOrRoleAccount", "orgPocFirstName", "orgPocAddress", "orgPocCity", "orgPocCountryCode", "orgPocPhoneNumber", "orgPocEmailAddress" ], "properties": { "orgPocHandle": { "type": "string" }, "orgPocContactType": { "type": "string", "description": "Use type PERSON | ROLE" }, "orgPocLastNameOrRoleAccount": { "type": "string" }, "orgPocFirstName": { "type": "string" }, "orgPocCompanyName": { "type": "string" }, "orgPocAddress": { "type": "string" }, "orgPocCity": { "type": "string" }, "orgPocState": { "type": "string" }, "orgPocPostalCode": { "type": "string" }, "orgPocCountryCode": { "type": "string" }, "orgPocPhoneNumber": { "type": "string" }, "orgPocEmailAddress": { "type": "string" }, "orgPocCustomizedInfo": { "type": "string" } } }, "networkInfo": { "type": "object", "properties": { "originAS": { "type": "string" }, "dnsHostName": { "type": "string" }, "networkCustomizedInfo": { "type": "string" } } }, "networkContactInfo": { "type": "object", "required": [ "netPocContactType", "netPocLastNameOrRoleAccount", "netPocFirstName", "netPocAddress", "netPocCity", "netPocCountryCode", "netPocPhoneNumber", "netPocEmailAddress" ], "properties": { "netPocType": { "type": "string", "description": "Use type T (Resource Technical Contact) \n AB (Resource Abuse Contact) \n N (Resource NOC Contact) \n T,AB(T and AB) | T,N (T and N) | AB,N (AB and N) | T,AB,N (T,AB and N)" }, "netPocHandle": { "type": "string" }, "netPocContactType": { "type": "string", "description": "Use type PERSON | ROLE" }, "netPocLastNameOrRoleAccount": { "type": "string" }, "netPocFirstName": { "type": "string" }, "netPocCompanyName": { "type": "string" }, "netPocAddress": { "type": "string" }, "netPocCity": { "type": "string" }, "netPocState": { "type": "string" }, "netPocPostalCode": { "type": "string" }, "netPocCountryCode": { "type": "string" }, "netPocPhoneNumber": { "type": "string" }, "netPocEmailAddress": { "type": "string" }, "netPocCustomizedInfo": { "type": "string" } } }, "publicComment": { "type": "string" }, "addInfo": { "type": "string" }, "othersCustomizedInfo": { "type": "string" } }, "example": { "arinType": "ARIN-Reallocate", "organizationInfo": { "orgName": "VitalQIP Organization", "orgAddress": "600 Mountain Avenue", "orgCity": "Murray Hill", "orgState": "NJ", "orgPostalCode": "07974", "orgCountryCode": "US", "orgCustomizedInfo": "Customer Info" }, "contactInfo": { "orgPocContactType": "PERSON", "orgPocLastNameOrRoleAccount": "my org POC last name", "orgPocFirstName": "my org POC First Name", "orgPocCompanyName": "my company name", "orgPocAddress": "600 Mountain Avenue", "orgPocCity": "Murray Hill", "orgPocState": "NJ", "orgPocPostalCode": "7974", "orgPocCountryCode": "US", "orgPocPhoneNumber": "891-345-5678", "orgPocEmailAddress": "orgPOCEmail@mycompany.com", "orgPocCustomizedInfo": "Customer Info" }, "networkInfo": { "originAS": "192.168.0.0", "dnsHostName": "dns@example.com", "networkCustomizedInfo": "Customer Info" }, "networkContactInfo": { "netPocType": "T", "netPocContactType": "PERSON", "netPocLastNameOrRoleAccount": "net POC Last Name", "netPocFirstName": "net Contact First Name", "netPocCompanyName": "Company Name", "netPocAddress": "600 Mountain Avenue", "netPocCity": "Murray Hill", "netPocState": "NJ", "netPocPostalCode": "07974", "netPocCountryCode": "US", "netPocPhoneNumber": "891-234-4567", "netPocEmailAddress": "netContactEmail@mycompany.com", "netPocCustomizedInfo": "Customer Info" }, "publicComment": "This is a sample block via VitalQIP API", "addInfo": "this is additional information", "othersCustomizedInfo": "Other Customized Info" } } }, "example": { "pool": { "name": "childPool", "parentName": "parentPool" }, "addressType": "V4", "networkContact": "a@a.a", "requireSpecificBlock": false, "prefixLength": 8, "startAddress": "10.0.0.0", "blockStatus": "FREE", "ruleName": "rule", "arinReassignSimpleReportRec": { "registrationAction": "NEW", "originAs": "192.168.0.0", "privateValue": false, "customerName": "Customer Name", "customerAddress": "600 Mountain Avenue", "customerCity": "Murray Hill", "customerState": "NJ", "customerPostalCode": "07974", "customerCountryCode": "US", "publicComment": "This is a sample block via VitalQIP API", "customizedInfo": "customer info" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/allocateBlock" }, "task": true }, { "name": "recoverBlock", "summary": "Recover block and send arin notify", "description": "Recover block and send arin notify", "input": [ { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"block\": {\"startAddress\": \"string\", \"prefixLength\": 123, \"addressType\": \"string\", \"pool\": {\"name\": \"string\", \"parentName\": \"string\"}, \"blockStatus\": \"string\"}, \"seedPoolName\": \"string\", \"arinReassignSimpleReportRec\": {\"registrationAction\": \"string\", \"originAs\": \"string\", \"privateValue\": \"boolean\", \"customerName\": \"string\", \"customerAddress\": \"string\", \"customerCity\": \"string\", \"customerState\": \"string\", \"customerPostalCode\": \"string\", \"customerCountryCode\": \"string\", \"publicComment\": \"string\", \"customizedInfo\": \"string\"}, \"arinReallocateOrReassignDetailedRec\": {\"arinType\": \"string\", \"organizationInfo\": {\"downStreamOrgID\": 123, \"orgName\": \"string\", \"orgAddress\": \"string\", \"orgCity\": \"string\", \"orgState\": \"string\", \"orgPostalCode\": \"string\", \"orgCountryCode\": \"string\", \"orgCustomizedInfo\": \"string\"}, \"contactInfo\": {\"orgPocHandle\": \"string\", \"orgPocContactType\": \"string\", \"orgPocLastNameOrRoleAccount\": \"string\", \"orgPocFirstName\": \"string\", \"orgPocCompanyName\": \"string\", \"orgPocAddress\": \"string\", \"orgPocCity\": \"string\", \"orgPocState\": \"string\", \"orgPocPostalCode\": \"string\", \"orgPocCountryCode\": \"string\", \"orgPocPhoneNumber\": \"string\", \"orgPocEmailAddress\": \"string\", \"orgPocCustomizedInfo\": \"string\"}, \"networkInfo\": {\"originAS\": \"string\", \"dnsHostName\": \"string\", \"networkCustomizedInfo\": \"string\"}, \"networkContactInfo\": {\"netPocType\": \"string\", \"netPocHandle\": \"string\", \"netPocContactType\": \"string\", \"netPocLastNameOrRoleAccount\": \"string\", \"netPocFirstName\": \"string\", \"netPocCompanyName\": \"string\", \"netPocAddress\": \"string\", \"netPocCity\": \"string\", \"netPocState\": \"string\", \"netPocPostalCode\": \"string\", \"netPocCountryCode\": \"string\", \"netPocPhoneNumber\": \"string\", \"netPocEmailAddress\": \"string\", \"netPocCustomizedInfo\": \"string\"}, \"publicComment\": \"string\", \"addInfo\": \"string\", \"othersCustomizedInfo\": \"string\"}}", "required": true, "schema": { "description": "Recover Arin Notification model", "required": [ "block", "seedPoolName" ], "properties": { "block": { "type": "object", "required": [ "pool", "prefixLength", "startAddress" ], "properties": { "startAddress": { "type": "string" }, "prefixLength": { "type": "integer" }, "addressType": { "type": "string" }, "pool": { "type": "object", "required": [ "name", "parentName" ], "properties": { "name": { "type": "string" }, "parentName": { "type": "string" } } }, "blockStatus": { "type": "string" } } }, "seedPoolName": { "type": "string" }, "arinReassignSimpleReportRec": { "type": "object", "required": [ "registrationAction" ], "properties": { "registrationAction": { "type": "string", "description": "Use action value NEW | MODIFY | REMOVE" }, "originAs": { "type": "string" }, "privateValue": { "type": "boolean" }, "customerName": { "type": "string" }, "customerAddress": { "type": "string" }, "customerCity": { "type": "string" }, "customerState": { "type": "string" }, "customerPostalCode": { "type": "string" }, "customerCountryCode": { "type": "string" }, "publicComment": { "type": "string" }, "customizedInfo": { "type": "string" } } }, "arinReallocateOrReassignDetailedRec": { "type": "object", "required": [ "arinType", "organizationInfo", "contactInfo", "networkContactInfo" ], "properties": { "arinType": { "type": "string", "description": "Use type value ARIN-Reallocate | ARIN-Reassign-Detailed" }, "organizationInfo": { "type": "object", "required": [ "orgName", "orgAddress", "orgCity", "orgCountryCode" ], "properties": { "downStreamOrgID": { "type": "integer" }, "orgName": { "type": "string" }, "orgAddress": { "type": "string" }, "orgCity": { "type": "string" }, "orgState": { "type": "string" }, "orgPostalCode": { "type": "string" }, "orgCountryCode": { "type": "string" }, "orgCustomizedInfo": { "type": "string" } } }, "contactInfo": { "type": "object", "required": [ "orgPocContactType", "orgPocLastNameOrRoleAccount", "orgPocFirstName", "orgPocAddress", "orgPocCity", "orgPocCountryCode", "orgPocPhoneNumber", "orgPocEmailAddress" ], "properties": { "orgPocHandle": { "type": "string" }, "orgPocContactType": { "type": "string", "description": "Use type PERSON | ROLE" }, "orgPocLastNameOrRoleAccount": { "type": "string" }, "orgPocFirstName": { "type": "string" }, "orgPocCompanyName": { "type": "string" }, "orgPocAddress": { "type": "string" }, "orgPocCity": { "type": "string" }, "orgPocState": { "type": "string" }, "orgPocPostalCode": { "type": "string" }, "orgPocCountryCode": { "type": "string" }, "orgPocPhoneNumber": { "type": "string" }, "orgPocEmailAddress": { "type": "string" }, "orgPocCustomizedInfo": { "type": "string" } } }, "networkInfo": { "type": "object", "properties": { "originAS": { "type": "string" }, "dnsHostName": { "type": "string" }, "networkCustomizedInfo": { "type": "string" } } }, "networkContactInfo": { "type": "object", "required": [ "netPocContactType", "netPocLastNameOrRoleAccount", "netPocFirstName", "netPocAddress", "netPocCity", "netPocCountryCode", "netPocPhoneNumber", "netPocEmailAddress" ], "properties": { "netPocType": { "type": "string", "description": "Use type T (Resource Technical Contact) \n AB (Resource Abuse Contact) \n N (Resource NOC Contact) \n T,AB(T and AB) | T,N (T and N) | AB,N (AB and N) | T,AB,N (T,AB and N)" }, "netPocHandle": { "type": "string" }, "netPocContactType": { "type": "string", "description": "Use type PERSON | ROLE" }, "netPocLastNameOrRoleAccount": { "type": "string" }, "netPocFirstName": { "type": "string" }, "netPocCompanyName": { "type": "string" }, "netPocAddress": { "type": "string" }, "netPocCity": { "type": "string" }, "netPocState": { "type": "string" }, "netPocPostalCode": { "type": "string" }, "netPocCountryCode": { "type": "string" }, "netPocPhoneNumber": { "type": "string" }, "netPocEmailAddress": { "type": "string" }, "netPocCustomizedInfo": { "type": "string" } } }, "publicComment": { "type": "string" }, "addInfo": { "type": "string" }, "othersCustomizedInfo": { "type": "string" } }, "example": { "arinType": "ARIN-Reallocate", "organizationInfo": { "orgName": "VitalQIP Organization", "orgAddress": "600 Mountain Avenue", "orgCity": "Murray Hill", "orgState": "NJ", "orgPostalCode": "07974", "orgCountryCode": "US", "orgCustomizedInfo": "Customer Info" }, "contactInfo": { "orgPocContactType": "PERSON", "orgPocLastNameOrRoleAccount": "my org POC last name", "orgPocFirstName": "my org POC First Name", "orgPocCompanyName": "my company name", "orgPocAddress": "600 Mountain Avenue", "orgPocCity": "Murray Hill", "orgPocState": "NJ", "orgPocPostalCode": "7974", "orgPocCountryCode": "US", "orgPocPhoneNumber": "891-345-5678", "orgPocEmailAddress": "orgPOCEmail@mycompany.com", "orgPocCustomizedInfo": "Customer Info" }, "networkInfo": { "originAS": "192.168.0.0", "dnsHostName": "dns@example.com", "networkCustomizedInfo": "Customer Info" }, "networkContactInfo": { "netPocType": "T", "netPocContactType": "PERSON", "netPocLastNameOrRoleAccount": "net POC Last Name", "netPocFirstName": "net Contact First Name", "netPocCompanyName": "Company Name", "netPocAddress": "600 Mountain Avenue", "netPocCity": "Murray Hill", "netPocState": "NJ", "netPocPostalCode": "07974", "netPocCountryCode": "US", "netPocPhoneNumber": "891-234-4567", "netPocEmailAddress": "netContactEmail@mycompany.com", "netPocCustomizedInfo": "Customer Info" }, "publicComment": "This is a sample block via VitalQIP API", "addInfo": "this is additional information", "othersCustomizedInfo": "Other Customized Info" } } }, "example": { "block": { "startAddress": "10.0.0.0", "prefixLength": 16, "addressType": "V4", "pool": { "name": "childPool", "parentName": "parentPool" }, "blockStatus": "FREE" }, "seedPoolName": "parentPool", "arinReassignSimpleReportRec": { "registrationAction": "NEW", "originAs": "192.168.0.0", "privateValue": false, "customerName": "Customer Name", "customerAddress": "600 Mountain Avenue", "customerCity": "Murray Hill", "customerState": "NJ", "customerPostalCode": "07974", "customerCountryCode": "US", "publicComment": "This is a sample block via VitalQIP API", "customizedInfo": "customer info" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/recoverBlock" }, "task": true }, { "name": "quickBlock", "summary": "Quick block and send arin notify", "description": "Quick block and send arin notify", "input": [ { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"pool\": {\"name\": \"string\", \"parentName\": \"string\"}, \"addressType\": \"string\", \"networkContact\": \"string\", \"poolContact\": \"string\", \"ruleName\": \"string\", \"subnetName\": \"string\", \"seedPoolName\": \"string\", \"arinReassignSimpleReportRec\": {\"registrationAction\": \"string\", \"originAs\": \"string\", \"privateValue\": \"boolean\", \"customerName\": \"string\", \"customerAddress\": \"string\", \"customerCity\": \"string\", \"customerState\": \"string\", \"customerPostalCode\": \"string\", \"customerCountryCode\": \"string\", \"publicComment\": \"string\", \"customizedInfo\": \"string\"}, \"arinReallocateOrReassignDetailedRec\": {\"arinType\": \"string\", \"organizationInfo\": {\"downStreamOrgID\": 123, \"orgName\": \"string\", \"orgAddress\": \"string\", \"orgCity\": \"string\", \"orgState\": \"string\", \"orgPostalCode\": \"string\", \"orgCountryCode\": \"string\", \"orgCustomizedInfo\": \"string\"}, \"contactInfo\": {\"orgPocHandle\": \"string\", \"orgPocContactType\": \"string\", \"orgPocLastNameOrRoleAccount\": \"string\", \"orgPocFirstName\": \"string\", \"orgPocCompanyName\": \"string\", \"orgPocAddress\": \"string\", \"orgPocCity\": \"string\", \"orgPocState\": \"string\", \"orgPocPostalCode\": \"string\", \"orgPocCountryCode\": \"string\", \"orgPocPhoneNumber\": \"string\", \"orgPocEmailAddress\": \"string\", \"orgPocCustomizedInfo\": \"string\"}, \"networkInfo\": {\"originAS\": \"string\", \"dnsHostName\": \"string\", \"networkCustomizedInfo\": \"string\"}, \"networkContactInfo\": {\"netPocType\": \"string\", \"netPocHandle\": \"string\", \"netPocContactType\": \"string\", \"netPocLastNameOrRoleAccount\": \"string\", \"netPocFirstName\": \"string\", \"netPocCompanyName\": \"string\", \"netPocAddress\": \"string\", \"netPocCity\": \"string\", \"netPocState\": \"string\", \"netPocPostalCode\": \"string\", \"netPocCountryCode\": \"string\", \"netPocPhoneNumber\": \"string\", \"netPocEmailAddress\": \"string\", \"netPocCustomizedInfo\": \"string\"}, \"publicComment\": \"string\", \"addInfo\": \"string\", \"othersCustomizedInfo\": \"string\"}}", "required": true, "schema": { "description": "Quick Block Allocate model", "required": [ "pool", "networkContact", "ruleName", "seedPoolName" ], "properties": { "pool": { "type": "object", "required": [ "name", "parentName" ], "properties": { "name": { "type": "string" }, "parentName": { "type": "string" } } }, "addressType": { "type": "string", "description": "Use address type V4" }, "networkContact": { "type": "string", "description": "Require if rule type is SITE or USED." }, "poolContact": { "type": "string", "description": "If child pool is not found, User need enter poolContact field to create new child pool" }, "ruleName": { "type": "string" }, "subnetName": { "type": "string" }, "seedPoolName": { "type": "string" }, "arinReassignSimpleReportRec": { "type": "object", "required": [ "registrationAction" ], "properties": { "registrationAction": { "type": "string", "description": "Use action value NEW | MODIFY | REMOVE" }, "originAs": { "type": "string" }, "privateValue": { "type": "boolean" }, "customerName": { "type": "string" }, "customerAddress": { "type": "string" }, "customerCity": { "type": "string" }, "customerState": { "type": "string" }, "customerPostalCode": { "type": "string" }, "customerCountryCode": { "type": "string" }, "publicComment": { "type": "string" }, "customizedInfo": { "type": "string" } } }, "arinReallocateOrReassignDetailedRec": { "type": "object", "required": [ "arinType", "organizationInfo", "contactInfo", "networkContactInfo" ], "properties": { "arinType": { "type": "string", "description": "Use type value ARIN-Reallocate | ARIN-Reassign-Detailed" }, "organizationInfo": { "type": "object", "required": [ "orgName", "orgAddress", "orgCity", "orgCountryCode" ], "properties": { "downStreamOrgID": { "type": "integer" }, "orgName": { "type": "string" }, "orgAddress": { "type": "string" }, "orgCity": { "type": "string" }, "orgState": { "type": "string" }, "orgPostalCode": { "type": "string" }, "orgCountryCode": { "type": "string" }, "orgCustomizedInfo": { "type": "string" } } }, "contactInfo": { "type": "object", "required": [ "orgPocContactType", "orgPocLastNameOrRoleAccount", "orgPocFirstName", "orgPocAddress", "orgPocCity", "orgPocCountryCode", "orgPocPhoneNumber", "orgPocEmailAddress" ], "properties": { "orgPocHandle": { "type": "string" }, "orgPocContactType": { "type": "string", "description": "Use type PERSON | ROLE" }, "orgPocLastNameOrRoleAccount": { "type": "string" }, "orgPocFirstName": { "type": "string" }, "orgPocCompanyName": { "type": "string" }, "orgPocAddress": { "type": "string" }, "orgPocCity": { "type": "string" }, "orgPocState": { "type": "string" }, "orgPocPostalCode": { "type": "string" }, "orgPocCountryCode": { "type": "string" }, "orgPocPhoneNumber": { "type": "string" }, "orgPocEmailAddress": { "type": "string" }, "orgPocCustomizedInfo": { "type": "string" } } }, "networkInfo": { "type": "object", "properties": { "originAS": { "type": "string" }, "dnsHostName": { "type": "string" }, "networkCustomizedInfo": { "type": "string" } } }, "networkContactInfo": { "type": "object", "required": [ "netPocContactType", "netPocLastNameOrRoleAccount", "netPocFirstName", "netPocAddress", "netPocCity", "netPocCountryCode", "netPocPhoneNumber", "netPocEmailAddress" ], "properties": { "netPocType": { "type": "string", "description": "Use type T (Resource Technical Contact) \n AB (Resource Abuse Contact) \n N (Resource NOC Contact) \n T,AB(T and AB) | T,N (T and N) | AB,N (AB and N) | T,AB,N (T,AB and N)" }, "netPocHandle": { "type": "string" }, "netPocContactType": { "type": "string", "description": "Use type PERSON | ROLE" }, "netPocLastNameOrRoleAccount": { "type": "string" }, "netPocFirstName": { "type": "string" }, "netPocCompanyName": { "type": "string" }, "netPocAddress": { "type": "string" }, "netPocCity": { "type": "string" }, "netPocState": { "type": "string" }, "netPocPostalCode": { "type": "string" }, "netPocCountryCode": { "type": "string" }, "netPocPhoneNumber": { "type": "string" }, "netPocEmailAddress": { "type": "string" }, "netPocCustomizedInfo": { "type": "string" } } }, "publicComment": { "type": "string" }, "addInfo": { "type": "string" }, "othersCustomizedInfo": { "type": "string" } }, "example": { "arinType": "ARIN-Reallocate", "organizationInfo": { "orgName": "VitalQIP Organization", "orgAddress": "600 Mountain Avenue", "orgCity": "Murray Hill", "orgState": "NJ", "orgPostalCode": "07974", "orgCountryCode": "US", "orgCustomizedInfo": "Customer Info" }, "contactInfo": { "orgPocContactType": "PERSON", "orgPocLastNameOrRoleAccount": "my org POC last name", "orgPocFirstName": "my org POC First Name", "orgPocCompanyName": "my company name", "orgPocAddress": "600 Mountain Avenue", "orgPocCity": "Murray Hill", "orgPocState": "NJ", "orgPocPostalCode": "7974", "orgPocCountryCode": "US", "orgPocPhoneNumber": "891-345-5678", "orgPocEmailAddress": "orgPOCEmail@mycompany.com", "orgPocCustomizedInfo": "Customer Info" }, "networkInfo": { "originAS": "192.168.0.0", "dnsHostName": "dns@example.com", "networkCustomizedInfo": "Customer Info" }, "networkContactInfo": { "netPocType": "T", "netPocContactType": "PERSON", "netPocLastNameOrRoleAccount": "net POC Last Name", "netPocFirstName": "net Contact First Name", "netPocCompanyName": "Company Name", "netPocAddress": "600 Mountain Avenue", "netPocCity": "Murray Hill", "netPocState": "NJ", "netPocPostalCode": "07974", "netPocCountryCode": "US", "netPocPhoneNumber": "891-234-4567", "netPocEmailAddress": "netContactEmail@mycompany.com", "netPocCustomizedInfo": "Customer Info" }, "publicComment": "This is a sample block via VitalQIP API", "addInfo": "this is additional information", "othersCustomizedInfo": "Other Customized Info" } } }, "example": { "pool": { "name": "childPool", "parentName": "parentPool" }, "addressType": "V4", "networkContact": "a1@a.a", "poolContact": "a2@a.a", "ruleName": "rule", "subnetName": "subnet1", "seedPoolName": "parentPool", "arinReassignSimpleReportRec": { "registrationAction": "NEW", "originAs": "192.168.0.0", "privateValue": false, "customerName": "Customer Name", "customerAddress": "600 Mountain Avenue", "customerCity": "Murray Hill", "customerState": "NJ", "customerPostalCode": "07974", "customerCountryCode": "US", "publicComment": "This is a sample block via VitalQIP API", "customizedInfo": "customer info" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/quickBlock" }, "task": true }, { "name": "checkStatus", "summary": "Check status of a job", "description": "Check the status of a DNS or DHCP generation using a token from the DNS or DHCP Generation response.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "token", "type": "string", "info": "Token of the job you want to retrieve.: string", "required": true, "schema": { "title": "token", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/checkStatus" }, "task": true }, { "name": "downloadConfigFiles", "summary": "Download push configuration files", "description": "Use this URL to download DNS and DHCP server configuration files.\n\nWhen using cURL with this API specify \"-o fileName.extension\" to download file contents.\n\nInternet Explorer browser users: to download the report please right click the “Download file” link and select “Save as” then input the desired file name with the correct extension.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "token", "type": "string", "info": "Token of the server generation job.: string", "required": true, "schema": { "title": "token", "type": "string" } }, { "name": "files", "type": "string", "info": "Name of individual file(s)s to be downloaded. Multiple files names must be separated by a comma (,). All available files are downloaded if this field is not specified. Th...(description truncated): string", "required": false, "schema": { "title": "files", "type": "string" } }, { "name": "type", "type": "string", "info": "File compression type. Either \"zip\" or \"gzip\". This field is not required.: Must be one of [zip, gzip]", "required": false, "schema": { "title": "type", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/downloadConfigFiles" }, "task": true }, { "name": "decodeX509Certificate", "summary": "Decode encoded certificate", "description": "Decode base64-encoded certificate", "input": [ { "name": "certificate", "type": "string", "info": "Encoded certificate: string", "required": true, "schema": { "type": "string", "example": "MIIDRzCCAi+gAwIBAgIEBrAUNDANBgkqhkiG9w0BAQsFADBMQswCQYDVQQGEwJWTjENMAsGA1...", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/decodeX509Certificate" }, "task": true }, { "name": "generateKeyPair", "summary": "Generate certificate key pair (self-signed)", "description": "Generate certificate key pair (self-signed)", "input": [ { "name": "requestBody", "type": "object", "info": "Certificate information request body: {\"expirationDate\": \"string\", \"commonName\": \"string\", \"organizationUnit\": \"string\", \"organizationName\": \"string\", \"localityName\": \"string\", \"stateName\": \"string\", \"country\": \"string\"}", "required": true, "schema": { "type": "object", "required": [ "commonName" ], "properties": { "expirationDate": { "type": "string", "description": "The expiration date of certificate, support the following date formats: yyyy-MM-dd" }, "commonName": { "type": "string", "description": " Common name of a person" }, "organizationUnit": { "type": "string", "description": "Small organization name" }, "organizationName": { "type": "string", "description": "Large organization name" }, "localityName": { "type": "string", "description": "Locality (city) name" }, "stateName": { "type": "string", "description": "State or province name" }, "country": { "type": "string", "description": "Two-letter country code" } }, "example": { "expirationDate": "2030-06-28", "commonName": "qipman", "organizationUnit": "Vital QIP", "organizationName": "NOKIA", "localityName": "San Francisco", "stateName": "California", "country": "US" }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/generateKeyPair" }, "task": true }, { "name": "addSamlIdp", "summary": "Create SAML Identity Provider", "description": "Create a new SAML Identity Provider\n", "input": [ { "name": "requestBody", "type": "object", "info": "The SAML Identity Provider request body: {\"name\": \"string\", \"newName\": \"string\", \"active\": \"boolean\", \"entityId\": \"string\", \"singleSignOnUrl\": \"string\", \"singleSignOnMethod\": \"string\", \"singleLogoutUrl\": \"string\", \"singleLogoutMethod\": \"string\", \"signingCertificate\": \"string\", \"useSigningForEncryption\": \"boolean\", \"encryptionCertificate\": \"boolean\", \"lastUpdateDate\": \"string\"}", "required": true, "schema": { "type": "object", "description": "SAML Identity Provider", "required": [ "name", "entityId", "singleSignOnUrl", "singleSignOnMethod", "signingCertificate" ], "properties": { "name": { "type": "string", "description": "Name of the SAML Identity Provider. Allows letters, numbers and spaces. Leading and trailing white space will be removed before saving" }, "newName": { "type": "string", "description": "New name of the SAML Identity Provider. Allows letters, numbers and spaces. Leading and trailing white space will be removed before saving" }, "active": { "type": "boolean", "description": "Indicates whether the SAML Identity Provider is currently active" }, "entityId": { "type": "string", "description": "EntityID field of the SAML Identity Provider" }, "singleSignOnUrl": { "type": "string", "description": "URL that will be use for Single Sign On. Must be a valid URL" }, "singleSignOnMethod": { "type": "string", "description": "The method that will be use for Single Sign On. \"POST\" or \"REDIRECT\"" }, "singleLogoutUrl": { "type": "string", "description": "URL that will be use for Single Logout. Must be a valid URL" }, "singleLogoutMethod": { "type": "string", "description": "The method that will be use for Single Logout. \"POST\" or \"REDIRECT\"" }, "signingCertificate": { "type": "string", "description": "The base-64 ENCODED certificate will be used to sign SAML requests" }, "useSigningForEncryption": { "type": "boolean", "description": "Indicate that the signing certificate will be use for encrypting SAML requests. If true the value of the signingCertificate will be used for encrypting certificates and the encryptionCertificate value should be left blank" }, "encryptionCertificate": { "type": "boolean", "description": "The base-64 ENCODED certificate that will be used to encrypt SAML requests" }, "lastUpdateDate": { "type": "string", "description": "The last time (YYYY-MM-DD hh:mm:ss.s) that SAML Identity Provider was updated. This field is maintained by the system and cannot be updated" } }, "example": { "name": "ADFS QIP", "newName": "ADFS QIP1", "active": true, "entityId": "http://idp.example.com/adfs/services/trust", "singleSignOnUrl": "https://idp.example.com/adfs/ls", "singleSignOnMethod": "Redirect", "singleLogoutUrl": "https://idp.example.com/adfs/ls", "singleLogoutMethod": "POST", "signingCertificate": "MIIDRzCCAi+gAwIBAgIEBrAUNDANBgkqhkiG9w0BAQsFADBMQswCQYDVQQGEwJWTjENMAsGA1...", "useSigningForEncryption": false, "encryptionCertificate": "MIIDRzCCAi+gAwIBAgIEBrAUNDANBgkqhkiG9w0BAQsFADBMQswCQYDVQQGEwJWTjENMAsGA1...", "lastUpdateDate": "2017-03-28 11:25:27.656" }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addSamlIdp" }, "task": true }, { "name": "modifySamlIdentityProvider", "summary": "Modify SAML Identity Provider", "description": "Modify a SAML Identity Provider\n", "input": [ { "name": "requestBody", "type": "object", "info": "The SAML Identity Provider request body: {\"name\": \"string\", \"newName\": \"string\", \"active\": \"boolean\", \"entityId\": \"string\", \"singleSignOnUrl\": \"string\", \"singleSignOnMethod\": \"string\", \"singleLogoutUrl\": \"string\", \"singleLogoutMethod\": \"string\", \"signingCertificate\": \"string\", \"useSigningForEncryption\": \"boolean\", \"encryptionCertificate\": \"boolean\", \"lastUpdateDate\": \"string\"}", "required": true, "schema": { "type": "object", "description": "SAML Identity Provider", "required": [ "name", "entityId", "singleSignOnUrl", "singleSignOnMethod", "signingCertificate" ], "properties": { "name": { "type": "string", "description": "Name of the SAML Identity Provider. Allows letters, numbers and spaces. Leading and trailing white space will be removed before saving" }, "newName": { "type": "string", "description": "New name of the SAML Identity Provider. Allows letters, numbers and spaces. Leading and trailing white space will be removed before saving" }, "active": { "type": "boolean", "description": "Indicates whether the SAML Identity Provider is currently active" }, "entityId": { "type": "string", "description": "EntityID field of the SAML Identity Provider" }, "singleSignOnUrl": { "type": "string", "description": "URL that will be use for Single Sign On. Must be a valid URL" }, "singleSignOnMethod": { "type": "string", "description": "The method that will be use for Single Sign On. \"POST\" or \"REDIRECT\"" }, "singleLogoutUrl": { "type": "string", "description": "URL that will be use for Single Logout. Must be a valid URL" }, "singleLogoutMethod": { "type": "string", "description": "The method that will be use for Single Logout. \"POST\" or \"REDIRECT\"" }, "signingCertificate": { "type": "string", "description": "The base-64 ENCODED certificate will be used to sign SAML requests" }, "useSigningForEncryption": { "type": "boolean", "description": "Indicate that the signing certificate will be use for encrypting SAML requests. If true the value of the signingCertificate will be used for encrypting certificates and the encryptionCertificate value should be left blank" }, "encryptionCertificate": { "type": "boolean", "description": "The base-64 ENCODED certificate that will be used to encrypt SAML requests" }, "lastUpdateDate": { "type": "string", "description": "The last time (YYYY-MM-DD hh:mm:ss.s) that SAML Identity Provider was updated. This field is maintained by the system and cannot be updated" } }, "example": { "name": "ADFS QIP", "newName": "ADFS QIP1", "active": true, "entityId": "http://idp.example.com/adfs/services/trust", "singleSignOnUrl": "https://idp.example.com/adfs/ls", "singleSignOnMethod": "Redirect", "singleLogoutUrl": "https://idp.example.com/adfs/ls", "singleLogoutMethod": "POST", "signingCertificate": "MIIDRzCCAi+gAwIBAgIEBrAUNDANBgkqhkiG9w0BAQsFADBMQswCQYDVQQGEwJWTjENMAsGA1...", "useSigningForEncryption": false, "encryptionCertificate": "MIIDRzCCAi+gAwIBAgIEBrAUNDANBgkqhkiG9w0BAQsFADBMQswCQYDVQQGEwJWTjENMAsGA1...", "lastUpdateDate": "2017-03-28 11:25:27.656" }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifySamlIdentityProvider" }, "task": true }, { "name": "getByName", "summary": "Get SAML Identity Provider by name", "description": "Get SAML Identity Provider by name", "input": [ { "name": "extension", "type": "string", "info": ".json or null if you want to reponse with JSON format\n\n.xml to reponse with XML format\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "samlIdpName", "type": "string", "info": "Name of the SAML Identity Provider that you want to get: string", "required": true, "schema": { "title": "samlIdpName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getByName" }, "task": true }, { "name": "searchSamlIdpByName", "summary": "Search SAML Identity Providers by name", "description": "Search SAML Identity Providers by name\n", "input": [ { "name": "extension", "type": "string", "info": ".json if you want to reponse with JSON format \n.xml to reponse with XML format\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "samlIdpName", "type": "string", "info": "Name of SAML Identity Provider for which you are searching.\nYou can use an asterisk (*) as a wildcard character to \nreturn a range of results. If you use the asterisk as ...(description truncated): string", "required": true, "schema": { "title": "samlIdpName", "type": "string" } }, { "name": "pageIndex", "type": "number", "info": "Page index. Default value is 1.: 123", "required": false, "schema": { "title": "pageIndex", "type": "number" } }, { "name": "pageSize", "type": "number", "info": "Page size. Default value is 25.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "description": "SAML Identity Provider information summary", "required": [ "name", "entityId" ], "properties": { "name": { "type": "string", "description": "Name of the SAML Identity Provider. Allows letters, numbers and spaces" }, "active": { "type": "boolean", "description": "Indicates whether the SAML Identity Provider is currently active" }, "entityId": { "type": "string", "description": "EntityID field of the SAML Identity Provider" }, "lastUpdateDate": { "type": "string", "description": "The last time (YYYY-MM-DD hh:mm:ss.s) that SAML Identity Provider was updated. This field is maintained by the system and cannot be updated" } }, "example": { "name": "ADFS QIP", "active": true, "entityId": "http://idp.example.com/adfs/services/trust", "lastUpdateDate": "2017-03-28 11:25:27.656" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchSamlIdpByName" }, "task": true }, { "name": "deleteSAMLIdentityProvider", "summary": "Delete SAML Identity Provider", "description": "Delete a SAML Identity Provider by name.\n", "input": [ { "name": "samlIdpName", "type": "string", "info": "Name of the SAML Identity Provider being deleted.\n: string", "required": true, "schema": { "title": "samlIdpName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/delete" }, "task": true }, { "name": "updateSamlConfiguration", "summary": "Update SAML Configuration", "description": "Update VitalQIP's SAML Configuration. To leave a field value unchanged in the configuration, exclude it from the request body.", "input": [ { "name": "requestBody", "type": "object", "info": "The SAML Configuration request body: {\"enable\": \"boolean\", \"samlIdpName\": \"string\", \"assertionConsumerUrl\": \"string\", \"singleLogoutUrl\": \"string\", \"entityId\": \"string\", \"privateEncryptionKey\": \"string\", \"encryptionCertificate\": \"string\", \"hashAlgorithm\": \"string\"}", "required": true, "schema": { "type": "object", "description": "SAML Configuration", "required": [ "samlIdpName", "assertionConsumerUrl", "privateEncryptionKey", "encryptionCertificate", "hashAlgorithm" ], "properties": { "enable": { "type": "boolean", "description": "Enable/Disable the Login with SAML" }, "samlIdpName": { "type": "string", "description": "Required. Name of the SAML Identity Provider that will be used for SAML Configuration" }, "assertionConsumerUrl": { "type": "string", "description": "Required. The Assertion Consumer URL in Service Provider side (QIP side). This field is READ-ONLY, it's use to register QIP with the SAML Identity Provider" }, "singleLogoutUrl": { "type": "string", "description": "Optional. URL at Service Provider side (QIP side) that will be used for Single Logout. This field is READ-ONLY, it's use to register QIP with the SAML Identity Provider." }, "entityId": { "type": "string", "description": "The entity ID of Service Provider side (QIP side) that will be used to identify SAML node" }, "privateEncryptionKey": { "type": "string", "description": "Required. The base-64 ENCODED Key in Service Provider side (QIP side) that will be used in encrypting SAML requests" }, "encryptionCertificate": { "type": "string", "description": "Required. The base-64 ENCODED Certificate in Service Provider side (QIP side) that will be used in encrypting SAML requests" }, "hashAlgorithm": { "type": "string", "description": "The cryptographic algorithm that computes the digest of the digital signatures in the SAML protocol messages. Either \"SHA-1\" or \"SHA-256\"." } }, "example": { "enable": true, "samlIdpName": "ADFS QIP1", "assertionConsumerUrl": "https://vitalqip.example.com:743/saml/SSO", "singleLogoutUrl": "https://vitalqip.example.com:743/saml/SingleLogout", "entityId": "https://vitalqip.example.com:743/saml/metadata", "privateEncryptionKey": "MIIDRzCCAi+gAwIBAgIEBrAUNDANBgkqhkiG9w0BAQsFADBMQswCQYDVQQGEwJWTjENMAsGA1...", "encryptionCertificate": "MIIDRzCCAi+gAwIBAgIEBrAUNDANBgkqhkiG9w0BAQsFADBMQswCQYDVQQGEwJWTjENMAsGA1...", "hashAlgorithm": "SHA256" }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateSamlConfiguration" }, "task": true }, { "name": "getSamlConfiguration", "summary": "Get SAML Configuration", "description": "Get SAML Configuration", "input": [ { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSamlConfiguration" }, "task": true }, { "name": "getRunningSamlConfiguration", "summary": "Get running configuration", "description": "Get running version of the SAML Configuration", "input": [ { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRunningSamlConfiguration" }, "task": true }, { "name": "qipSearch", "summary": "qip-search", "description": "Search through various name or address fields in the database and returns the address, name and object type of records matching the search criteria.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "name", "type": "string", "info": "Specifies the name which you are searching for. Support the wildcard search with following forms: ✱ or ✱abc or abc✱ or a✱c;: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "address", "type": "string", "info": "Specifies the IP address which you are searching for. IPv4 / IPv6 address or IPv6 address/prefix length can be use.: string", "required": false, "schema": { "title": "address", "type": "string" } }, { "name": "searchType", "type": "string", "info": "Specifies the search type that you want to search for. One of following values:\n\n'All', 'Subnetorg', 'Domain', 'Network', 'Object', 'Router Group', 'Mac Address' (For sea...(description truncated): string", "required": false, "schema": { "title": "searchType", "type": "string" } }, { "name": "subSearchType", "type": "string", "info": "The search type within the search_type value (above).\nThis option is only relevant when your searchType is\n\"ResourceRecord\". One of following values:\n\n'All', 'Object', 'D...(description truncated): string", "required": false, "schema": { "title": "subSearchType", "type": "string" } }, { "name": "subRange", "type": "string", "info": "Specifies the \"Resource Record\" type.One of following values:\n\n'All', 'CNAME', 'A', 'HINFO', 'MX', 'NS', 'PTR', 'TXT', 'WKS', 'AAAA', 'AFSDB', 'MB', 'MG', 'MINFO', '...(description truncated): string", "required": false, "schema": { "title": "subRange", "type": "string" } }, { "name": "target", "type": "string", "info": "Specifies the search target. This\nparameter is only relevant if your search_type is\n\"ResourceRecord\". One of following values:\n\n'both', 'owner', 'data'.\n\nThe default valu...(description truncated): string", "required": false, "schema": { "title": "target", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/qipSearch" }, "task": true }, { "name": "getV1OrgNameManagedTsigkeyExtension", "summary": "Get managed TSIG keys used to secure VitalQIP TSIG DNS updates", "description": "Get managed TSIG keys used to secure VitalQIP TSIG DNS updates", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Name of the TSIG key." }, "keyCreationDate": { "type": "number", "description": "The date (in Unix epoch milliseconds) when the key is created." }, "keyState": { "type": "string", "description": "Active: This key is in use. Pending: This key needs to be published before use. Waiting: Waiting for qip-genddnsconfs to complete." }, "server": { "type": "string", "description": "Name of the DNS server." }, "publicationDate": { "type": "number", "description": "The date (in Unix epoch milliseconds) when the key is pushed successfully to the server." }, "publicationRequired": { "type": "boolean", "description": "Is it necessary to publish a key to this server before the key can become Active." } }, "example": { "key": "vitalqip-1-1", "keyCreationDate": 1496647905567, "keyState": "Active", "server": "example.com", "publicationDate": 1496721269305, "publicationRequired": true } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getV1OrgNameManagedTsigkeyExtension" }, "task": true }, { "name": "postV1OrgNameManagedTsigkey", "summary": "Initiate a manual managed TSIG key rollover", "description": "Initiate a manual managed TSIG key rollover", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"keyAlgorithm\": \"string\", \"keyLength\": 123}", "required": true, "schema": { "type": "object", "required": [ "keyAlgorithm", "keyLength" ], "properties": { "keyAlgorithm": { "type": "string", "description": "Algorithm for creating new managed TSIG key. It must be one of the following values: HMAC-MD5, HMAC-SHA1, HMAC-SHA224, HMAC-SHA256, HMAC-SHA384, HMAC-SHA512." }, "keyLength": { "type": "number", "description": "Length for creating new managed TSIG key. It must adhere to the selected algorithm." } }, "example": { "keyAlgorithm": "HMAC-MD5", "keyLength": 512 }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postV1OrgNameManagedTsigkey" }, "task": true }, { "name": "getAdmin", "summary": "Get an administrator account.", "description": "Get an administrator account.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "loginName", "type": "string", "info": "Login Name: string", "required": true, "schema": { "title": "loginName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getAdmin" }, "task": true }, { "name": "searchAdmin", "summary": "Search administrator.", "description": "Search administrator by login name, admin type or admin status. It just return basic information of admin such as loginName, adminType, authenticationType and assignedOrganizations if it's Normal Administrator.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "loginName", "type": "string", "info": "Login name of the administrator for which you are searching.\nYou can use an asterisk (*) as a wildcard character to \nreturn a range of results.: string", "required": false, "schema": { "title": "loginName", "type": "string" } }, { "name": "adminType", "type": "string", "info": "Administrator type: Must be one of [All, Normal, Master]", "required": false, "schema": { "title": "adminType", "type": "string" } }, { "name": "adminStatus", "type": "string", "info": "Administrator status: Must be one of [All, Enabled, Disabled]", "required": false, "schema": { "title": "adminStatus", "type": "string" } }, { "name": "pageIndex", "type": "number", "info": "Page index. Default value is 1.: 123", "required": false, "schema": { "title": "pageIndex", "type": "number" } }, { "name": "pageSize", "type": "number", "info": "Page size. Default value is 25.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchAdmin" }, "task": true }, { "name": "createAdmin", "summary": "Create an administrator account.", "description": "Create an administrator account.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"loginName\": \"string\", \"password\": \"string\", \"adminType\": \"string\", \"authenticationType\": \"string\", \"contact\": {\"lastName\": \"string\", \"firstName\": \"string\"}, \"location\": {\"street1\": \"string\", \"street2\": \"string\", \"city\": \"string\", \"state\": \"string\", \"zip\": \"string\", \"country\": \"string\"}, \"businessUnitID\": \"string\", \"defaultPrinter\": \"string\", \"assignedOrganizations\": [{\"orgName\": \"string\", \"managedType\": \"string\", \"accessPermission\": \"string\", \"useDefaultOrgPrivileges\": \"string\", \"organizationPrivileges\": [{\"privilegeName\": \"string\", \"value\": \"string\"}]}], \"globalPrivileges\": [{\"privilegeName\": \"string\", \"value\": \"string\"}], \"organizationPrivilegesDefault\": [{\"privilegeName\": \"string\", \"value\": \"string\"}]}", "required": true, "schema": { "type": "object", "description": "Admin model", "required": [ "loginName", "password", "adminType", "authenticationType", "globalPrivileges" ], "properties": { "loginName": { "type": "string", "description": "Login name" }, "password": { "type": "string", "description": "Password" }, "adminType": { "type": "string", "description": "Administrator Type: Master or Normal" }, "authenticationType": { "type": "string", "description": "Authentication Type. One of following values: \n\n'Password',
'Certificate',
'SAML Managed',
'SAML Authenticated'" }, "contact": { "type": "object", "description": "Person Profile", "properties": { "lastName": { "type": "string", "description": "Last Name" }, "firstName": { "type": "string", "description": "First Name" } } }, "location": { "type": "object", "description": "Location", "properties": { "street1": { "type": "string", "description": "Street1" }, "street2": { "type": "string", "description": "Street2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State" }, "zip": { "type": "string", "description": "Zip" }, "country": { "type": "string", "description": "Country" } } }, "businessUnitID": { "type": "string", "description": "Business Unit ID" }, "defaultPrinter": { "type": "string", "description": "Default Printer ID" }, "assignedOrganizations": { "type": "array", "description": "The Organizations to be assigned with Normal Administrator", "items": { "type": "object", "properties": { "orgName": { "type": "string", "description": "Organization Name" }, "managedType": { "type": "string", "description": "Managed Type" }, "accessPermission": { "type": "string", "description": "Access Permisstion" }, "useDefaultOrgPrivileges": { "type": "string", "description": "Use default organization privileges." }, "organizationPrivileges": { "type": "array", "description": "The Organization Privileges", "items": { "type": "object", "properties": { "privilegeName": { "type": "string", "description": "Privilege Name" }, "value": { "type": "string", "description": "Privilege Value" } } } } } } }, "globalPrivileges": { "type": "array", "description": "The Global Privileges to be created with Administrator", "items": { "type": "object", "properties": { "privilegeName": { "type": "string", "description": "Privilege Name" }, "value": { "type": "string", "description": "Privilege Value" } } } }, "organizationPrivilegesDefault": { "type": "array", "description": "The Organization Privileges to be created with Normal Administrator", "items": { "type": "object", "properties": { "privilegeName": { "type": "string", "description": "Privilege Name" }, "value": { "type": "string", "description": "Privilege Value" } } } } }, "example": { "loginName": "Example", "password": "123456", "adminType": "Master", "authenticationType": "Password", "contact": { "lastName": "qipman", "firstName": "qipman" }, "location": { "street1": "abc", "street2": "abc", "city": "abc", "state": "abc", "zip": "123456", "country": "abc" }, "businessUnitID": "123456", "defaultPrinter": "abc", "assignedOrganizations": [ { "orgName": "OrgTest1", "managedType": "Normal", "accessPermission": "Write", "useDefaultOrgPrivileges": "False", "organizationPrivileges": [ { "privilegeName": "Access DNS Group", "value": "False" }, { "privilegeName": "Access Infrastructure Import", "value": "False" }, { "privilegeName": "Access Node Management", "value": "False" }, { "privilegeName": "Access V6 Address Management", "value": "False" }, { "privilegeName": "Access VisualIP Space Only", "value": "False" }, { "privilegeName": "Allow Dynamic MDHCP Update Without DHCP Server Permission", "value": "True" }, { "privilegeName": "Appliance Admin", "value": "False" }, { "privilegeName": "Highest Level GUI Mode", "value": "Basic Mode" }, { "privilegeName": "Access Address Allocation", "value": "False" }, { "privilegeName": "Allow User Selection", "value": "False" }, { "privilegeName": "Display MyView Tab Only", "value": "False" }, { "privilegeName": "Require Alias", "value": "False" }, { "privilegeName": "Require Contact Name", "value": "False" }, { "privilegeName": "Require Location", "value": "False" }, { "privilegeName": "Require MAC Address", "value": "False" }, { "privilegeName": "Restrict CNAME", "value": "False" }, { "privilegeName": "Restrict Subnet", "value": "False" }, { "privilegeName": "Unique Name Warning", "value": "True" } ] }, { "orgName": "VitalQIP Organization", "managedType": "Organization", "accessPermission": "Read", "useDefaultOrgPrivileges": "True" } ], "globalPrivileges": [ { "privilegeName": "Allow Recursive Deletes", "value": "Temporary", "subPrivileges": [ { "privilegeName": "Expiration", "value": "03/13/2020 12:00" } ] }, { "privilegeName": "Default Object Class", "value": "3G Phone" }, { "privilegeName": "Allow AC Management", "value": "False" }, { "privilegeName": "Allow Password Expiration", "value": "True" }, { "privilegeName": "Allow REST API Execution", "value": "True" }, { "privilegeName": "Create/Update Administrator", "value": "False" }, { "privilegeName": "IPv4 subnet default view style", "value": "Table" }, { "privilegeName": "Zone default view style", "value": "Table" }, { "privilegeName": "IPv4 network default view style", "value": "Table" } ], "organizationPrivilegesDefault": [ { "privilegeName": "Access DNS Group", "value": "True", "subPrivileges": [ { "privilegeName": "Manage DNS Group", "value": "True" }, { "privilegeName": "Generate DNS Group", "value": "True" } ] }, { "privilegeName": "Access Infrastructure Import", "value": "True", "subPrivileges": [ { "privilegeName": "Import IPv4 Networks", "value": "False" }, { "privilegeName": "Import IPv4 Subnets", "value": "False" }, { "privilegeName": "Import IPv4 Objects", "value": "False" }, { "privilegeName": "Import IPv6 Pools", "value": "False" }, { "privilegeName": "Import IPv6 Blocks", "value": "False" }, { "privilegeName": "Import IPv6 Subnets", "value": "False" }, { "privilegeName": "Import IPv6 Ranges", "value": "False" }, { "privilegeName": "Import IPv6 Addresses", "value": "False" }, { "privilegeName": "Import DNS Domains", "value": "False" }, { "privilegeName": "Import DNS Records", "value": "False" }, { "privilegeName": "Import Subnet Organizations", "value": "False" }, { "privilegeName": "Import Nodes", "value": "False" }, { "privilegeName": "Import MAC Pools", "value": "False" } ] }, { "privilegeName": "Access Address Allocation", "value": "True", "subPrivileges": [ { "privilegeName": "Maintain Blocks", "value": "True", "subPrivileges": [ { "privilegeName": "Expand Blocks", "value": "False" }, { "privilegeName": "Renumber Blocks", "value": "False" }, { "privilegeName": "Split/Merge Blocks", "value": "False" }, { "privilegeName": "Allocate Blocks", "value": "True", "subPrivileges": [ { "privilegeName": "Rule Level", "value": "Normal" } ] }, { "privilegeName": "Explicitly Create Blocks", "value": "False" }, { "privilegeName": "Free Blocks", "value": "False" }, { "privilegeName": "Move Blocks", "value": "False" } ] }, { "privilegeName": "Maintain Pools", "value": "False" }, { "privilegeName": "Maintain Seed Pool", "value": "False" }, { "privilegeName": "Rule Override", "value": "False" }, { "privilegeName": "Write New Infrastructure to Managed List", "value": "True" } ] }, { "privilegeName": "Access Node Management", "value": "False" }, { "privilegeName": "Access V6 Address Management", "value": "False" }, { "privilegeName": "Access VisualIP Space Only", "value": "False" }, { "privilegeName": "Allow Dynamic MDHCP Update Without DHCP Server Permission", "value": "True" }, { "privilegeName": "Appliance Admin", "value": "False" }, { "privilegeName": "Highest Level GUI Mode", "value": "Advanced Mode", "subPrivileges": [ { "privilegeName": "Create Infrastructure", "value": "True", "subPrivileges": [ { "privilegeName": "Dynamic Domain Creation", "value": "False" } ] }, { "privilegeName": "Create Resource Records", "value": "False" } ] }, { "privilegeName": "Allow User Selection", "value": "False" }, { "privilegeName": "Display MyView Tab Only", "value": "False" }, { "privilegeName": "Require Alias", "value": "False" }, { "privilegeName": "Require Contact Name", "value": "False" }, { "privilegeName": "Require Location", "value": "False" }, { "privilegeName": "Require MAC Address", "value": "False" }, { "privilegeName": "Restrict CNAME", "value": "False" }, { "privilegeName": "Restrict Subnet", "value": "False" }, { "privilegeName": "Unique Name Warning", "value": "True" } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createAdmin" }, "task": true }, { "name": "modifyAdmin", "summary": "Modify an administrator account.", "description": "Modify an administrator account. \n*Note:* Administrator loginName must exist; it cannot be modified via REST. Password can only be modified using admin/changePassword REST API. The adminType cannot be modified via REST API.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "loginName", "type": "string", "info": "Login Name: string", "required": true, "schema": { "title": "loginName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"authenticationType\": \"string\", \"adminStatus\": \"string\", \"contact\": {\"lastName\": \"string\", \"firstName\": \"string\"}, \"location\": {\"street1\": \"string\", \"street2\": \"string\", \"city\": \"string\", \"state\": \"string\", \"zip\": \"string\", \"country\": \"string\"}, \"businessUnitID\": \"string\", \"defaultPrinter\": \"string\", \"assignedOrganizations\": [{\"orgName\": \"string\", \"managedType\": \"string\", \"accessPermission\": \"string\", \"useDefaultOrgPrivileges\": \"string\", \"organizationPrivileges\": [{\"privilegeName\": \"string\", \"value\": \"string\"}]}], \"globalPrivileges\": [{\"privilegeName\": \"string\", \"value\": \"string\"}], \"organizationPrivilegesDefault\": [{\"privilegeName\": \"string\", \"value\": \"string\"}]}", "required": true, "schema": { "type": "object", "description": "Admin model", "xml": { "name": "AdminRestModel" }, "properties": { "authenticationType": { "type": "string", "description": "Authentication Type. One of following values: \n\n'Password',
'Certificate',
'SAML Managed',
'SAML Authenticated'" }, "adminStatus": { "type": "string", "description": "Admin Status. One of following values: \n\n'Disabled',
'Enabled'" }, "contact": { "type": "object", "description": "Person Profile", "properties": { "lastName": { "type": "string", "description": "Last Name" }, "firstName": { "type": "string", "description": "First Name" } } }, "location": { "type": "object", "description": "Location", "properties": { "street1": { "type": "string", "description": "Street1" }, "street2": { "type": "string", "description": "Street2" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State" }, "zip": { "type": "string", "description": "Zip" }, "country": { "type": "string", "description": "Country" } } }, "businessUnitID": { "type": "string", "description": "Business Unit ID" }, "defaultPrinter": { "type": "string", "description": "Default Printer ID" }, "assignedOrganizations": { "type": "array", "description": "The Organizations to be assigned with Normal Administrator", "items": { "type": "object", "properties": { "orgName": { "type": "string", "description": "Organization Name" }, "managedType": { "type": "string", "description": "Managed Type" }, "accessPermission": { "type": "string", "description": "Access Permisstion" }, "useDefaultOrgPrivileges": { "type": "string", "description": "Use default organization privileges." }, "organizationPrivileges": { "type": "array", "description": "The Organization Privileges", "items": { "type": "object", "properties": { "privilegeName": { "type": "string", "description": "Privilege Name" }, "value": { "type": "string", "description": "Privilege Value" } } } } } } }, "globalPrivileges": { "type": "array", "description": "The Global Privileges to be created with Administrator", "items": { "type": "object", "properties": { "privilegeName": { "type": "string", "description": "Privilege Name" }, "value": { "type": "string", "description": "Privilege Value" } } } }, "organizationPrivilegesDefault": { "type": "array", "description": "The Organization Privileges to be created with Normal Administrator", "items": { "type": "object", "properties": { "privilegeName": { "type": "string", "description": "Privilege Name" }, "value": { "type": "string", "description": "Privilege Value" } } } } }, "example": { "authenticationType": "Password", "adminStatus": "Enabled", "contact": { "lastName": "qipman", "firstName": "qipman" }, "location": { "street1": "abc", "street2": "abc", "city": "abc", "state": "abc", "zip": "123456", "country": "abc" }, "businessUnitID": "123456", "defaultPrinter": "abc", "assignedOrganizations": [ { "orgName": "OrgTest1", "managedType": "Normal", "accessPermission": "Write", "useDefaultOrgPrivileges": "False", "organizationPrivileges": [ { "privilegeName": "Access DNS Group", "value": "False" }, { "privilegeName": "Access Infrastructure Import", "value": "False" }, { "privilegeName": "Access Node Management", "value": "False" }, { "privilegeName": "Access V6 Address Management", "value": "False" }, { "privilegeName": "Access VisualIP Space Only", "value": "False" }, { "privilegeName": "Allow Dynamic MDHCP Update Without DHCP Server Permission", "value": "True" }, { "privilegeName": "Appliance Admin", "value": "False" }, { "privilegeName": "Highest Level GUI Mode", "value": "Basic Mode" }, { "privilegeName": "Access Address Allocation", "value": "False" }, { "privilegeName": "Allow User Selection", "value": "False" }, { "privilegeName": "Display MyView Tab Only", "value": "False" }, { "privilegeName": "Require Alias", "value": "False" }, { "privilegeName": "Require Contact Name", "value": "False" }, { "privilegeName": "Require Location", "value": "False" }, { "privilegeName": "Require MAC Address", "value": "False" }, { "privilegeName": "Restrict CNAME", "value": "False" }, { "privilegeName": "Restrict Subnet", "value": "False" }, { "privilegeName": "Unique Name Warning", "value": "True" } ] }, { "orgName": "VitalQIP Organization", "managedType": "Organization", "accessPermission": "Read", "useDefaultOrgPrivileges": "True" } ], "globalPrivileges": [ { "privilegeName": "Allow Recursive Deletes", "value": "Temporary", "subPrivileges": [ { "privilegeName": "Expiration", "value": "03/13/2020 12:00" } ] }, { "privilegeName": "Default Object Class", "value": "3G Phone" }, { "privilegeName": "Allow AC Management", "value": "False" }, { "privilegeName": "Allow Password Expiration", "value": "True" }, { "privilegeName": "Create/Update Administrator", "value": "False" }, { "privilegeName": "IPv4 subnet default view style", "value": "Table" }, { "privilegeName": "Zone default view style", "value": "Table" }, { "privilegeName": "IPv4 network default view style", "value": "Table" } ], "organizationPrivilegesDefault": [ { "privilegeName": "Access DNS Group", "value": "True", "subPrivileges": [ { "privilegeName": "Manage DNS Group", "value": "True" }, { "privilegeName": "Generate DNS Group", "value": "True" } ] }, { "privilegeName": "Access Infrastructure Import", "value": "True", "subPrivileges": [ { "privilegeName": "Import IPv4 Networks", "value": "False" }, { "privilegeName": "Import IPv4 Subnets", "value": "False" }, { "privilegeName": "Import IPv4 Objects", "value": "False" }, { "privilegeName": "Import IPv6 Pools", "value": "False" }, { "privilegeName": "Import IPv6 Blocks", "value": "False" }, { "privilegeName": "Import IPv6 Subnets", "value": "False" }, { "privilegeName": "Import IPv6 Ranges", "value": "False" }, { "privilegeName": "Import IPv6 Addresses", "value": "False" }, { "privilegeName": "Import DNS Domains", "value": "False" }, { "privilegeName": "Import DNS Records", "value": "False" }, { "privilegeName": "Import Subnet Organizations", "value": "False" }, { "privilegeName": "Import Nodes", "value": "False" }, { "privilegeName": "Import MAC Pools", "value": "False" } ] }, { "privilegeName": "Access Address Allocation", "value": "True", "subPrivileges": [ { "privilegeName": "Maintain Blocks", "value": "True", "subPrivileges": [ { "privilegeName": "Expand Blocks", "value": "False" }, { "privilegeName": "Renumber Blocks", "value": "False" }, { "privilegeName": "Split/Merge Blocks", "value": "False" }, { "privilegeName": "Allocate Blocks", "value": "True", "subPrivileges": [ { "privilegeName": "Rule Level", "value": "Normal" } ] }, { "privilegeName": "Explicitly Create Blocks", "value": "False" }, { "privilegeName": "Free Blocks", "value": "False" }, { "privilegeName": "Move Blocks", "value": "False" } ] }, { "privilegeName": "Maintain Pools", "value": "False" }, { "privilegeName": "Maintain Seed Pool", "value": "False" }, { "privilegeName": "Rule Override", "value": "False" }, { "privilegeName": "Write New Infrastructure to Managed List", "value": "True" } ] }, { "privilegeName": "Access Node Management", "value": "False" }, { "privilegeName": "Access V6 Address Management", "value": "False" }, { "privilegeName": "Access VisualIP Space Only", "value": "False" }, { "privilegeName": "Allow Dynamic MDHCP Update Without DHCP Server Permission", "value": "True" }, { "privilegeName": "Appliance Admin", "value": "False" }, { "privilegeName": "Highest Level GUI Mode", "value": "Advanced Mode", "subPrivileges": [ { "privilegeName": "Create Infrastructure", "value": "True", "subPrivileges": [ { "privilegeName": "Dynamic Domain Creation", "value": "False" } ] }, { "privilegeName": "Create Resource Records", "value": "False" } ] }, { "privilegeName": "Allow User Selection", "value": "False" }, { "privilegeName": "Display MyView Tab Only", "value": "False" }, { "privilegeName": "Require Alias", "value": "False" }, { "privilegeName": "Require Contact Name", "value": "False" }, { "privilegeName": "Require Location", "value": "False" }, { "privilegeName": "Require MAC Address", "value": "False" }, { "privilegeName": "Restrict CNAME", "value": "False" }, { "privilegeName": "Restrict Subnet", "value": "False" }, { "privilegeName": "Unique Name Warning", "value": "True" } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyAdmin" }, "task": true }, { "name": "deleteAdmin", "summary": "Delete an administrator account.", "description": "Delete an administrator account.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "loginName", "type": "string", "info": "Login Name: string", "required": true, "schema": { "title": "loginName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAdmin" }, "task": true }, { "name": "changePassword", "summary": "Change password for an administrator account.", "description": "Change password for an administrator account.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "loginName", "type": "string", "info": "Login Name: string", "required": true, "schema": { "title": "loginName", "type": "string" } }, { "name": "newPassword", "type": "string", "info": "New password: string", "required": true, "schema": { "title": "newPassword", "type": "string" } }, { "name": "confirmNewPassword", "type": "string", "info": "Confirm new password: string", "required": true, "schema": { "title": "confirmNewPassword", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/changePassword" }, "task": true }, { "name": "getManagedList", "summary": "Get the managed list of an administrator by login name and organization.", "description": "Get the managed list of an administrator by login name and organization.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "loginName", "type": "string", "info": "Login name of the administrator.: string", "required": true, "schema": { "title": "loginName", "type": "string" } }, { "name": "assignedOrgName", "type": "string", "info": "The name of organization which you want to assign manage list on this organization.: string", "required": true, "schema": { "title": "assignedOrgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getManagedList" }, "task": true }, { "name": "assignManageList", "summary": "Assign a manage list for an administrator.", "description": "Assign a manage list for an administrator.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "loginName", "type": "string", "info": "Login name of the administrator.: string", "required": true, "schema": { "title": "loginName", "type": "string" } }, { "name": "assignedOrgName", "type": "string", "info": "The organization name which you want to assign manage list on this organization.: string", "required": true, "schema": { "title": "assignedOrgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"ManagedListRestModel\": [{\"itemType\": \"string\", \"itemsList\": [{\"itemName\": \"string\", \"accessPermission\": \"string\"}]}]}", "required": true, "schema": { "type": "object", "xml": { "name": "list" }, "properties": { "ManagedListRestModel": { "type": "array", "items": { "type": "object", "required": [ "itemType", "itemsList" ], "properties": { "itemType": { "type": "string", "description": "Item type name" }, "itemsList": { "type": "array", "items": { "type": "object", "required": [ "itemName", "accessPermission" ], "properties": { "itemName": { "type": "string", "description": "Item name" }, "accessPermission": { "type": "string", "description": "Access permission" } } } } } } } }, "example": { "list": [ { "itemType": "Domain", "itemsList": [ { "itemName": "test.com", "accessPermission": "Read" }, { "itemName": "abc", "accessPermission": "Read" } ] }, { "itemType": "Role", "itemsList": [ { "itemName": "Role1", "accessPermission": "Read" } ] } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignManageList" }, "task": true }, { "name": "getReport", "summary": "Download Administrators report file", "description": "Use this URL to download Administrators report file.\n\nWhen using cURL with this API specify \"-o fileName.extension\" to download file contents.\n\nInternet Explorer browser users: to download the report please right click the “Download file� link and select “Save as� then input the desired file name with the correct extension.\n\nExample: qipman-AdministratorsReport-20190328_103238_523_0700.html or qipman-AdministratorsReport-20190328_103238_523_0700.pdf", "input": [ { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "adminNames", "type": "string", "info": "Administrator Names (Empty this field to report for all administrators). To add multiple administrators, enter a comma separated list: string", "required": false, "schema": { "title": "adminNames", "type": "string" } }, { "name": "adminStatus", "type": "string", "info": "Administrator Status: Must be one of [All, Enabled, Disabled]", "required": true, "schema": { "title": "adminStatus", "type": "string" } }, { "name": "reportFormat", "type": "string", "info": "Report Format: Must be one of [html, pdf]", "required": true, "schema": { "title": "reportFormat", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReport" }, "task": true }, { "name": "activityreport", "summary": "Download Administrators Activity report file in ALL organization", "description": "Use this URL to download Administrators activity report file.\n\nWhen using cURL with this API specify \"-o fileName.extension\" to download file contents.\n\nInternet Explorer browser users: to download the report please right click the \"Download file\" link and select \"Save as\" then input the desired file name with the correct extension.\n\nExample: qipman-AdministratorsActivityReport-20190328_103238_523_0700.html or qipman-AdministratorsActivityReport-20190328_103238_523_0700.pdf", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name.: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "administrator", "type": "string", "info": "Login Name: string", "required": true, "schema": { "title": "administrator", "type": "string" } }, { "name": "fromDate", "type": "string", "info": "From date.\nFormat: mm/dd/yyyy hh:mm: string", "required": false, "schema": { "title": "fromDate", "type": "string" } }, { "name": "toDate", "type": "string", "info": "To date.\nFormat: mm/dd/yyyy hh:mm: string", "required": false, "schema": { "title": "toDate", "type": "string" } }, { "name": "sortOrder", "type": "string", "info": "Sort order.: Must be one of [Ascending, Descending]", "required": false, "schema": { "title": "sortOrder", "type": "string" } }, { "name": "reportFormat", "type": "string", "info": "Report Format: Must be one of [html, pdf]", "required": true, "schema": { "title": "reportFormat", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/activityreport" }, "task": true }, { "name": "createAdminRole", "summary": "Create an administrator role.", "description": "Create an administrator role.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"adminRoleName\": \"string\", \"adminRoleDescription\": \"string\"}", "required": true, "schema": { "type": "object", "description": "Administrator role model", "required": [ "adminRoleName" ], "properties": { "adminRoleName": { "type": "string", "description": "Administrator role name" }, "adminRoleDescription": { "type": "string", "description": "Administrator role description" } }, "example": { "adminRoleName": "string", "adminRoleDescription": "string" }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createAdminRole" }, "task": true }, { "name": "searchAdminRole", "summary": "Search administrator role.", "description": "Search administrator role by administrator role name.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "adminRoleName", "type": "string", "info": "Searching key of administrator role name.\nYou can use an asterisk (*) as a wildcard character to \nreturn a range of results.: string", "required": false, "schema": { "title": "adminRoleName", "type": "string" } }, { "name": "pageIndex", "type": "number", "info": "Page index. Default value is 1.: 123", "required": false, "schema": { "title": "pageIndex", "type": "number" } }, { "name": "pageSize", "type": "number", "info": "Page size. Default value is 25.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchAdminRole" }, "task": true }, { "name": "modifyAdminRole", "summary": "Modify an administrator role.", "description": "Modify an administrator role.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "adminRoleName", "type": "string", "info": "Administrator Role Name: string", "required": true, "schema": { "title": "adminRoleName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"adminRoleName\": \"string\", \"adminRoleDescription\": \"string\"}", "required": true, "schema": { "type": "object", "description": "Administrator role model", "xml": { "name": "AdminRoleRestModel" }, "properties": { "adminRoleName": { "type": "string", "description": "Administrator role name" }, "adminRoleDescription": { "type": "string", "description": "Administrator role description" } }, "example": { "adminRoleName": "string", "adminRoleDescription": "string" }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyAdminRole" }, "task": true }, { "name": "deleteAdminRole", "summary": "Delete an administrator role.", "description": "Delete an administrator role.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "adminRoleName", "type": "string", "info": "Administrator Role Name: string", "required": true, "schema": { "title": "adminRoleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAdminRole" }, "task": true }, { "name": "searchAdminRoleAssignedAdmin", "summary": "Get assigned administrator name list by administrator role.", "description": "Get assigned administrator name list by administrator role.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "adminRoleName", "type": "string", "info": "Administrator Role Name.: string", "required": true, "schema": { "title": "adminRoleName", "type": "string" } }, { "name": "pageIndex", "type": "number", "info": "Page index. Default value is 1.: 123", "required": false, "schema": { "title": "pageIndex", "type": "number" } }, { "name": "pageSize", "type": "number", "info": "Page size. Default value is 25.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchAdminRoleAssignedAdmin" }, "task": true }, { "name": "getAdminRoleManagedList", "summary": "Get the managed list of an administrator role by role name.", "description": "Get the managed list of an administrator role by role name.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "adminRoleName", "type": "string", "info": "Administrator Role Name.: string", "required": true, "schema": { "title": "adminRoleName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getAdminRoleManagedList" }, "task": true }, { "name": "assignAdminRoleManagedList", "summary": "Assign a managed list for an administrator role.", "description": "Assign a managed list for an administrator role.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "adminRoleName", "type": "string", "info": "Administrator Role Name.: string", "required": true, "schema": { "title": "adminRoleName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"ManagedListRestModel\": [{\"itemType\": \"string\", \"itemsList\": [{\"itemName\": \"string\", \"accessPermission\": \"string\"}]}]}", "required": true, "schema": { "type": "object", "description": "Administrator managed list", "xml": { "name": "list" }, "properties": { "ManagedListRestModel": { "type": "array", "description": "Managed list", "items": { "type": "object", "properties": { "itemType": { "type": "string", "description": "Item type : Role, QIPApp, BootPServer, DcServer, DhcpServer, DnsServer, Domain, V4Object, V4AddressRange, V4ObjectRange, V4Subnet, Network, OSPF, SubnetOrg, V6Pool, V6Subnet, V6Range, DhcpV6Server" }, "itemsList": { "type": "array", "description": "Items list", "items": { "type": "object", "properties": { "itemName": { "type": "string", "description": "Item Name" }, "accessPermission": { "type": "string", "description": "Access Permission: Write, Read" } } } } } }, "example": [ { "itemType": "string", "itemsList": [ { "itemName": "string", "accessPermission": "Write" }, { "itemName": "string", "accessPermission": "Read" } ] }, { "itemType": "string", "itemsList": [ { "itemName": "string", "accessPermission": "Write" }, { "itemName": "string", "accessPermission": "Read" } ] } ] } }, "example": { "list": [ { "itemType": "string", "itemsList": [ { "itemName": "string", "accessPermission": "Write" }, { "itemName": "string", "accessPermission": "Read" } ] }, { "itemType": "string", "itemsList": [ { "itemName": "string", "accessPermission": "Write" }, { "itemName": "string", "accessPermission": "Read" } ] } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignAdminRoleManagedList" }, "task": true }, { "name": "createDHCPTemplate", "summary": "Create a DHCP Option Template", "description": "Create a DHCP Option Template", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"templateName\": \"string\", \"listOptions\": [{\"optionName\": \"string\", \"value\": \"string\", \"childOption\": {\"options\": [{\"optionName\": \"string\", \"value\": \"string\", \"childOption\": {\"options\": [{\"optionName\": \"string\", \"value\": \"string\"}]}}]}}]}", "required": true, "schema": { "type": "object", "required": [ "templateName" ], "properties": { "templateName": { "type": "string", "description": "Name of DHCP OPTION" }, "listOptions": { "type": "array", "items": { "type": "object", "properties": { "optionName": { "type": "string", "description": "Name of option" }, "value": { "type": "string", "description": "Value of option" }, "childOption": { "type": "object", "properties": { "options": { "type": "array", "items": { "title": "option", "type": "object", "properties": { "optionName": { "type": "string", "description": "Name of option" }, "value": { "type": "string", "description": "Value of option" }, "childOption": { "type": "object", "properties": { "options": { "type": "array", "items": { "title": "option", "type": "object", "properties": { "optionName": { "type": "string", "description": "Name of option" }, "value": { "type": "string", "description": "Value of option" } } } } } } } } } } } } }, "xml": { "name": "options" } } }, "example": { "templateName": "ExampleTemplate", "options": [ { "optionName": "CableLabs Client Config", "childOption": [ { "optionName": "SP Primary DHCP Server Address", "value": "10.0.0.10" }, { "optionName": "SP Secondary DHCP Server Address", "value": "10.0.0.11" }, { "optionName": "SP SNMP Entity Address", "value": "10.0.0.12" }, { "optionName": "SP Primary DNS Server Address", "value": "10.0.0.13" }, { "optionName": "SP Secondary DNS Server Address", "value": "10.0.0.14" }, { "optionName": "Kerberos Realm", "value": "kerberos.mycorp.net" }, { "optionName": "Use Ticket-Granting-Ticket", "value": "false" }, { "optionName": "Provisioning Timer", "value": "30" }, { "optionName": "CMS FQDN", "value": "cms.mycorp.net" } ] }, { "optionName": "CableLabs Client Config (122)", "childOption": [ { "optionName": "TSP AP-REQ/AP-REP Backoff and Retry", "childOption": [ { "optionName": "Maximum Retry", "value": "100" }, { "optionName": "Maximum Timeout", "value": "100" }, { "optionName": "Nominal Timeout", "value": "50" } ] }, { "optionName": "TSP AS-REQ/AS-REP Backoff and Retry", "childOption": [ { "optionName": "Maximum Retry", "value": "100" }, { "optionName": "Maximum Timeout", "value": "100" }, { "optionName": "Nominal Timeout", "value": "50" } ] }, { "optionName": "TSP Kerberos Realm Name", "value": "kerberos.mycorp.net" }, { "optionName": "TSP Primary DHCP Server Address", "value": "10.0.0.15" }, { "optionName": "TSP Provisioning Server Address", "value": "FQDN", "childOption": [ { "optionName": "FQDN", "value": "example.com" } ] }, { "optionName": "TSP Provisioning Timer", "value": "22" }, { "optionName": "TSP Secondary DHCP Server Address", "value": "10.0.0.16" }, { "optionName": "TSP Ticket Granting Server Utilization", "value": "false" } ] }, { "optionName": "Boot File Size", "value": "65535" }, { "optionName": "Cookie Server", "value": "10.0.0.17 10.0.0.18" }, { "optionName": "Domain Name", "value": "User Defined", "childOption": [ { "optionName": "User Defined", "value": "example.com" } ] }, { "optionName": "Domain Name Server", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Extensions Path", "value": "c:\\qip" }, { "optionName": "Host Name", "value": "User Defined", "childOption": [ { "optionName": "User Defined", "value": "example.com" } ] }, { "optionName": "Impress Server", "value": "10.0.0.19 10.0.0.20" }, { "optionName": "LPR Server", "value": "10.0.0.21 10.0.0.22" }, { "optionName": "Log Server", "value": "10.0.0.23 10.0.0.24" }, { "optionName": "Merit Dump File", "value": "meritFile" }, { "optionName": "Name Server", "value": "10.0.0.25 10.0.0.26" }, { "optionName": "Resource Location Server", "value": "10.0.0.27 10.0.0.28" }, { "optionName": "Root Path", "value": "c:\\qip" }, { "optionName": "Router", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Subnet Mask", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Swap Server", "value": "10.0.0.31" }, { "optionName": "Time Offset", "value": "1000" }, { "optionName": "Time Server", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Default IP Time-to-live", "value": "1" }, { "optionName": "IP Forwarding Enable/Disable", "value": "false" }, { "optionName": "Maximum Datagram Reassembly Size", "value": "576" }, { "optionName": "Non-Local Source Routing Enable/Disable", "value": "false" }, { "optionName": "Path MTU Aging Timeout", "value": "1000" }, { "optionName": "Path MTU Plateau Table", "value": "69" }, { "optionName": "Policy Filter", "value": "10.0.0.32 255.0.0.0" }, { "optionName": "All Subnets are Local", "value": "false" }, { "optionName": "Broadcast Address", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Interface MTU", "value": "65535" }, { "optionName": "Mask Supplier", "value": "false" }, { "optionName": "Perform Mask Discovery", "value": "false" }, { "optionName": "Perform Router Discovery", "value": "false" }, { "optionName": "Router Solicitation Address", "value": "10.0.0.33" }, { "optionName": "Static Route", "value": "10.0.0.1 10.0.0.2" }, { "optionName": "Classless Static Route", "value": "10.0.0.0 255.0.0.0 10.0.0.1" }, { "optionName": "ARP Cache Timeout", "value": "1000" }, { "optionName": "Ethernet Encapsulation", "value": "false" }, { "optionName": "Trailer Encapsulation", "value": "false" }, { "optionName": "TCP Default TTL", "value": "251" }, { "optionName": "TCP Keepalive Garbage", "value": "false" }, { "optionName": "TCP Keepalive Interval", "value": "1000" }, { "optionName": "Default Finger Server", "value": "10.0.0.35 10.0.0.36" }, { "optionName": "Default Internet Relay Chat (IRC) Server", "value": "10.0.0.37 10.0.0.38" }, { "optionName": "Default World Wide Web (WWW) Server", "value": "10.0.0.39 10.0.0.40" }, { "optionName": "Microsoft Default Router Metric Base", "value": "1000" }, { "optionName": "Microsoft Disable Netbios", "value": "1000" }, { "optionName": "Microsoft Release DHCP Lease on Shutdown", "value": "1000" }, { "optionName": "Mobile IP Home Agent", "value": "10.0.0.41 10.0.0.42" }, { "optionName": "Multicast TTL", "value": "251" }, { "optionName": "NetBIOS over TCP/IP Datagram Distribution Server", "value": "10.0.0.43 10.0.0.44" }, { "optionName": "NetBIOS over TCP/IP Name Server", "value": "10.0.0.45 10.0.0.46" }, { "optionName": "NetBIOS over TCP/IP Node Type", "value": "B-node" }, { "optionName": "NetBIOS over TCP/IP Scope" }, { "optionName": "Network Information Servers", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Network Information Service Domain", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Network Information Service+Domain", "value": "example.com" }, { "optionName": "Network Information Service+Servers", "value": "10.0.0.47" }, { "optionName": "Network News Transport Protocol (NNTP) Server", "value": "10.0.0.48" }, { "optionName": "Network Time Protocol Servers", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Post Office Protocol (POP3) Server", "value": "10.0.0.49 10.0.0.50" }, { "optionName": "Scope Life", "value": "1000" }, { "optionName": "Simple Mail Transport Protocol (SMTP) Server", "value": "10.0.0.51" }, { "optionName": "StreetTalk Directory Assistance (STDA) Server", "value": "10.0.0.52 10.0.0.53" }, { "optionName": "StreetTalk Server", "value": "10.0.0.54 10.0.0.55" }, { "optionName": "Vendor Specific Information" }, { "optionName": "X Window System Display Manager", "value": "10.0.0.54" }, { "optionName": "X Window System Font Server", "value": "10.0.0.55 10.0.0.56" }, { "optionName": "Broadcast and Multicast Control Service Domain List" }, { "optionName": "Broadcast and Multicast Control Service Address List", "value": "10.0.0.57" }, { "optionName": "Timezone specified as IEEE 1003.1 String", "value": "1010" }, { "optionName": "Timezone specified as TZ Database String", "value": "1010" }, { "optionName": "SIP Server Address List", "value": "10.0.0.58 10.0.0.59" }, { "optionName": "SIP Server Domain List", "value": "10.0.0.60 10.0.0.61" }, { "optionName": "Bootfile Name", "value": "bootfile" }, { "optionName": "Client Identifier", "value": "client1" }, { "optionName": "IP Address Lease Time", "value": "Limited", "childOption": [ { "optionName": "Limited Lease Time", "value": "900000" } ] }, { "optionName": "Option Overload", "value": "2" }, { "optionName": "Rebinding (T2) Time", "value": "1000" }, { "optionName": "Renewal (T1) Time", "value": "1000" }, { "optionName": "TFTP Server Name", "value": "TFTPServer" }, { "optionName": "Vendor Class Identifier" }, { "optionName": "NDS Context" }, { "optionName": "NDS Servers", "value": "10.0.0.0.60 10.0.0.61" }, { "optionName": "NDS Tree Name", "value": "NDS_Tree1" }, { "optionName": "Netware/IP Domain Name", "value": "example.com" }, { "optionName": "Netware/IP Information", "childOption": [ { "optionName": "NWIP Setting", "value": "NWIP_EXIST_IN_OPTIONS_AREA", "childOption": [ { "optionName": "AUTORETRIES", "value": "1000" }, { "optionName": "AUTORETRY_SECS", "value": "1000" }, { "optionName": "NEAREST_NWIP_SERVER", "value": "10.0.0.62 10.0.0.63" }, { "optionName": "NSQ_BROADCAST", "value": "" }, { "optionName": "NWIP_1_1", "value": "" }, { "optionName": "PREFERRED_DSS", "value": "10.0.0.64" }, { "optionName": "PRIMARY_DSS", "value": "10.0.0.65" } ] } ] }, { "optionName": "Auto Configuration of IPv4 Clients", "value": "False" }, { "optionName": "SLP Directory Agent", "childOption": [ { "optionName": "Directory Agent Address", "value": "10.0.0.66" }, { "optionName": "Mandatory", "value": "false" } ] }, { "optionName": "SLP Service Scope", "childOption": [ { "optionName": "Mandatory", "value": "false" }, { "optionName": "Scope List", "value": "192.168.88.3-192.168.88.7, 192.168.88.8-192.168.88.20" } ] }, { "optionName": "User Authentication Protocol" }, { "optionName": "Domain Search Option" } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDHCPTemplate" }, "task": true }, { "name": "modifyDHCPOptonTemplate", "summary": "Modify a DHCP Option Template.", "description": "Modify a DHCP Option Template.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "templateName", "type": "string", "info": "DHCP Option Name: string", "required": true, "schema": { "title": "templateName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request Body: {\"options\": [{\"optionName\": \"string\", \"value\": \"string\", \"childOption\": {\"options\": [{\"optionName\": \"string\", \"value\": \"string\", \"childOption\": {\"options\": [{\"optionName\": \"string\", \"value\": \"string\"}]}}]}}]}", "required": true, "schema": { "type": "object", "xml": { "name": "list" }, "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "optionName": { "type": "string", "description": "Name of option" }, "value": { "type": "string", "description": "Value of option" }, "childOption": { "type": "object", "properties": { "options": { "type": "array", "items": { "title": "option", "type": "object", "properties": { "optionName": { "type": "string", "description": "Name of option" }, "value": { "type": "string", "description": "Value of option" }, "childOption": { "type": "object", "properties": { "options": { "type": "array", "items": { "title": "option", "type": "object", "properties": { "optionName": { "type": "string", "description": "Name of option" }, "value": { "type": "string", "description": "Value of option" } } } } } } } } } } } } } } }, "example": { "list": [ { "optionName": "CableLabs Client Config", "childOption": [ { "optionName": "SP Primary DHCP Server Address", "value": "10.0.0.10" }, { "optionName": "SP Secondary DHCP Server Address", "value": "10.0.0.11" }, { "optionName": "SP SNMP Entity Address", "value": "10.0.0.12" }, { "optionName": "SP Primary DNS Server Address", "value": "10.0.0.13" }, { "optionName": "SP Secondary DNS Server Address", "value": "10.0.0.14" }, { "optionName": "Kerberos Realm", "value": "kerberos.mycorp.net" }, { "optionName": "Use Ticket-Granting-Ticket", "value": "false" }, { "optionName": "Provisioning Timer", "value": "30" }, { "optionName": "CMS FQDN", "value": "cms.mycorp.net" } ] }, { "optionName": "CableLabs Client Config (122)", "childOption": [ { "optionName": "TSP AP-REQ/AP-REP Backoff and Retry", "childOption": [ { "optionName": "Maximum Retry", "value": "100" }, { "optionName": "Maximum Timeout", "value": "100" }, { "optionName": "Nominal Timeout", "value": "50" } ] }, { "optionName": "TSP AS-REQ/AS-REP Backoff and Retry", "childOption": [ { "optionName": "Maximum Retry", "value": "100" }, { "optionName": "Maximum Timeout", "value": "100" }, { "optionName": "Nominal Timeout", "value": "50" } ] }, { "optionName": "TSP Kerberos Realm Name", "value": "kerberos.mycorp.net" }, { "optionName": "TSP Primary DHCP Server Address", "value": "10.0.0.15" }, { "optionName": "TSP Provisioning Server Address", "value": "FQDN", "childOption": [ { "optionName": "FQDN", "value": "example.com" } ] }, { "optionName": "TSP Provisioning Timer", "value": "22" }, { "optionName": "TSP Secondary DHCP Server Address", "value": "10.0.0.16" }, { "optionName": "TSP Ticket Granting Server Utilization", "value": "false" } ] }, { "optionName": "Boot File Size", "value": "65535" }, { "optionName": "Cookie Server", "value": "10.0.0.17 10.0.0.18" }, { "optionName": "Domain Name", "value": "User Defined", "childOption": [ { "optionName": "User Defined", "value": "example.com" } ] }, { "optionName": "Domain Name Server", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Extensions Path", "value": "c:\\qip" }, { "optionName": "Host Name", "value": "User Defined", "childOption": [ { "optionName": "User Defined", "value": "example.com" } ] }, { "optionName": "Impress Server", "value": "10.0.0.19 10.0.0.20" }, { "optionName": "LPR Server", "value": "10.0.0.21 10.0.0.22" }, { "optionName": "Log Server", "value": "10.0.0.23 10.0.0.24" }, { "optionName": "Merit Dump File", "value": "meritFile" }, { "optionName": "Name Server", "value": "10.0.0.25 10.0.0.26" }, { "optionName": "Resource Location Server", "value": "10.0.0.27 10.0.0.28" }, { "optionName": "Root Path", "value": "c:\\qip" }, { "optionName": "Router", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Subnet Mask", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Swap Server", "value": "10.0.0.31" }, { "optionName": "Time Offset", "value": "1000" }, { "optionName": "Time Server", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Default IP Time-to-live", "value": "1" }, { "optionName": "IP Forwarding Enable/Disable", "value": "false" }, { "optionName": "Maximum Datagram Reassembly Size", "value": "576" }, { "optionName": "Non-Local Source Routing Enable/Disable", "value": "false" }, { "optionName": "Path MTU Aging Timeout", "value": "1000" }, { "optionName": "Path MTU Plateau Table", "value": "69" }, { "optionName": "Policy Filter", "value": "10.0.0.32 255.0.0.0" }, { "optionName": "All Subnets are Local", "value": "false" }, { "optionName": "Broadcast Address", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Interface MTU", "value": "65535" }, { "optionName": "Mask Supplier", "value": "false" }, { "optionName": "Perform Mask Discovery", "value": "false" }, { "optionName": "Perform Router Discovery", "value": "false" }, { "optionName": "Router Solicitation Address", "value": "10.0.0.33" }, { "optionName": "Static Route", "value": "10.0.0.1 10.0.0.2" }, { "optionName": "Classless Static Route", "value": "10.0.0.0 255.0.0.0 10.0.0.1" }, { "optionName": "ARP Cache Timeout", "value": "1000" }, { "optionName": "Ethernet Encapsulation", "value": "false" }, { "optionName": "Trailer Encapsulation", "value": "false" }, { "optionName": "TCP Default TTL", "value": "251" }, { "optionName": "TCP Keepalive Garbage", "value": "false" }, { "optionName": "TCP Keepalive Interval", "value": "1000" }, { "optionName": "Default Finger Server", "value": "10.0.0.35 10.0.0.36" }, { "optionName": "Default Internet Relay Chat (IRC) Server", "value": "10.0.0.37 10.0.0.38" }, { "optionName": "Default World Wide Web (WWW) Server", "value": "10.0.0.39 10.0.0.40" }, { "optionName": "Microsoft Default Router Metric Base", "value": "1000" }, { "optionName": "Microsoft Disable Netbios", "value": "1000" }, { "optionName": "Microsoft Release DHCP Lease on Shutdown", "value": "1000" }, { "optionName": "Mobile IP Home Agent", "value": "10.0.0.41 10.0.0.42" }, { "optionName": "Multicast TTL", "value": "251" }, { "optionName": "NetBIOS over TCP/IP Datagram Distribution Server", "value": "10.0.0.43 10.0.0.44" }, { "optionName": "NetBIOS over TCP/IP Name Server", "value": "10.0.0.45 10.0.0.46" }, { "optionName": "NetBIOS over TCP/IP Node Type", "value": "B-node" }, { "optionName": "NetBIOS over TCP/IP Scope" }, { "optionName": "Network Information Servers", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Network Information Service Domain", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Network Information Service+Domain", "value": "example.com" }, { "optionName": "Network Information Service+Servers", "value": "10.0.0.47" }, { "optionName": "Network News Transport Protocol (NNTP) Server", "value": "10.0.0.48" }, { "optionName": "Network Time Protocol Servers", "value": "Same as in Subnet Profile", "childOption": [ { "optionName": "Same as in Subnet Profile" } ] }, { "optionName": "Post Office Protocol (POP3) Server", "value": "10.0.0.49 10.0.0.50" }, { "optionName": "Scope Life", "value": "1000" }, { "optionName": "Simple Mail Transport Protocol (SMTP) Server", "value": "10.0.0.51" }, { "optionName": "StreetTalk Directory Assistance (STDA) Server", "value": "10.0.0.52 10.0.0.53" }, { "optionName": "StreetTalk Server", "value": "10.0.0.54 10.0.0.55" }, { "optionName": "Vendor Specific Information" }, { "optionName": "X Window System Display Manager", "value": "10.0.0.54" }, { "optionName": "X Window System Font Server", "value": "10.0.0.55 10.0.0.56" }, { "optionName": "Broadcast and Multicast Control Service Domain List" }, { "optionName": "Broadcast and Multicast Control Service Address List", "value": "10.0.0.57" }, { "optionName": "Timezone specified as IEEE 1003.1 String", "value": "1010" }, { "optionName": "Timezone specified as TZ Database String", "value": "1010" }, { "optionName": "SIP Server Address List", "value": "10.0.0.58 10.0.0.59" }, { "optionName": "SIP Server Domain List", "value": "10.0.0.60 10.0.0.61" }, { "optionName": "Bootfile Name", "value": "bootfile" }, { "optionName": "Client Identifier", "value": "client1" }, { "optionName": "IP Address Lease Time", "value": "Limited", "childOption": [ { "optionName": "Limited", "value": "900000" } ] }, { "optionName": "Option Overload", "value": "2" }, { "optionName": "Rebinding (T2) Time", "value": "1000" }, { "optionName": "Renewal (T1) Time", "value": "1000" }, { "optionName": "TFTP Server Name", "value": "TFTPServer" }, { "optionName": "Vendor Class Identifier" }, { "optionName": "NDS Context" }, { "optionName": "NDS Servers", "value": "10.0.0.0.60 10.0.0.61" }, { "optionName": "NDS Tree Name", "value": "NDS_Tree1" }, { "optionName": "Netware/IP Domain Name", "value": "example.com" }, { "optionName": "Netware/IP Information", "childOption": [ { "optionName": "NWIP Setting", "value": "NWIP_EXIST_IN_OPTIONS_AREA", "childOption": [ { "optionName": "AUTORETRIES", "value": "1000" }, { "optionName": "AUTORETRY_SECS", "value": "1000" }, { "optionName": "NEAREST_NWIP_SERVER", "value": "10.0.0.62 10.0.0.63" }, { "optionName": "NSQ_BROADCAST", "value": "" }, { "optionName": "NWIP_1_1", "value": "" }, { "optionName": "PREFERRED_DSS", "value": "10.0.0.64" }, { "optionName": "PRIMARY_DSS", "value": "10.0.0.65" } ] } ] }, { "optionName": "Auto Configuration of IPv4 Clients", "value": "False" }, { "optionName": "SLP Directory Agent", "childOption": [ { "optionName": "Directory Agent Address", "value": "10.0.0.66" }, { "optionName": "Mandatory", "value": "false" } ] }, { "optionName": "SLP Service Scope", "childOption": [ { "optionName": "Mandatory", "value": "false" }, { "optionName": "Scope List", "value": "192.168.88.3-192.168.88.7, 192.168.88.8-192.168.88.20" } ] }, { "optionName": "User Authentication Protocol" }, { "optionName": "Domain Search Option" } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyDHCPOptonTemplate" }, "task": true }, { "name": "deleteDhcpOptionTemplate", "summary": "Delete a DHCP Option Template", "description": "Delete a DHCP Option Template by name", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "templateName", "type": "string", "info": "DHCP Option Template Name: string", "required": true, "schema": { "title": "templateName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDhcpOptionTemplate" }, "task": true }, { "name": "getDHCPOptionTemplate", "summary": "Get DHCP Options Template by Subnet/Object/DHCP Option Template", "description": "Get DHCP Options Template by Subnet/Object/DHCP Template", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "address", "type": "string", "info": "Required for Subnet/Object types: string", "required": false, "schema": { "title": "address", "type": "string" } }, { "name": "templateName", "type": "string", "info": "Required for Template type: string", "required": false, "schema": { "title": "templateName", "type": "string" } }, { "name": "infraType", "type": "string", "info": "infrastructure type: Object|Subnet|Template: Must be one of [OBJECT, SUBNET, TEMPLATE]", "required": true, "schema": { "title": "infraType", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDHCPOptionTemplate" }, "task": true }, { "name": "searchDhcpOptionTemplateOptNum", "summary": "Search DHCP Option Template by Option Number", "description": "Search DHCP Option Template by Option Number. It just return the list of DHCP Option Template name", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "optionNumber", "type": "number", "info": "The Option Number of DHCP Option Template Maximum value is 514 Minimum value is 1: 123", "required": true, "schema": { "title": "optionNumber", "type": "number" } }, { "name": "pageIndex", "type": "number", "info": "Page index. Default value is 1. Minimum value is 1: 123", "required": false, "schema": { "title": "pageIndex", "type": "number" } }, { "name": "pageSize", "type": "number", "info": "Page size of response. Default value is 25.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchDhcpOptionTemplateOptNum" }, "task": true }, { "name": "searchDhcpOptionTemplateName", "summary": "Search DHCP Option Template by name", "description": "Search Dhcp Option Template by name. It return the list of infrastructure elements.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "templateName", "type": "string", "info": "The name of DHCP Option Template: string", "required": true, "schema": { "title": "templateName", "type": "string" } }, { "name": "startIndex", "type": "number", "info": "Default value is 1. Minimum value is 1: 123", "required": false, "schema": { "title": "startIndex", "type": "number" } }, { "name": "numberElement", "type": "number", "info": "Default value is 25.: 123", "required": false, "schema": { "title": "numberElement", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchDhcpOptionTemplateName" }, "task": true }, { "name": "getDhcpPolicyTemplate", "summary": "Get DHCP Policy Template by Name", "description": "Get DHCP Policy Template by Name.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "policyTemplateName", "type": "string", "info": "DHCP Policy Template Name: string", "required": true, "schema": { "title": "policyTemplateName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDhcpPolicyTemplate" }, "task": true }, { "name": "createDhcpPolicyTemplate", "summary": "Create a DHCP Policy Template", "description": "Create a DHCP Policy Template", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"templateName\": \"string\", \"policyLevel\": \"string\", \"policies\": [{\"policyName\": \"string\", \"value\": \"string\", \"subPolicy\": [{\"policyName\": \"string\", \"value\": \"string\", \"subPolicy\": [{\"policyName\": \"string\", \"value\": \"string\"}]}]}]}", "required": true, "schema": { "type": "object", "required": [ "templateName", "policyLevel" ], "properties": { "templateName": { "type": "string", "description": "Name of DHCP Policy Template" }, "policyLevel": { "type": "string", "description": "Level of DHCP Policy Template" }, "policies": { "type": "array", "items": { "type": "object", "properties": { "policyName": { "type": "string", "description": "policy Name" }, "value": { "type": "string", "description": "policy Value" }, "subPolicy": { "type": "array", "items": { "title": "policy", "type": "object", "properties": { "policyName": { "type": "string", "description": "Name of policy" }, "value": { "type": "string", "description": "Value of policy" }, "subPolicy": { "type": "array", "items": { "title": "policy", "type": "object", "properties": { "policyName": { "type": "string", "description": "Name of policy" }, "value": { "type": "string", "description": "Value of policy" } } } } } } } } } } }, "example": { "templateName": "ExampleTemplate", "policyLevel": "Server", "policies": [ { "policyName": "Access Control", "subPolicy": [ { "policyName": "Access Control Enabled", "value": "True", "subPolicy": [ { "policyName": "DefaultClass", "value": "0" }, { "policyName": "ReceiveTimeout", "value": "2000" } ] } ] } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDhcpPolicyTemplate" }, "task": true }, { "name": "modifyDHCPolicyTemplate", "summary": "Modify a DHCP Policy Template.", "description": "Modify a DHCP Policy Template.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "templateName", "type": "string", "info": "DHCP Policy Name: string", "required": true, "schema": { "title": "templateName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request Body: {\"policies\": [{\"policyName\": \"string\", \"value\": \"string\", \"subPolicy\": [{\"policyName\": \"string\", \"value\": \"string\", \"subPolicy\": [{\"policyName\": \"string\", \"value\": \"string\"}]}]}]}", "required": true, "schema": { "type": "object", "xml": { "name": "DhcpPolicyTemplateRest" }, "properties": { "policies": { "type": "array", "items": { "type": "object", "properties": { "policyName": { "type": "string", "description": "policy Name" }, "value": { "type": "string", "description": "policy Value" }, "subPolicy": { "type": "array", "items": { "title": "policy", "type": "object", "properties": { "policyName": { "type": "string", "description": "Name of policy" }, "value": { "type": "string", "description": "Value of policy" }, "subPolicy": { "type": "array", "items": { "title": "policy", "type": "object", "properties": { "policyName": { "type": "string", "description": "Name of policy" }, "value": { "type": "string", "description": "Value of policy" } } } } } } } } } } }, "example": { "policies": [ { "policyName": "Access Control", "subPolicy": [ { "policyName": "Access Control Enabled", "value": "True", "subPolicy": [ { "policyName": "DefaultClass", "value": "0" }, { "policyName": "ReceiveTimeout", "value": "2000" } ] } ] } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyDHCPolicyTemplate" }, "task": true }, { "name": "deleteDHCPPolicyTemplate", "summary": "Delete a DHCP Policy Template", "description": "Delete a DHCP Policy Template by name", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "templateName", "type": "string", "info": "DHCP Policy Template Name: string", "required": true, "schema": { "title": "templateName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDHCPPolicyTemplate" }, "task": true }, { "name": "postV1OrgNameNode", "summary": "Create Node", "description": "Create a new Node", "input": [ { "name": "orgName", "type": "string", "info": "Organization name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"name\": \"string\", \"nodeType\": \"string\", \"uniqueID\": \"string\", \"duid\": \"string\", \"description\": \"string\", \"udas\": [{\"name\": \"string\", \"value\": \"string\"}], \"groups\": [{\"name\": \"string\", \"udas\": [{\"name\": \"string\", \"value\": \"string\"}]}]}", "required": true, "schema": { "type": "object", "description": "Node model", "required": [ "name", "nodeType" ], "properties": { "name": { "type": "string", "description": "Node name" }, "nodeType": { "type": "string", "description": "Node type" }, "uniqueID": { "type": "string" }, "duid": { "type": "string" }, "description": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postV1OrgNameNode" }, "task": true }, { "name": "putV1OrgNameNode", "summary": "Modify Node", "description": "Modify Node", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "uniqueID", "type": "string", "info": "UniqueID: string", "required": true, "schema": { "title": "uniqueID", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "The node request body: {\"name\": \"string\", \"nodeType\": \"string\", \"uniqueID\": \"string\", \"duid\": \"string\", \"description\": \"string\", \"udas\": [{\"name\": \"string\", \"value\": \"string\"}], \"groups\": [{\"name\": \"string\", \"udas\": [{\"name\": \"string\", \"value\": \"string\"}]}]}", "required": true, "schema": { "type": "object", "description": "Node model", "required": [ "name", "nodeType" ], "properties": { "name": { "type": "string", "description": "Node name" }, "nodeType": { "type": "string", "description": "Node type" }, "uniqueID": { "type": "string" }, "duid": { "type": "string" }, "description": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putV1OrgNameNode" }, "task": true }, { "name": "getV1OrgNameNodeExtension", "summary": "Search node", "description": "Search node", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "nodeName", "type": "string", "info": "Node Name: string", "required": false, "schema": { "title": "nodeName", "type": "string" } }, { "name": "uniqueID", "type": "string", "info": "Unique ID of the node: string", "required": false, "schema": { "title": "uniqueID", "type": "string" } }, { "name": "duid", "type": "string", "info": "DUID of the node: string", "required": false, "schema": { "title": "duid", "type": "string" } }, { "name": "addressName", "type": "string", "info": "IP address name: string", "required": false, "schema": { "title": "addressName", "type": "string" } }, { "name": "address", "type": "string", "info": "IP address: string", "required": false, "schema": { "title": "address", "type": "string" } }, { "name": "addressType", "type": "string", "info": "Specifies whether the search returns IPv4 object or IPv6 nodes.\nIf you do not specify either of these options, all nodes are returned regardless of whether they are IPv4 ...(description truncated): Must be one of [V4, V6]", "required": false, "schema": { "title": "addressType", "type": "string" } }, { "name": "pageIndex", "type": "number", "info": "page index: 123", "required": false, "schema": { "title": "pageIndex", "type": "number" } }, { "name": "pageSize", "type": "number", "info": "Page size. Default value is 25.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "description": "Node model", "required": [ "name", "nodeType" ], "properties": { "name": { "type": "string", "description": "Node name" }, "nodeType": { "type": "string", "description": "Node type" }, "uniqueID": { "type": "string" }, "duid": { "type": "string" }, "description": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getV1OrgNameNodeExtension" }, "task": true }, { "name": "getV1OrgNameNodeOptionsExtension", "summary": "Get Node", "description": "Get full profile of a Node by uniqueID or address or DUID", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "options", "type": "string", "info": "Specific options.\nGet node by: uniqueID | address | DUID\nDefault: uniqueID: Must be one of [uniqueID, address, DUID]", "required": true, "schema": { "title": "options", "type": "string" } }, { "name": "nodeInfo", "type": "string", "info": "uniqueID or address or DUID of the node: string", "required": true, "schema": { "title": "nodeInfo", "type": "string" } }, { "name": "addressType", "type": "string", "info": "Use V6 if address is IPv6 address or V4 if address is IPv4 address.\nUse when options is address: Must be one of [V6, V4]", "required": false, "schema": { "title": "addressType", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getV1OrgNameNodeOptionsExtension" }, "task": true }, { "name": "deleteV1OrgNameNodeUniqueID", "summary": "Delete Node", "description": "Delete Node", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "uniqueID", "type": "string", "info": "Unique ID of node being deleted: string", "required": true, "schema": { "title": "uniqueID", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteV1OrgNameNodeUniqueID" }, "task": true }, { "name": "postV1OrgNameNodeLinknodetoipaddresses", "summary": "Link Node to IP addresses", "description": "Link Node to IP addresses", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"uniqueID\": \"string\", \"toAddress\": \"array\", \"addressType\": \"Must be one of [V4, V6]\"}", "required": true, "schema": { "type": "object", "required": [ "uniqueID", "toAddress", "addressType" ], "properties": { "uniqueID": { "type": "string" }, "toAddress": { "type": "array", "description": "toAddress field contain IP addresses with the same type", "items": { "type": "string" } }, "addressType": { "type": "string", "description": "Address type.", "enum": [ "V4", "V6" ] } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postV1OrgNameNodeLinknodetoipaddresses" }, "task": true }, { "name": "postV1OrgNameNodeUnlinkipv4addressesfromnodes", "summary": "unLink IPv4 addresses from Node", "description": "unLink IPv4 addresses from Node", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"uniqueID\": \"string\", \"unlinkIpAddress\": \"array\"}", "required": true, "schema": { "type": "object", "required": [ "uniqueID", "address" ], "properties": { "uniqueID": { "type": "string" }, "unlinkIpAddress": { "type": "array", "description": "address field contain IPv4 address", "items": { "type": "string" } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postV1OrgNameNodeUnlinkipv4addressesfromnodes" }, "task": true }, { "name": "addSubnetOrganization", "summary": "Create a subnet organization", "description": "Create a new subnet organization\n", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "The subnet organization request body: {\"subnetOrgName\": \"string\", \"dhcpServer\": \"string\", \"dhcpOptionTemplate\": \"string\", \"warningType\": 123, \"warningPercent\": 123, \"siteName\": \"string\", \"subnetAddresses\": \"array\", \"globalAllocationPolicys\": [{\"objectClass\": \"string\", \"offset\": 123}], \"domainControllers\": \"array\", \"udas\": {\"name\": \"string\", \"value\": \"string\"}, \"groups\": {\"name\": \"string\", \"udas\": [{\"name\": \"string\", \"value\": \"string\"}]}}", "required": true, "schema": { "type": "object", "required": [ "subnetOrgName" ], "properties": { "subnetOrgName": { "type": "string", "description": "Name of the subnet organization.\n" }, "dhcpServer": { "type": "string", "description": "FQDN of the DHCP Server.\n" }, "dhcpOptionTemplate": { "type": "string", "description": "Name of the DHCP option template.\n" }, "warningType": { "type": "integer" }, "warningPercent": { "type": "integer" }, "siteName": { "type": "string", "description": "The site name of the Windows 2000 site.\nDefaut value is same name as subnet organization\n." }, "subnetAddresses": { "type": "array", "items": { "type": "string" } }, "globalAllocationPolicys": { "type": "array", "items": { "type": "object", "description": "Global allocation policy", "required": [ "objectClass, offset" ], "properties": { "objectClass": { "type": "string" }, "offset": { "type": "integer" } } } }, "domainControllers": { "type": "array", "items": { "type": "string" } }, "udas": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "groups": { "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } }, "example": { "subnetOrgName": "example", "dhcpServer": "dhcp.test.com", "dhcpOptionTemplate": "general", "warningType": 0, "warningPercent": 0, "siteName": "example", "subnetAddresses": [ "10.10.10.0", "11.11.11.0" ], "globalAllocationPolicys": [ { "objectClass": "Server", "offset": "10" }, { "objectClass": "Router", "offset": "-5" } ], "domainControllers": [ "controller.example.com", "controller1.example.com" ], "udas": [ { "name": "at1", "value": "true" } ], "groups": [ { "name": "gr1", "udas": [ { "name": "at1", "value": "false" } ] } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addSubnetOrganization" }, "task": true }, { "name": "getSubnetOrg", "summary": "Get Subnet Organization", "description": "Get profile of a subnet organization by name", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "subnetOrgName", "type": "string", "info": "Subnet organization name: string", "required": true, "schema": { "title": "subnetOrgName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSubnetOrg" }, "task": true }, { "name": "pageSearch", "summary": "Search subnet organization", "description": "Search subnet organization by name, DHCP server, DHCP Option Template, site name or UDA value.", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "subnetOrgName", "type": "string", "info": "Subnet organization name: string", "required": false, "schema": { "title": "subnetOrgName", "type": "string" } }, { "name": "dhcpServerName", "type": "string", "info": "DHCP server name: string", "required": false, "schema": { "title": "dhcpServerName", "type": "string" } }, { "name": "dhcpOptionTemplateName", "type": "string", "info": "DHCP option template name: string", "required": false, "schema": { "title": "dhcpOptionTemplateName", "type": "string" } }, { "name": "siteName", "type": "string", "info": "Site name: string", "required": false, "schema": { "title": "siteName", "type": "string" } }, { "name": "udaName", "type": "string", "info": "Uda name: string", "required": false, "schema": { "title": "udaName", "type": "string" } }, { "name": "udaValue", "type": "string", "info": "Uda value: string", "required": false, "schema": { "title": "udaValue", "type": "string" } }, { "name": "pageIndex", "type": "number", "info": "Page index. Default value is 1.: 123", "required": false, "schema": { "title": "pageIndex", "type": "number" } }, { "name": "pageSize", "type": "number", "info": "Page size. Default value is 25.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "required": [ "subnetOrgName" ], "properties": { "subnetOrgName": { "type": "string", "description": "Name of the subnet organization.\n" }, "dhcpServer": { "type": "string", "description": "FQDN of the DHCP Server.\n" }, "dhcpOptionTemplate": { "type": "string", "description": "Name of the DHCP option template.\n" }, "warningType": { "type": "integer" }, "warningPercent": { "type": "integer" }, "siteName": { "type": "string", "description": "The site name of the Windows 2000 site.\nDefaut value is same name as subnet organization\n." }, "subnetAddresses": { "type": "array", "items": { "type": "string" } }, "globalAllocationPolicys": { "type": "array", "items": { "type": "object", "description": "Global allocation policy", "required": [ "objectClass, offset" ], "properties": { "objectClass": { "type": "string" }, "offset": { "type": "integer" } } } }, "domainControllers": { "type": "array", "items": { "type": "string" } }, "udas": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "groups": { "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } }, "example": { "subnetOrgName": "example", "dhcpServer": "dhcp.test.com", "dhcpOptionTemplate": "general", "warningType": 0, "warningPercent": 0, "siteName": "example", "subnetAddresses": [ "10.10.10.0", "11.11.11.0" ], "globalAllocationPolicys": [ { "objectClass": "Server", "offset": "10" }, { "objectClass": "Router", "offset": "-5" } ], "domainControllers": [ "controller.example.com", "controller1.example.com" ], "udas": [ { "name": "at1", "value": "true" } ], "groups": [ { "name": "gr1", "udas": [ { "name": "at1", "value": "false" } ] } ] } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pageSearch" }, "task": true }, { "name": "modifySubnetOrg", "summary": "Modify a subnet organization", "description": "Modify a subnet organization.\n", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "subnetOrgName", "type": "string", "info": "Subnet organization name: string", "required": true, "schema": { "title": "subnetOrgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "The subnet organization request body: {\"subnetOrgName\": \"string\", \"dhcpServer\": \"string\", \"dhcpOptionTemplate\": \"string\", \"warningType\": 123, \"warningPercent\": 123, \"siteName\": \"string\", \"subnetAddresses\": \"array\", \"globalAllocationPolicys\": [{\"objectClass\": \"string\", \"offset\": 123}], \"domainControllers\": \"array\", \"udas\": {\"name\": \"string\", \"value\": \"string\"}, \"groups\": {\"name\": \"string\", \"udas\": [{\"name\": \"string\", \"value\": \"string\"}]}}", "required": true, "schema": { "type": "object", "required": [ "subnetOrgName" ], "properties": { "subnetOrgName": { "type": "string", "description": "Name of the subnet organization.\n" }, "dhcpServer": { "type": "string", "description": "FQDN of the DHCP Server.\n" }, "dhcpOptionTemplate": { "type": "string", "description": "Name of the DHCP option template.\n" }, "warningType": { "type": "integer" }, "warningPercent": { "type": "integer" }, "siteName": { "type": "string", "description": "The site name of the Windows 2000 site.\nDefaut value is same name as subnet organization\n." }, "subnetAddresses": { "type": "array", "items": { "type": "string" } }, "globalAllocationPolicys": { "type": "array", "items": { "type": "object", "description": "Global allocation policy", "required": [ "objectClass, offset" ], "properties": { "objectClass": { "type": "string" }, "offset": { "type": "integer" } } } }, "domainControllers": { "type": "array", "items": { "type": "string" } }, "udas": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "groups": { "type": "object", "properties": { "name": { "type": "string" }, "udas": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } }, "example": { "subnetOrgName": "example", "dhcpServer": "dhcp.test.com", "dhcpOptionTemplate": "general", "warningType": 0, "warningPercent": 0, "siteName": "example", "subnetAddresses": [ "10.10.10.0", "11.11.11.0" ], "globalAllocationPolicys": [ { "objectClass": "Server", "offset": "10" }, { "objectClass": "Router", "offset": "-5" } ], "domainControllers": [ "controller.example.com", "controller1.example.com" ], "udas": [ { "name": "at1", "value": "true" } ], "groups": [ { "name": "gr1", "udas": [ { "name": "at1", "value": "false" } ] } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifySubnetOrg" }, "task": true }, { "name": "deleteSubnetOrg", "summary": "Delete a subnet organization", "description": "Delete a subnet organization.\n", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "subnetOrgName", "type": "string", "info": "Subnet organization name: string", "required": true, "schema": { "title": "subnetOrgName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSubnetOrg" }, "task": true }, { "name": "createDHCPAndV4SubnetMacPool", "summary": "Add a MAC to a DHCP Server or V4 Subnet MAC Pool", "description": "Add a MAC to a DHCP Server or V4 Subnet MAC Pool", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "infraValue", "type": "string", "info": "DHCP Server FQDN or the V4 Subnet Address: string", "required": true, "schema": { "title": "infraValue", "type": "string" } }, { "name": "infraType", "type": "string", "info": "infrastructure type: DHCP | V4SUBNET: Must be one of [DHCP Server, V4SUBNET]", "required": true, "schema": { "title": "infraType", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"macAddress\": \"string\", \"hardwareType\": \"string\", \"excludeFlag\": \"string\"}", "required": true, "schema": { "type": "object", "required": [ "macAddress", "hardwareType", "excludeFlag" ], "properties": { "macAddress": { "type": "string", "description": "Mac Address of Mac Pool" }, "hardwareType": { "type": "string", "description": "Hardware Type of Mac Pool" }, "excludeFlag": { "type": "string", "description": "Exclude a MAC address from the pool" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDHCPAndV4SubnetMacPool" }, "task": true }, { "name": "modifyDHCPAndV4SubnetMacPool", "summary": "Modify MAC to a DHCP Server or V4 Subnet MAC Pool", "description": "Modify MAC to a DHCP Server or V4 Subnet MAC Pool", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "infraValue", "type": "string", "info": "DHCP Server FQDN or the V4 Subnet Address: string", "required": true, "schema": { "title": "infraValue", "type": "string" } }, { "name": "infraType", "type": "string", "info": "infrastructure type: DHCP | V4SUBNET: Must be one of [DHCP Server, V4SUBNET]", "required": true, "schema": { "title": "infraType", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"macPool\": [{\"macAddress\": \"string\", \"hardwareType\": \"string\", \"excludeFlag\": \"string\"}]}", "required": true, "schema": { "type": "object", "xml": { "name": "list" }, "properties": { "macPool": { "type": "array", "items": { "type": "object", "required": [ "macAddress", "hardwareType", "excludeFlag" ], "properties": { "macAddress": { "type": "string", "description": "Mac Address of Mac Pool" }, "hardwareType": { "type": "string", "description": "Hardware Type of Mac Pool" }, "excludeFlag": { "type": "string", "description": "Exclude a MAC address from the pool" } } } } }, "example": { "list": [ { "macAddress": "2c549188c9e3", "hardwareType": "Ethernet", "excludeFlag": "true" }, { "macAddress": "112233445566", "hardwareType": "Chaos", "excludeFlag": "false" } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyDHCPAndV4SubnetMacPool" }, "task": true }, { "name": "deleteDHCPAndV4SubnetMacPool", "summary": "Delete MAC for a DHCP Server or V4 Subnet MAC Pool", "description": "Delete MAC for a DHCP Server or V4 Subnet MAC Pool", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "infraValue", "type": "string", "info": "DHCP Server FQDN or the V4 Subnet Address: string", "required": true, "schema": { "title": "infraValue", "type": "string" } }, { "name": "infraType", "type": "string", "info": "infrastructure type: DHCP | V4SUBNET: Must be one of [DHCP Server, V4SUBNET]", "required": true, "schema": { "title": "infraType", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "Request body: {\"macPool\": [{\"macAddress\": \"string\", \"hardwareType\": \"string\"}]}", "required": true, "schema": { "type": "object", "properties": { "macPool": { "type": "array", "items": { "type": "object", "required": [ "macAddress", "hardwareType" ], "properties": { "macAddress": { "type": "string", "description": "Mac Address of Mac Pool" }, "hardwareType": { "type": "string", "description": "Hardware Type of Mac Pool" } } } } }, "xml": { "name": "list" }, "example": { "list": [ { "macAddress": "2c549188c9e3", "hardwareType": "Ethernet" }, { "macAddress": "112233445566", "hardwareType": "Chaos" } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDHCPAndV4SubnetMacPool" }, "task": true }, { "name": "getDHCPAndV4SubnetMacPool", "summary": "Get list MAC for a DHCP Server or V4 Subnet MAC Pool", "description": "Get list MAC for a DHCP Server or V4 Subnet MAC Pool", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } }, { "name": "infraValue", "type": "string", "info": "DHCP Server FQDN or the V4 Subnet Address: string", "required": true, "schema": { "title": "infraValue", "type": "string" } }, { "name": "infraType", "type": "string", "info": "infrastructure type: DHCP | V4SUBNET: Must be one of [DHCP Server, V4SUBNET]", "required": true, "schema": { "title": "infraType", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDHCPAndV4SubnetMacPool" }, "task": true }, { "name": "addACLTemplate", "summary": "Create ACL Template", "description": "Create ACL Template\n", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "The ACL Template request body: {\"name\": \"string\", \"templateElements\": [{\"type\": \"string\", \"value\": \"string\", \"include\": \"boolean\"}]}", "required": true, "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of ACL Template.\n" }, "templateElements": { "type": "array", "items": { "type": "object", "description": "ACL Template Element(s)", "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "include": { "type": "boolean" } } } } }, "example": { "name": "example", "templateElements": [ { "type": "Text", "value": "example", "include": false }, { "type": "IPv4 Address", "value": "10.10.10.10", "include": false }, { "type": "IPv4 Address", "value": "11.11.11.11", "include": true }, { "type": "IPv6 Address", "value": "2000::1", "include": false } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addACLTemplate" }, "task": true }, { "name": "getACLTemplate", "summary": "Get ACL Template", "description": "Get ACL Template by name", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "aclTemplateName", "type": "string", "info": "ACL Template Name: string", "required": true, "schema": { "title": "aclTemplateName", "type": "string" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getACLTemplate" }, "task": true }, { "name": "modifyAclTemplate", "summary": "Modify ACL Template", "description": "Modify ACL Template.\n", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "aclTemplateName", "type": "string", "info": "ACL Template Name: string", "required": true, "schema": { "title": "aclTemplateName", "type": "string" } }, { "name": "requestBody", "type": "object", "info": "The ACL Template request body: {\"name\": \"string\", \"templateElements\": [{\"type\": \"string\", \"value\": \"string\", \"include\": \"boolean\"}]}", "required": true, "schema": { "type": "object", "title": "ACLTemplateRec", "xml": { "name": "ACLTemplateRec" }, "properties": { "name": { "type": "string", "description": "Name of ACL Template.\n" }, "templateElements": { "type": "array", "items": { "type": "object", "description": "ACL Template Element(s)", "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "include": { "type": "boolean" } } } } }, "example": { "name": "example", "templateElements": [ { "type": "Text", "value": "example", "include": false }, { "type": "IPv4 Address", "value": "10.10.10.10", "include": false }, { "type": "IPv4 Address", "value": "11.11.11.11", "include": true }, { "type": "IPv6 Address", "value": "2000::1", "include": false } ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyAclTemplate" }, "task": true }, { "name": "deleteAclTemplate", "summary": "Delete ACL Template", "description": "Delete ACL Template.\n", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "aclTemplateName", "type": "string", "info": "ACL Template Name: string", "required": true, "schema": { "title": "aclTemplateName", "type": "string" } }, { "name": "force", "type": "boolean", "info": "Delete this ACL template even if it is referenced by something else.\n\nDefault is false.: boolean", "required": true, "schema": { "title": "force", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAclTemplate" }, "task": true }, { "name": "searchACLTemplate", "summary": "Search ACL template", "description": "Search ACL Template by name and template element", "input": [ { "name": "orgName", "type": "string", "info": "Organization Name: string", "required": true, "schema": { "title": "orgName", "type": "string" } }, { "name": "aclTemplateName", "type": "string", "info": "ACL Template Name. Support the wildcard search with following forms: ✱ or ✱abc or abc✱ or a✱c;: string", "required": false, "schema": { "title": "aclTemplateName", "type": "string" } }, { "name": "templateElementType", "type": "string", "info": "ACL Template Type: Must be one of [ACL Template, Key, IPv4 Address, IPv4 Network, IPv6 Address, IPv6 Network, Text, Other, All]", "required": false, "schema": { "title": "templateElementType", "type": "string" } }, { "name": "templateElementValue", "type": "string", "info": "Template Element Value. Support the wildcard search with following forms: ✱ or ✱abc or abc✱ or a✱c;: string", "required": false, "schema": { "title": "templateElementValue", "type": "string" } }, { "name": "pageIndex", "type": "number", "info": "Page index. Default value is 1.: 123", "required": false, "schema": { "title": "pageIndex", "type": "number" } }, { "name": "pageSize", "type": "number", "info": "Page size. Default value is 25.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "extension", "type": "string", "info": ".json for a response in JSON format. \n.xml for a response in XML format.\n: Must be one of [.json, .xml]", "required": true, "schema": { "title": "extension", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of ACL Template.\n" }, "templateElements": { "type": "array", "items": { "type": "object", "description": "ACL Template Element(s)", "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "include": { "type": "boolean" } } } } }, "example": { "name": "example", "templateElements": [ { "type": "Text", "value": "example", "include": false }, { "type": "IPv4 Address", "value": "10.10.10.10", "include": false }, { "type": "IPv4 Address", "value": "11.11.11.11", "include": true }, { "type": "IPv6 Address", "value": "2000::1", "include": false } ] } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/searchACLTemplate" }, "task": true } ], "views": [] }