UNPKG

@itentialopensource/adapter-ns1_enterprise

Version:

This adapter integrates with system described as: ns1_enterprise.

1,716 lines (1,715 loc) 183 kB
{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/ops/bootstrap": { "post": { "tags": [ "Operations" ], "operationId": "postOpsBootstrap", "description": "The parameters and request body are for method: postOpsBootstrap. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" } } }, "example": { "user": "string", "name": "string", "email": "string", "password": "string" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/ops/operators": { "get": { "tags": [ "Operations" ], "operationId": "getOpsOperators", "description": "The parameters and request body are for method: getOpsOperators. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "two_factor_auth": { "type": "object", "properties": { "secret": { "type": "string" }, "type": { "type": "string" } } }, "name": { "type": "string" }, "id": { "type": "string" }, "user": { "type": "string" }, "key": { "type": "string" }, "last_access": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" } } } }, "example": [ { "two_factor_auth": { "secret": "string", "type": "string" }, "name": "string", "id": "string", "user": "string", "key": "string", "last_access": "string", "password": "string", "email": "string" }, { "two_factor_auth": { "secret": "string", "type": "string" }, "name": "string", "id": "string", "user": "string", "key": "string", "last_access": "string", "password": "string", "email": "string" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Operations" ], "operationId": "putOpsOperators", "description": "The parameters and request body are for method: putOpsOperators. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "two_factor_auth": { "type": "object", "properties": { "secret": { "type": "string" }, "type": { "type": "string" } } }, "name": { "type": "string" }, "id": { "type": "string" }, "user": { "type": "string" }, "key": { "type": "string" }, "last_access": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" } } }, "example": { "two_factor_auth": { "secret": "string", "type": "string" }, "name": "string", "id": "string", "user": "string", "key": "string", "last_access": "string", "password": "string", "email": "string" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/ops/operators/{operatorId}": { "get": { "tags": [ "Operations" ], "operationId": "getOpsOperatorsOperatorId", "description": "The parameters and request body are for method: getOpsOperatorsOperatorId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "two_factor_auth": { "type": "object", "properties": { "secret": { "type": "string" }, "type": { "type": "string" } } }, "name": { "type": "string" }, "id": { "type": "string" }, "user": { "type": "string" }, "key": { "type": "string" }, "last_access": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" } } }, "example": { "two_factor_auth": { "secret": "string", "type": "string" }, "name": "string", "id": "string", "user": "string", "key": "string", "last_access": "string", "password": "string", "email": "string" } } } } }, "parameters": [ { "name": "operatorId", "in": "path", "required": true, "schema": { "title": "operatorId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Operations" ], "operationId": "postOpsOperatorsOperatorId", "description": "The parameters and request body are for method: postOpsOperatorsOperatorId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "two_factor_auth": { "type": "object", "properties": { "secret": { "type": "string" }, "type": { "type": "string" } } }, "name": { "type": "string" }, "id": { "type": "string" }, "user": { "type": "string" }, "key": { "type": "string" }, "last_access": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" } } }, "example": { "two_factor_auth": { "secret": "string", "type": "string" }, "name": "string", "id": "string", "user": "string", "key": "string", "last_access": "string", "password": "string", "email": "string" } } } } }, "parameters": [ { "name": "operatorId", "in": "path", "required": true, "schema": { "title": "operatorId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Operations" ], "operationId": "deleteOpsOperatorsOperatorId", "description": "The parameters and request body are for method: deleteOpsOperatorsOperatorId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "operatorId", "in": "path", "required": true, "schema": { "title": "operatorId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/ops/orgs": { "get": { "tags": [ "Operations" ], "operationId": "getOpsOrgs", "description": "The parameters and request body are for method: getOpsOrgs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "org_id": { "type": "number" }, "ts_create": { "type": "string" }, "ts_update": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "number" } } } }, "example": [ { "org_id": 2000, "ts_create": "2019-08-05T19:37:08.065Z", "ts_update": "2019-08-05T19:37:08.065Z", "name": "My Company", "id": 2000 }, { "org_id": 2000, "ts_create": "2019-08-05T19:37:08.065Z", "ts_update": "2019-08-05T19:37:08.065Z", "name": "My Company", "id": 2000 }, { "org_id": 2000, "ts_create": "2019-08-05T19:37:08.065Z", "ts_update": "2019-08-05T19:37:08.065Z", "name": "My Company", "id": 2000 }, { "org_id": 2000, "ts_create": "2019-08-05T19:37:08.065Z", "ts_update": "2019-08-05T19:37:08.065Z", "name": "My Company", "id": 2000 } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Operations" ], "operationId": "putOpsOrgs", "description": "The parameters and request body are for method: putOpsOrgs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "org_id": { "type": "number" }, "ts_create": { "type": "string" }, "ts_update": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "number" } } }, "example": { "org_id": 2000, "ts_create": "2019-08-05T19:37:08.065Z", "ts_update": "2019-08-05T19:37:08.065Z", "name": "My Company", "id": 2000 } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/ops/orgs/{orgid}": { "get": { "tags": [ "Operations" ], "operationId": "getOpsOrgsOrgid", "description": "The parameters and request body are for method: getOpsOrgsOrgid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "org_id": { "type": "number" }, "ts_create": { "type": "string" }, "ts_update": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "number" } } }, "example": { "org_id": 2000, "ts_create": "2019-08-05T19:37:08.065Z", "ts_update": "2019-08-05T19:37:08.065Z", "name": "My Company", "id": 2000 } } } } }, "parameters": [ { "name": "orgid", "in": "path", "required": true, "schema": { "title": "orgid", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Operations" ], "operationId": "postOpsOrgsOrgid", "description": "The parameters and request body are for method: postOpsOrgsOrgid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "org_id": { "type": "number" }, "ts_create": { "type": "string" }, "ts_update": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "number" } } }, "example": { "org_id": 2000, "ts_create": "2019-08-05T19:37:08.065Z", "ts_update": "2019-08-05T19:37:08.065Z", "name": "My Company", "id": 2000 } } } } }, "parameters": [ { "name": "orgid", "in": "path", "required": true, "schema": { "title": "orgid", "type": "number" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "Operations" ], "operationId": "deleteOpsOrgsOrgid", "description": "The parameters and request body are for method: deleteOpsOrgsOrgid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "orgid", "in": "path", "required": true, "schema": { "title": "orgid", "type": "number" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/ops/orgs/{orgid}/service/groups": { "get": { "tags": [ "Operations" ], "operationId": "getOpsOrgsOrgidServiceGroups", "description": "The parameters and request body are for method: getOpsOrgsOrgidServiceGroups. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "properties": { "type": "object" }, "id": { "type": "number" }, "name": { "type": "string" } } } }, "example": [ { "properties": {}, "id": 2, "name": "string" } ] } } } }, "parameters": [ { "name": "orgid", "in": "path", "required": true, "schema": { "title": "orgid", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/ops/service/defs": { "get": { "tags": [ "ServiceDefinitions" ], "operationId": "getOpsServiceDefs", "description": "The parameters and request body are for method: getOpsServiceDefs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "config_tree_id": { "type": "number" }, "properties": { "type": "object" }, "nameservers": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" } } } }, "example": [ { "config_tree_id": 4, "properties": {}, "nameservers": [ "string", "string", "string", "string", "string" ], "type": "string", "id": 4, "name": "string" }, { "config_tree_id": 6, "properties": {}, "nameservers": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "type": "string", "id": 2, "name": "string" }, { "config_tree_id": 5, "properties": {}, "nameservers": [ "string", "string", "string", "string", "string" ], "type": "string", "id": 9, "name": "string" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "ServiceDefinitions" ], "operationId": "putOpsServiceDefs", "description": "The parameters and request body are for method: putOpsServiceDefs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "config_tree_id": { "type": "number" }, "properties": { "type": "object" }, "nameservers": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" } } }, "example": { "config_tree_id": 7, "properties": {}, "nameservers": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "type": "string", "id": 3, "name": "string" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/ops/service/defs/{definitionid}": { "get": { "tags": [ "ServiceDefinitions" ], "operationId": "getOpsServiceDefsDefinitionid", "description": "The parameters and request body are for method: getOpsServiceDefsDefinitionid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "config_tree_id": { "type": "number" }, "properties": { "type": "object" }, "nameservers": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" } } }, "example": { "config_tree_id": 3, "properties": {}, "nameservers": [ "string", "string", "string", "string" ], "type": "string", "id": 4, "name": "string" } } } } }, "parameters": [ { "name": "definitionid", "in": "path", "required": true, "schema": { "title": "definitionid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "ServiceDefinitions" ], "operationId": "postOpsServiceDefsDefinitionid", "description": "The parameters and request body are for method: postOpsServiceDefsDefinitionid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "config_tree_id": { "type": "number" }, "properties": { "type": "object" }, "nameservers": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" } } }, "example": { "config_tree_id": 1, "properties": {}, "nameservers": [ "string" ], "type": "string", "id": 3, "name": "string" } } } } }, "parameters": [ { "name": "definitionid", "in": "path", "required": true, "schema": { "title": "definitionid", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "ServiceDefinitions" ], "operationId": "deleteOpsServiceDefsDefinitionid", "description": "The parameters and request body are for method: deleteOpsServiceDefsDefinitionid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "definitionid", "in": "path", "required": true, "schema": { "title": "definitionid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/ops/service/groups": { "get": { "tags": [ "ServiceGroups" ], "operationId": "getOpsServiceGroups", "description": "The parameters and request body are for method: getOpsServiceGroups. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "properties": { "type": "object" }, "id": { "type": "number" }, "name": { "type": "string" } } } }, "example": [ { "properties": {}, "id": 6, "name": "string" }, { "properties": {}, "id": 9, "name": "string" }, { "properties": {}, "id": 1, "name": "string" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "ServiceGroups" ], "operationId": "putOpsServiceGroups", "description": "The parameters and request body are for method: putOpsServiceGroups. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "properties": { "type": "object" }, "id": { "type": "number" }, "name": { "type": "string" } } }, "example": { "properties": {}, "id": 1, "name": "string" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/ops/service/groups/{servicegroupid}": { "get": { "tags": [ "ServiceGroups" ], "operationId": "getOpsServiceGroupsServicegroupid", "description": "The parameters and request body are for method: getOpsServiceGroupsServicegroupid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "properties": { "type": "object" }, "id": { "type": "number" }, "name": { "type": "string" } } }, "example": { "properties": {}, "id": 1, "name": "string" } } } } }, "parameters": [ { "name": "servicegroupid", "in": "path", "required": true, "schema": { "title": "servicegroupid", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "ServiceGroups" ], "operationId": "postOpsServiceGroupsServicegroupid", "description": "The parameters and request body are for method: postOpsServiceGroupsServicegroupid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "properties": { "type": "object" }, "id": { "type": "number" }, "name": { "type": "string" } } }, "example": { "properties": {}, "id": 1, "name": "string" } } } } }, "parameters": [ { "name": "servicegroupid", "in": "path", "required": true, "schema": { "title": "servicegroupid", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "ServiceGroups" ], "operationId": "deleteOpsServiceGroupsServicegroupid", "description": "The parameters and request body are for method: deleteOpsServiceGroupsServicegroupid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "servicegroupid", "in": "path", "required": true, "schema": { "title": "servicegroupid", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/ops/service/groups/{servicegroupid}/org/{orgid}": { "post": { "tags": [ "ServiceGroups" ], "operationId": "postOpsServiceGroupsServicegroupidOrgOrgid", "description": "The parameters and request body are for method: postOpsServiceGroupsServicegroupidOrgOrgid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "org_id": { "type": "string" }, "service_group_id": { "type": "string" } } }, "example": { "status": "success", "org_id": "2000", "service_group_id": "2" } } } } }, "parameters": [ { "name": "servicegroupid", "in": "path", "required": true, "schema": { "title": "servicegroupid", "type": "number" } }, { "name": "orgid", "in": "path", "required": true, "schema": { "title": "orgid", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/ops/service/groups/{servicegroupid}/orgs": { "get": { "tags": [ "ServiceGroups" ], "operationId": "getOpsServiceGroupsServicegroupidOrgs", "description": "The parameters and request body are for method: getOpsServiceGroupsServicegroupidOrgs. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "org_id": { "type": "number" }, "ts_create": { "type": "string" }, "ts_update": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "number" } } } }, "example": [ { "org_id": 2000, "ts_create": "2019-08-05T19:37:08.065Z", "ts_update": "2019-08-05T19:37:08.065Z", "name": "My Company", "id": 2000 }, { "org_id": 2000, "ts_create": "2019-08-05T19:37:08.065Z", "ts_update": "2019-08-05T19:37:08.065Z", "name": "My Company", "id": 2000 } ] } } } }, "parameters": [ { "name": "servicegroupid", "in": "path", "required": true, "schema": { "title": "servicegroupid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/ipam/network": { "get": { "tags": [ "IPAM" ], "operationId": "getIpamNetwork", "description": "The parameters and request body are for method: getIpamNetwork. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "rt": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "desc": { "type": "string" }, "kvps": { "type": "object" }, "free_addresses_v4": { "type": "string" }, "used_addresses_v4": { "type": "string" }, "total_addresses_v4": { "type": "string" }, "num_prefixes_v4": { "type": "string" }, "free_addresses_v6": { "type": "string" }, "used_addresses_v6": { "type": "string" }, "total_addresses_v6": { "type": "string" }, "num_prefixes_v6": { "type": "string" }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "addr_id": { "type": "number" }, "prefix": { "type": "string" }, "name": { "type": "string" } } } } } } }, "example": [ { "name": "string", "rt": "string", "tags": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "desc": "string", "kvps": {}, "free_addresses_v4": "string", "used_addresses_v4": "string", "total_addresses_v4": "string", "num_prefixes_v4": "string", "free_addresses_v6": "string", "used_addresses_v6": "string", "total_addresses_v6": "string", "num_prefixes_v6": "string", "addresses": [ { "addr_id": 0, "prefix": "string", "name": "string" } ] }, { "name": "string", "rt": "string", "tags": [ "string" ], "desc": "string",