@itentialopensource/adapter-netbox_v210

{ "id": "@itentialopensource/adapter-netbox_v210", "type": "Adapter", "export": "NetboxV210", "title": "Netbox_v210", "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" } } ], "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": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "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 Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform 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": "getCircuitsCircuitTerminations", "summary": "circuits_circuit-terminations_list", "description": "circuits_circuit-terminations_list", "input": [ { "name": "termSide", "type": "string", "info": ": string", "required": false, "schema": { "title": "termSide", "type": "string" } }, { "name": "portSpeed", "type": "string", "info": ": string", "required": false, "schema": { "title": "portSpeed", "type": "string" } }, { "name": "upstreamSpeed", "type": "string", "info": ": string", "required": false, "schema": { "title": "upstreamSpeed", "type": "string" } }, { "name": "xconnectId", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectId", "type": "string" } }, { "name": "cabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "cabled", "type": "string" } }, { "name": "connected", "type": "string", "info": ": string", "required": false, "schema": { "title": "connected", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "circuitId", "type": "string", "info": ": string", "required": false, "schema": { "title": "circuitId", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "termSideN", "type": "string", "info": ": string", "required": false, "schema": { "title": "termSideN", "type": "string" } }, { "name": "portSpeedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "portSpeedN", "type": "string" } }, { "name": "portSpeedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "portSpeedLte", "type": "string" } }, { "name": "portSpeedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "portSpeedLt", "type": "string" } }, { "name": "portSpeedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "portSpeedGte", "type": "string" } }, { "name": "portSpeedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "portSpeedGt", "type": "string" } }, { "name": "upstreamSpeedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "upstreamSpeedN", "type": "string" } }, { "name": "upstreamSpeedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "upstreamSpeedLte", "type": "string" } }, { "name": "upstreamSpeedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "upstreamSpeedLt", "type": "string" } }, { "name": "upstreamSpeedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "upstreamSpeedGte", "type": "string" } }, { "name": "upstreamSpeedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "upstreamSpeedGt", "type": "string" } }, { "name": "xconnectIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdN", "type": "string" } }, { "name": "xconnectIdIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdIc", "type": "string" } }, { "name": "xconnectIdNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdNic", "type": "string" } }, { "name": "xconnectIdIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdIew", "type": "string" } }, { "name": "xconnectIdNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdNiew", "type": "string" } }, { "name": "xconnectIdIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdIsw", "type": "string" } }, { "name": "xconnectIdNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdNisw", "type": "string" } }, { "name": "xconnectIdIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdIe", "type": "string" } }, { "name": "xconnectIdNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdNie", "type": "string" } }, { "name": "circuitIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "circuitIdN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "circuit", "term_side", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "circuit": { "required": [ "cid" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "cid": { "title": "Circuit ID", "type": "string", "maxLength": 100, "minLength": 1 } } }, "term_side": { "title": "Termination", "type": "string", "enum": [ "A", "Z" ] }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } } }, "port_speed": { "title": "Port speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "upstream_speed": { "title": "Upstream speed (Kbps)", "description": "Upstream speed, if different from port speed", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "xconnect_id": { "title": "Cross-connect ID", "type": "string", "maxLength": 50 }, "pp_info": { "title": "Patch panel/port(s)", "type": "string", "maxLength": 100 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_peer": { "title": "Cable peer", "description": "\nReturn the appropriate serializer for the cable termination model.\n", "type": "object", "additionalProperties": { "type": "string", "x-nullable": true }, "readOnly": true }, "cable_peer_type": { "title": "Cable peer type", "type": "string", "readOnly": true }, "connected_endpoint": { "title": "Connected endpoint", "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "object", "additionalProperties": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoint_type": { "title": "Connected endpoint type", "type": "string", "readOnly": true }, "connected_endpoint_reachable": { "title": "Connected endpoint reachable", "type": "boolean", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCircuitsCircuitTerminations" }, "task": true }, { "name": "postCircuitsCircuitTerminations", "summary": "circuits_circuit-terminations_create", "description": "circuits_circuit-terminations_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"circuit\": 123, \"term_side\": \"Must be one of [A, Z]\", \"site\": 123, \"port_speed\": 123, \"upstream_speed\": 123, \"xconnect_id\": \"string\", \"pp_info\": \"string\", \"description\": \"string\", \"cable\": {\"id\": 123, \"url\": \"string\", \"label\": \"string\"}, \"cable_peer\": \"object\", \"cable_peer_type\": \"string\", \"connected_endpoint\": \"object\", \"connected_endpoint_type\": \"string\", \"connected_endpoint_reachable\": \"boolean\"}", "required": true, "schema": { "required": [ "circuit", "term_side", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "circuit": { "title": "Circuit", "type": "integer" }, "term_side": { "title": "Termination", "type": "string", "enum": [ "A", "Z" ] }, "site": { "title": "Site", "type": "integer" }, "port_speed": { "title": "Port speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "upstream_speed": { "title": "Upstream speed (Kbps)", "description": "Upstream speed, if different from port speed", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "xconnect_id": { "title": "Cross-connect ID", "type": "string", "maxLength": 50 }, "pp_info": { "title": "Patch panel/port(s)", "type": "string", "maxLength": 100 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_peer": { "title": "Cable peer", "description": "\nReturn the appropriate serializer for the cable termination model.\n", "type": "object", "additionalProperties": { "type": "string", "x-nullable": true }, "readOnly": true }, "cable_peer_type": { "title": "Cable peer type", "type": "string", "readOnly": true }, "connected_endpoint": { "title": "Connected endpoint", "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "object", "additionalProperties": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoint_type": { "title": "Connected endpoint type", "type": "string", "readOnly": true }, "connected_endpoint_reachable": { "title": "Connected endpoint reachable", "type": "boolean", "readOnly": true } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "circuit", "term_side", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "circuit": { "required": [ "cid" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "cid": { "title": "Circuit ID", "type": "string", "maxLength": 100, "minLength": 1 } } }, "term_side": { "title": "Termination", "type": "string", "enum": [ "A", "Z" ] }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } } }, "port_speed": { "title": "Port speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "upstream_speed": { "title": "Upstream speed (Kbps)", "description": "Upstream speed, if different from po