@itentialopensource/adapter-bluecat

{ "openapi": "3.0.0", "info": { "title": "ProteusAPI", "contact": {}, "version": "1.0" }, "servers": [ { "url": "https://gtipam.dns.gatech.edu:443/Services/API", "variables": {} } ], "paths": { "/getEntityById": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getEntityById", "operationId": "getEntityById", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getEntityById", "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getEntityByIdResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntityByIdResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/replaceServer": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "replaceServer", "operationId": "replaceServer", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "replaceServer", "required": [ "serverId", "name", "defaultInterface", "hostName", "password", "upgrade", "properties" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "defaultInterface": { "type": "string" }, "hostName": { "type": "string" }, "password": { "type": "string" }, "upgrade": { "type": "boolean" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "replaceServerResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addServer": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addServer", "operationId": "addServer", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addServer", "required": [ "configurationId", "name", "defaultInterfaceAddress", "fullHostName", "profile", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "defaultInterfaceAddress": { "type": "string" }, "fullHostName": { "type": "string" }, "profile": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addServerResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addServerResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/moveDeploymentRoles": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "moveDeploymentRoles", "operationId": "moveDeploymentRoles", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "moveDeploymentRoles", "required": [ "sourceServerId", "targetServerInterfaceId", "moveDnsRoles", "moveDhcpRoles", "options" ], "type": "object", "properties": { "sourceServerId": { "type": "integer", "format": "int64" }, "targetServerInterfaceId": { "type": "integer", "format": "int64" }, "moveDnsRoles": { "type": "boolean" }, "moveDhcpRoles": { "type": "boolean" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "moveDeploymentRolesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getEntities": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getEntities", "operationId": "getEntities", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getEntities", "required": [ "parentId", "type", "start", "count" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getEntitiesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntitiesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/login": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "login", "operationId": "login", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "login", "required": [ "username", "password" ], "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "loginResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/logout": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "logout", "operationId": "logout", "parameters": [], "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "logoutResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addUser": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addUser", "operationId": "addUser", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addUser", "required": [ "username", "password", "properties" ], "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addUserResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addUserResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addAccessRight": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addAccessRight", "operationId": "addAccessRight", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addAccessRight", "required": [ "entityId", "userId", "value", "overrides", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64" }, "value": { "type": "string" }, "overrides": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addAccessRightResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addAccessRightResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addEntity": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addEntity", "operationId": "addEntity", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addEntity", "required": [ "parentId", "entity" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "entity": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addEntityResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addEntityResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getProbeStatus": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getProbeStatus", "operationId": "getProbeStatus", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getProbeStatus", "required": [ "definedProbe" ], "type": "object", "properties": { "definedProbe": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getProbeStatusResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int32", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getProbeStatusResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/loginWithOptions": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "loginWithOptions", "operationId": "loginWithOptions", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "loginWithOptions", "required": [ "username", "password", "options" ], "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "loginWithOptionsResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addIP4BlockByCIDR": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addIP4BlockByCIDR", "operationId": "addIP4BlockByCIDR", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addIP4BlockByCIDR", "required": [ "parentId", "CIDR", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "CIDR": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addIP4BlockByCIDRResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP4BlockByCIDRResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addIP4BlockByRange": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addIP4BlockByRange", "operationId": "addIP4BlockByRange", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addIP4BlockByRange", "required": [ "parentId", "start", "end", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "start": { "type": "string" }, "end": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addIP4BlockByRangeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP4BlockByRangeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDHCP4Range": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDHCP4Range", "operationId": "addDHCP4Range", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDHCP4Range", "required": [ "networkId", "start", "end", "properties" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" }, "start": { "type": "string" }, "end": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDHCP4RangeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCP4RangeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDHCP4RangeBySize": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDHCP4RangeBySize", "operationId": "addDHCP4RangeBySize", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDHCP4RangeBySize", "required": [ "networkId", "offset", "size", "properties" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" }, "offset": { "type": "string" }, "size": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDHCP4RangeBySizeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCP4RangeBySizeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDHCP6Range": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDHCP6Range", "operationId": "addDHCP6Range", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDHCP6Range", "required": [ "networkId", "start", "end", "properties" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" }, "start": { "type": "string" }, "end": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDHCP6RangeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCP6RangeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDHCP6RangeBySize": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDHCP6RangeBySize", "operationId": "addDHCP6RangeBySize", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDHCP6RangeBySize", "required": [ "networkId", "start", "size", "properties" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" }, "start": { "type": "string" }, "size": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDHCP6RangeBySizeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCP6RangeBySizeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDHCPMatchClass": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDHCPMatchClass", "operationId": "addDHCPMatchClass", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDHCPMatchClass", "required": [ "configurationId", "name", "matchCriteria", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "matchCriteria": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDHCPMatchClassResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCPMatchClassResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDHCPSubClass": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDHCPSubClass", "operationId": "addDHCPSubClass", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDHCPSubClass", "required": [ "matchClassId", "matchValue", "properties" ], "type": "object", "properties": { "matchClassId": { "type": "integer", "format": "int64" }, "matchValue": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDHCPSubClassResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCPSubClassResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addView": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addView", "operationId": "addView", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addView", "required": [ "configurationId", "name", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addViewResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addViewResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addZone": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addZone", "operationId": "addZone", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addZone", "required": [ "parentId", "absoluteName", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addZoneResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addZoneResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addExternalHostRecord": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addExternalHostRecord", "operationId": "addExternalHostRecord", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addExternalHostRecord", "required": [ "viewId", "name", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addExternalHostRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addExternalHostRecordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addEnumZone": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addEnumZone", "operationId": "addEnumZone", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addEnumZone", "required": [ "parentId", "prefix", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "prefix": { "type": "integer", "format": "int32" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addEnumZoneResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addEnumZoneResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addEnumNumber": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addEnumNumber", "operationId": "addEnumNumber", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addEnumNumber", "required": [ "enumZoneId", "number", "properties" ], "type": "object", "properties": { "enumZoneId": { "type": "integer", "format": "int64" }, "number": { "type": "integer", "format": "int32" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addEnumNumberResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addEnumNumberResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addResourceRecord": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addResourceRecord", "operationId": "addResourceRecord", "parameters": [], "requestBody": {