{ "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": { "description": "", "content": { "application/xml": { "schema": { "title": "addResourceRecord", "required": [ "viewId", "absoluteName", "type", "rdata", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "type": { "type": "string" }, "rdata": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addResourceRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addResourceRecordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addHostRecord": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addHostRecord", "operationId": "addHostRecord", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addHostRecord", "required": [ "viewId", "absoluteName", "addresses", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "addresses": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addHostRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addHostRecordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addAliasRecord": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addAliasRecord", "operationId": "addAliasRecord", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addAliasRecord", "required": [ "viewId", "absoluteName", "linkedRecordName", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "linkedRecordName": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addAliasRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addAliasRecordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addMXRecord": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addMXRecord", "operationId": "addMXRecord", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addMXRecord", "required": [ "viewId", "absoluteName", "priority", "linkedRecordName", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "linkedRecordName": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addMXRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addMXRecordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addSRVRecord": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addSRVRecord", "operationId": "addSRVRecord", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addSRVRecord", "required": [ "viewId", "absoluteName", "priority", "port", "weight", "linkedRecordName", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "port": { "type": "integer", "format": "int32" }, "weight": { "type": "integer", "format": "int32" }, "linkedRecordName": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addSRVRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addSRVRecordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addTXTRecord": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addTXTRecord", "operationId": "addTXTRecord", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addTXTRecord", "required": [ "viewId", "absoluteName", "txt", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "txt": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addTXTRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addTXTRecordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addHINFORecord": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addHINFORecord", "operationId": "addHINFORecord", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addHINFORecord", "required": [ "viewId", "absoluteName", "cpu", "os", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "cpu": { "type": "string" }, "os": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addHINFORecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addHINFORecordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addNAPTRRecord": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addNAPTRRecord", "operationId": "addNAPTRRecord", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addNAPTRRecord", "required": [ "viewId", "absoluteName", "order", "preference", "service", "regexp", "replacement", "flags", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "preference": { "type": "integer", "format": "int32" }, "service": { "type": "string" }, "regexp": { "type": "string" }, "replacement": { "type": "string" }, "flags": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addNAPTRRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addNAPTRRecordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addGenericRecord": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addGenericRecord", "operationId": "addGenericRecord", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addGenericRecord", "required": [ "viewId", "absoluteName", "type", "rdata", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "type": { "type": "string" }, "rdata": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addGenericRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addGenericRecordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addStartOfAuthority": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addStartOfAuthority", "operationId": "addStartOfAuthority", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addStartOfAuthority", "required": [ "parentId", "email", "refresh", "retry", "expire", "minimum", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "email": { "type": "string" }, "refresh": { "type": "integer", "format": "int64" }, "retry": { "type": "integer", "format": "int64" }, "expire": { "type": "integer", "format": "int64" }, "minimum": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addStartOfAuthorityResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addStartOfAuthorityResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addACL": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addACL", "operationId": "addACL", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addACL", "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": "addACLResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addACLResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addUserGroup": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addUserGroup", "operationId": "addUserGroup", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addUserGroup", "required": [ "name", "properties" ], "type": "object", "properties": { "name": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addUserGroupResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addUserGroupResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addTagGroup": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addTagGroup", "operationId": "addTagGroup", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addTagGroup", "required": [ "name", "properties" ], "type": "object", "properties": { "name": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addTagGroupResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addTagGroupResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addTFTPGroup": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addTFTPGroup", "operationId": "addTFTPGroup", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addTFTPGroup", "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": "addTFTPGroupResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addTFTPGroupResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addTFTPFolder": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addTFTPFolder", "operationId": "addTFTPFolder", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addTFTPFolder", "required": [ "parentId", "name", "properties" ], "type": "object", "properties": { "parentId": { "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": "addTFTPFolderResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addTFTPFolderResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addTFTPFile": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addTFTPFile", "operationId": "addTFTPFile", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addTFTPFile", "required": [ "parentId", "name", "version", "data", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "version": { "type": "string" }, "data": { "type": "string", "format": "binary" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addTFTPFileResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addTFTPFileResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addTFTPDeploymentRole": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addTFTPDeploymentRole", "operationId": "addTFTPDeploymentRole", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addTFTPDeploymentRole", "required": [ "entityId", "serverId", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverId": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addTFTPDeploymentRoleResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addTFTPDeploymentRoleResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/createXHAPair": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "createXHAPair", "operationId": "createXHAPair", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "createXHAPair", "required": [ "configurationId", "activeServerId", "passiveServerId", "activeServerNewIPv4Address", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "activeServerId": { "type": "integer", "format": "int64" }, "passiveServerId": { "type": "integer", "format": "int64" }, "activeServerNewIPv4Address": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "createXHAPairResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "createXHAPairResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/editXHAPair": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "editXHAPair", "operationId": "editXHAPair", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "editXHAPair", "required": [ "xHAServerId", "name", "properties" ], "type": "object", "properties": { "xHAServerId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "editXHAPairResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/failoverXHA": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "failoverXHA", "operationId": "failoverXHA", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "failoverXHA", "required": [ "xHAServerId" ], "type": "object", "properties": { "xHAServerId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "failoverXHAResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/breakXHAPair": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "breakXHAPair", "operationId": "breakXHAPair", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "breakXHAPair", "required": [ "xHAServerId", "breakInProteusOnly" ], "type": "object", "properties": { "xHAServerId": { "type": "integer", "format": "int64" }, "breakInProteusOnly": { "type": "boolean" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "breakXHAPairResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/importServer": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "importServer", "operationId": "importServer", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "importServer", "required": [ "serverId", "importDns", "importDhcp", "properties" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "importDns": { "type": "boolean" }, "importDhcp": { "type": "boolean" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "importServerResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deployServerServices": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deployServerServices", "operationId": "deployServerServices", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deployServerServices", "required": [ "serverId", "services" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "services": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deployServerServicesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deployServerConfig": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deployServerConfig", "operationId": "deployServerConfig", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deployServerConfig", "required": [ "serverId", "properties" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deployServerConfigResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addAdditionalIPAddresses": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addAdditionalIPAddresses", "operationId": "addAdditionalIPAddresses", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addAdditionalIPAddresses", "required": [ "serverId", "ipsToAdd", "properties" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "ipsToAdd": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "addAdditionalIPAddressesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/removeAdditionalIPAddresses": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "removeAdditionalIPAddresses", "operationId": "removeAdditionalIPAddresses", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "removeAdditionalIPAddresses", "required": [ "serverId", "ipsToRemove", "properties" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "ipsToRemove": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "removeAdditionalIPAddressesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getAdditionalIPAddresses": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getAdditionalIPAddresses", "operationId": "getAdditionalIPAddresses", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getAdditionalIPAddresses", "required": [ "adonisID", "properties" ], "type": "object", "properties": { "adonisID": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getAdditionalIPAddressesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getAdditionalIPAddressesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/assignIP4Address": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "assignIP4Address", "operationId": "assignIP4Address", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "assignIP4Address", "required": [ "configurationId", "ip4Address", "macAddress", "hostInfo", "action", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "ip4Address": { "type": "string" }, "macAddress": { "type": "string" }, "hostInfo": { "type": "string" }, "action": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "assignIP4AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "assignIP4AddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/assignNextAvailableIP4Address": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "assignNextAvailableIP4Address", "operationId": "assignNextAvailableIP4Address", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "assignNextAvailableIP4Address", "required": [ "configurationId", "parentId", "macAddress", "hostInfo", "action", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "parentId": { "type": "integer", "format": "int64" }, "macAddress": { "type": "string" }, "hostInfo": { "type": "string" }, "action": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "assignNextAvailableIP4AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "assignNextAvailableIP4AddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getNextIP4Address": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getNextIP4Address", "operationId": "getNextIP4Address", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getNextIP4Address", "required": [ "parentId", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getNextIP4AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getNextIP4AddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getMaxAllowedRange": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getMaxAllowedRange", "operationId": "getMaxAllowedRange", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getMaxAllowedRange", "required": [ "rangeId" ], "type": "object", "properties": { "rangeId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getMaxAllowedRangeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getMaxAllowedRangeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getNextAvailableIPRanges": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getNextAvailableIPRanges", "operationId": "getNextAvailableIPRanges", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getNextAvailableIPRanges", "required": [ "parentId", "size", "type", "count", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "size": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getNextAvailableIPRangesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getNextAvailableIPRangesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/tagEntity": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "tagEntity", "operationId": "tagEntity", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "tagEntity", "required": [ "entityId", "tagId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "tagId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "tagEntityResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/untagEntity": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "untagEntity", "operationId": "untagEntity", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "untagEntity", "required": [ "entityId", "tagId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "tagId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "untagEntityResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/quickDeploy": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "quickDeploy", "operationId": "quickDeploy", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "quickDeploy", "required": [ "entityId", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "quickDeployResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDependentRecords": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDependentRecords", "operationId": "getDependentRecords", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDependentRecords", "required": [ "entityId", "start", "count" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "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": "getDependentRecordsResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDependentRecordsResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getNetworkLinkedProperties": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getNetworkLinkedProperties", "operationId": "getNetworkLinkedProperties", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getNetworkLinkedProperties", "required": [ "networkId" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getNetworkLinkedPropertiesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getNetworkLinkedPropertiesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/linkEntities": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "linkEntities", "operationId": "linkEntities", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "linkEntities", "required": [ "entity1Id", "entity2Id", "properties" ], "type": "object", "properties": { "entity1Id": { "type": "integer", "format": "int64" }, "entity2Id": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "linkEntitiesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/unlinkEntities": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "unlinkEntities", "operationId": "unlinkEntities", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "unlinkEntities", "required": [ "entity1Id", "entity2Id", "properties" ], "type": "object", "properties": { "entity1Id": { "type": "integer", "format": "int64" }, "entity2Id": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "unlinkEntitiesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getServerForRole": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getServerForRole", "operationId": "getServerForRole", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getServerForRole", "required": [ "roleId" ], "type": "object", "properties": { "roleId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getServerForRoleResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getServerForRoleResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getMACAddressesInPool": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getMACAddressesInPool", "operationId": "getMACAddressesInPool", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getMACAddressesInPool", "required": [ "macPoolId", "start", "count" ], "type": "object", "properties": { "macPoolId": { "type": "integer", "format": "int64" }, "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": "getMACAddressesInPoolResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getMACAddressesInPoolResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getMACAddress": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getMACAddress", "operationId": "getMACAddress", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getMACAddress", "required": [ "configurationId", "macAddress" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "macAddress": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getMACAddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getMACAddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getEntityByName": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getEntityByName", "operationId": "getEntityByName", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getEntityByName", "required": [ "parentId", "name", "type" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "type": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getEntityByNameResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntityByNameResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getEntitiesByName": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getEntitiesByName", "operationId": "getEntitiesByName", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getEntitiesByName", "required": [ "parentId", "name", "type", "start", "count" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "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": "getEntitiesByNameResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntitiesByNameResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getEntitiesByNameUsingOptions": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getEntitiesByNameUsingOptions", "operationId": "getEntitiesByNameUsingOptions", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getEntitiesByNameUsingOptions", "required": [ "parentId", "name", "type", "start", "count", "options" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "type": { "type": "string" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getEntitiesByNameUsingOptionsResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntitiesByNameUsingOptionsResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getAliasesByHint": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getAliasesByHint", "operationId": "getAliasesByHint", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getAliasesByHint", "required": [ "start", "count", "options" ], "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getAliasesByHintResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getAliasesByHintResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getHostRecordsByHint": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getHostRecordsByHint", "operationId": "getHostRecordsByHint", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getHostRecordsByHint", "required": [ "start", "count", "options" ], "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getHostRecordsByHintResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getHostRecordsByHintResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getZonesByHint": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getZonesByHint", "operationId": "getZonesByHint", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getZonesByHint", "required": [ "containerId", "start", "count", "options" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getZonesByHintResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getZonesByHintResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getIP4NetworksByHint": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getIP4NetworksByHint", "operationId": "getIP4NetworksByHint", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getIP4NetworksByHint", "required": [ "containerId", "start", "count", "options" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getIP4NetworksByHintResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getIP4NetworksByHintResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getIP6ObjectsByHint": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getIP6ObjectsByHint", "operationId": "getIP6ObjectsByHint", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getIP6ObjectsByHint", "required": [ "containerId", "objectType", "start", "count", "options" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "objectType": { "type": "string" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getIP6ObjectsByHintResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getIP6ObjectsByHintResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getEntityByCIDR": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getEntityByCIDR", "operationId": "getEntityByCIDR", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getEntityByCIDR", "required": [ "parentId", "cidr", "type" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "cidr": { "type": "string" }, "type": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getEntityByCIDRResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntityByCIDRResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getEntityByRange": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getEntityByRange", "operationId": "getEntityByRange", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getEntityByRange", "required": [ "parentId", "address1", "address2", "type" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "type": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getEntityByRangeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntityByRangeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deleteWithOptions": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deleteWithOptions", "operationId": "deleteWithOptions", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deleteWithOptions", "required": [ "objectId", "options" ], "type": "object", "properties": { "objectId": { "type": "integer", "format": "int64" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deleteWithOptionsResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateWithOptions": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateWithOptions", "operationId": "updateWithOptions", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateWithOptions", "required": [ "entity", "options" ], "type": "object", "properties": { "entity": { "type": "string" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateWithOptionsResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getAccessRightsForEntity": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getAccessRightsForEntity", "operationId": "getAccessRightsForEntity", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getAccessRightsForEntity", "required": [ "entityId", "start", "count" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "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": "getAccessRightsForEntityResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getAccessRightsForEntityResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getAccessRightsForUser": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getAccessRightsForUser", "operationId": "getAccessRightsForUser", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getAccessRightsForUser", "required": [ "userId", "start", "count" ], "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "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": "getAccessRightsForUserResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getAccessRightsForUserResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deleteAccessRight": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deleteAccessRight", "operationId": "deleteAccessRight", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deleteAccessRight", "required": [ "entityId", "userId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deleteAccessRightResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateAccessRight": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateAccessRight", "operationId": "updateAccessRight", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateAccessRight", "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": { "type": "object", "xml": { "name": "updateAccessRightResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDeploymentRoles": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDeploymentRoles", "operationId": "getDeploymentRoles", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDeploymentRoles", "required": [ "entityId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDeploymentRolesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDeploymentRolesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getServerDeploymentRoles": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getServerDeploymentRoles", "operationId": "getServerDeploymentRoles", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getServerDeploymentRoles", "required": [ "serverId" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getServerDeploymentRolesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getServerDeploymentRolesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDNSDeploymentRole": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDNSDeploymentRole", "operationId": "getDNSDeploymentRole", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDNSDeploymentRole", "required": [ "entityId", "serverInterfaceId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDNSDeploymentRoleResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDNSDeploymentRoleResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDNSDeploymentRoleForView": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDNSDeploymentRoleForView", "operationId": "getDNSDeploymentRoleForView", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDNSDeploymentRoleForView", "required": [ "entityId", "serverInterfaceId", "viewId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" }, "viewId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDNSDeploymentRoleForViewResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDNSDeploymentRoleForViewResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDHCPDeploymentRole": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDHCPDeploymentRole", "operationId": "getDHCPDeploymentRole", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDHCPDeploymentRole", "required": [ "entityId", "serverInterfaceId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDHCPDeploymentRoleResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDHCPDeploymentRoleResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDNSDeploymentRole": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDNSDeploymentRole", "operationId": "addDNSDeploymentRole", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDNSDeploymentRole", "required": [ "entityId", "serverInterfaceId", "type", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDNSDeploymentRoleResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDNSDeploymentRoleResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDHCPDeploymentRole": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDHCPDeploymentRole", "operationId": "addDHCPDeploymentRole", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDHCPDeploymentRole", "required": [ "entityId", "serverInterfaceId", "type", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDHCPDeploymentRoleResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCPDeploymentRoleResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deleteDNSDeploymentRole": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deleteDNSDeploymentRole", "operationId": "deleteDNSDeploymentRole", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deleteDNSDeploymentRole", "required": [ "entityId", "serverInterfaceId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deleteDNSDeploymentRoleResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deleteDNSDeploymentRoleForView": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deleteDNSDeploymentRoleForView", "operationId": "deleteDNSDeploymentRoleForView", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deleteDNSDeploymentRoleForView", "required": [ "entityId", "serverInterfaceId", "viewId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" }, "viewId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deleteDNSDeploymentRoleForViewResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deleteDHCPDeploymentRole": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deleteDHCPDeploymentRole", "operationId": "deleteDHCPDeploymentRole", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deleteDHCPDeploymentRole", "required": [ "entityId", "serverInterfaceId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deleteDHCPDeploymentRoleResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateDNSDeploymentRole": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateDNSDeploymentRole", "operationId": "updateDNSDeploymentRole", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateDNSDeploymentRole", "required": [ "role" ], "type": "object", "properties": { "role": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateDNSDeploymentRoleResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateDHCPDeploymentRole": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateDHCPDeploymentRole", "operationId": "updateDHCPDeploymentRole", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateDHCPDeploymentRole", "required": [ "role" ], "type": "object", "properties": { "role": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateDHCPDeploymentRoleResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDeploymentOptions": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDeploymentOptions", "operationId": "getDeploymentOptions", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDeploymentOptions", "required": [ "entityId", "optionTypes", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "optionTypes": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDeploymentOptionsResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDeploymentOptionsResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDNSDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDNSDeploymentOption", "operationId": "getDNSDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDNSDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDNSDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDNSDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDHCPClientDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDHCPClientDeploymentOption", "operationId": "getDHCPClientDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDHCPClientDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDHCPClientDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDHCPClientDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDHCP6ClientDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDHCP6ClientDeploymentOption", "operationId": "getDHCP6ClientDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDHCP6ClientDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDHCP6ClientDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDHCP6ClientDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDHCPServiceDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDHCPServiceDeploymentOption", "operationId": "getDHCPServiceDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDHCPServiceDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDHCPServiceDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDHCPServiceDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDHCP6ServiceDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDHCP6ServiceDeploymentOption", "operationId": "getDHCP6ServiceDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDHCP6ServiceDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDHCP6ServiceDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDHCP6ServiceDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDNSDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDNSDeploymentOption", "operationId": "addDNSDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDNSDeploymentOption", "required": [ "entityId", "name", "value", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDNSDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDNSDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDHCPClientDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDHCPClientDeploymentOption", "operationId": "addDHCPClientDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDHCPClientDeploymentOption", "required": [ "entityId", "name", "value", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDHCPClientDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCPClientDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDHCP6ClientDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDHCP6ClientDeploymentOption", "operationId": "addDHCP6ClientDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDHCP6ClientDeploymentOption", "required": [ "entityId", "name", "value", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDHCP6ClientDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCP6ClientDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDHCPServiceDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDHCPServiceDeploymentOption", "operationId": "addDHCPServiceDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDHCPServiceDeploymentOption", "required": [ "entityId", "name", "value", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDHCPServiceDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCPServiceDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDHCP6ServiceDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDHCP6ServiceDeploymentOption", "operationId": "addDHCP6ServiceDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDHCP6ServiceDeploymentOption", "required": [ "entityId", "name", "value", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDHCP6ServiceDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCP6ServiceDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deleteDNSDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deleteDNSDeploymentOption", "operationId": "deleteDNSDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deleteDNSDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deleteDNSDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deleteDHCPClientDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deleteDHCPClientDeploymentOption", "operationId": "deleteDHCPClientDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deleteDHCPClientDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deleteDHCPClientDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deleteDHCP6ClientDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deleteDHCP6ClientDeploymentOption", "operationId": "deleteDHCP6ClientDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deleteDHCP6ClientDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deleteDHCP6ClientDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deleteDHCPServiceDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deleteDHCPServiceDeploymentOption", "operationId": "deleteDHCPServiceDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deleteDHCPServiceDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deleteDHCPServiceDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deleteDHCP6ServiceDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deleteDHCP6ServiceDeploymentOption", "operationId": "deleteDHCP6ServiceDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deleteDHCP6ServiceDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deleteDHCP6ServiceDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateDNSDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateDNSDeploymentOption", "operationId": "updateDNSDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateDNSDeploymentOption", "required": [ "option" ], "type": "object", "properties": { "option": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateDNSDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateDHCPClientDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateDHCPClientDeploymentOption", "operationId": "updateDHCPClientDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateDHCPClientDeploymentOption", "required": [ "option" ], "type": "object", "properties": { "option": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateDHCPClientDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateDHCP6ClientDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateDHCP6ClientDeploymentOption", "operationId": "updateDHCP6ClientDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateDHCP6ClientDeploymentOption", "required": [ "option" ], "type": "object", "properties": { "option": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateDHCP6ClientDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateDHCPServiceDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateDHCPServiceDeploymentOption", "operationId": "updateDHCPServiceDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateDHCPServiceDeploymentOption", "required": [ "option" ], "type": "object", "properties": { "option": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateDHCPServiceDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateDHCP6ServiceDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateDHCP6ServiceDeploymentOption", "operationId": "updateDHCP6ServiceDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateDHCP6ServiceDeploymentOption", "required": [ "option" ], "type": "object", "properties": { "option": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateDHCP6ServiceDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addMACAddress": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addMACAddress", "operationId": "addMACAddress", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addMACAddress", "required": [ "configurationId", "macAddress", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "macAddress": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addMACAddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addMACAddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/associateMACAddressWithPool": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "associateMACAddressWithPool", "operationId": "associateMACAddressWithPool", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "associateMACAddressWithPool", "required": [ "configurationId", "macAddress", "poolId" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "macAddress": { "type": "string" }, "poolId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "associateMACAddressWithPoolResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/denyMACAddress": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "denyMACAddress", "operationId": "denyMACAddress", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "denyMACAddress", "required": [ "configurationId", "macAddress" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "macAddress": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "denyMACAddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/isAddressAllocated": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "isAddressAllocated", "operationId": "isAddressAllocated", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "isAddressAllocated", "required": [ "configurationId", "ipAddress", "macAddress" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "ipAddress": { "type": "string" }, "macAddress": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "isAddressAllocatedResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "boolean", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "isAddressAllocatedResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/mergeSelectedBlocksOrNetworks": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "mergeSelectedBlocksOrNetworks", "operationId": "mergeSelectedBlocksOrNetworks", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "mergeSelectedBlocksOrNetworks", "required": [ "blockOrNetworkIds", "blockOrNetworkToKeep" ], "type": "object", "properties": { "blockOrNetworkIds": { "type": "string" }, "blockOrNetworkToKeep": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "mergeSelectedBlocksOrNetworksResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addParentBlock": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addParentBlock", "operationId": "addParentBlock", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addParentBlock", "required": [ "blockOrNetworkIds" ], "type": "object", "properties": { "blockOrNetworkIds": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addParentBlockResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addParentBlockResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addParentBlockWithProperties": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addParentBlockWithProperties", "operationId": "addParentBlockWithProperties", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addParentBlockWithProperties", "required": [ "blockOrNetworkIds", "properties" ], "type": "object", "properties": { "blockOrNetworkIds": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addParentBlockWithPropertiesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addParentBlockWithPropertiesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/mergeBlocksWithParent": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "mergeBlocksWithParent", "operationId": "mergeBlocksWithParent", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "mergeBlocksWithParent", "required": [ "blockIds" ], "type": "object", "properties": { "blockIds": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "mergeBlocksWithParentResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/resizeRange": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "resizeRange", "operationId": "resizeRange", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "resizeRange", "required": [ "objectId", "range", "options" ], "type": "object", "properties": { "objectId": { "type": "integer", "format": "int64" }, "range": { "type": "string" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "resizeRangeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/moveIP4Object": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "moveIP4Object", "operationId": "moveIP4Object", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "moveIP4Object", "required": [ "objectId", "address" ], "type": "object", "properties": { "objectId": { "type": "integer", "format": "int64" }, "address": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "moveIP4ObjectResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/moveIPObject": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "moveIPObject", "operationId": "moveIPObject", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "moveIPObject", "required": [ "objectId", "address", "options" ], "type": "object", "properties": { "objectId": { "type": "integer", "format": "int64" }, "address": { "type": "string" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "moveIPObjectResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/moveResourceRecord": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "moveResourceRecord", "operationId": "moveResourceRecord", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "moveResourceRecord", "required": [ "resourceRecordId", "destinationZone" ], "type": "object", "properties": { "resourceRecordId": { "type": "integer", "format": "int64" }, "destinationZone": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "moveResourceRecordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateBulkUdf": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateBulkUdf", "operationId": "updateBulkUdf", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateBulkUdf", "required": [ "data", "properties" ], "type": "object", "properties": { "data": { "type": "string", "format": "binary" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "updateBulkUdfResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "format": "binary", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "updateBulkUdfResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addVendorProfile": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addVendorProfile", "operationId": "addVendorProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addVendorProfile", "required": [ "identifier", "name", "description", "properties" ], "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addVendorProfileResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addVendorProfileResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addVendorOptionDefinition": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addVendorOptionDefinition", "operationId": "addVendorOptionDefinition", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addVendorOptionDefinition", "required": [ "vendorProfileId", "optionId", "name", "optionType", "description", "allowMultiple", "properties" ], "type": "object", "properties": { "vendorProfileId": { "type": "integer", "format": "int64" }, "optionId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "optionType": { "type": "string" }, "description": { "type": "string" }, "allowMultiple": { "type": "boolean" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addVendorOptionDefinitionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addVendorOptionDefinitionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDHCPVendorDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDHCPVendorDeploymentOption", "operationId": "addDHCPVendorDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDHCPVendorDeploymentOption", "required": [ "parentId", "optionId", "value", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "optionId": { "type": "integer", "format": "int64" }, "value": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDHCPVendorDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCPVendorDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDHCPVendorDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDHCPVendorDeploymentOption", "operationId": "getDHCPVendorDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDHCPVendorDeploymentOption", "required": [ "entityId", "optionId", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "optionId": { "type": "integer", "format": "int64" }, "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDHCPVendorDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDHCPVendorDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateDHCPVendorDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateDHCPVendorDeploymentOption", "operationId": "updateDHCPVendorDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateDHCPVendorDeploymentOption", "required": [ "option" ], "type": "object", "properties": { "option": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateDHCPVendorDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deleteDHCPVendorDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deleteDHCPVendorDeploymentOption", "operationId": "deleteDHCPVendorDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deleteDHCPVendorDeploymentOption", "required": [ "entityId", "optionId", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "optionId": { "type": "integer", "format": "int64" }, "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deleteDHCPVendorDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addIP6BlockByPrefix": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addIP6BlockByPrefix", "operationId": "addIP6BlockByPrefix", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addIP6BlockByPrefix", "required": [ "parentId", "prefix", "name", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "prefix": { "type": "string" }, "name": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addIP6BlockByPrefixResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP6BlockByPrefixResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addIP6BlockByMACAddress": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addIP6BlockByMACAddress", "operationId": "addIP6BlockByMACAddress", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addIP6BlockByMACAddress", "required": [ "parentId", "macAddress", "name", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "macAddress": { "type": "string" }, "name": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addIP6BlockByMACAddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP6BlockByMACAddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getEntityByPrefix": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getEntityByPrefix", "operationId": "getEntityByPrefix", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getEntityByPrefix", "required": [ "containerId", "prefix", "type" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "prefix": { "type": "string" }, "type": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getEntityByPrefixResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntityByPrefixResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addIP6NetworkByPrefix": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addIP6NetworkByPrefix", "operationId": "addIP6NetworkByPrefix", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addIP6NetworkByPrefix", "required": [ "parentId", "prefix", "name", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "prefix": { "type": "string" }, "name": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addIP6NetworkByPrefixResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP6NetworkByPrefixResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addIP6Address": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addIP6Address", "operationId": "addIP6Address", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addIP6Address", "required": [ "containerId", "address", "type", "name", "properties" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "address": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addIP6AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP6AddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/assignIP6Address": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "assignIP6Address", "operationId": "assignIP6Address", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "assignIP6Address", "required": [ "containerId", "address", "action", "macAddress", "hostInfo", "properties" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "address": { "type": "string" }, "action": { "type": "string" }, "macAddress": { "type": "string" }, "hostInfo": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "assignIP6AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "boolean", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "assignIP6AddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/reassignIP6Address": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "reassignIP6Address", "operationId": "reassignIP6Address", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "reassignIP6Address", "required": [ "oldAddressId", "destination", "properties" ], "type": "object", "properties": { "oldAddressId": { "type": "integer", "format": "int64" }, "destination": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "reassignIP6AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "reassignIP6AddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/clearIP6Address": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "clearIP6Address", "operationId": "clearIP6Address", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "clearIP6Address", "required": [ "addressId" ], "type": "object", "properties": { "addressId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "clearIP6AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "boolean", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "clearIP6AddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/searchByCategory": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "searchByCategory", "operationId": "searchByCategory", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "searchByCategory", "required": [ "keyword", "category", "start", "count" ], "type": "object", "properties": { "keyword": { "type": "string" }, "category": { "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": "searchByCategoryResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "searchByCategoryResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/searchByObjectTypes": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "searchByObjectTypes", "operationId": "searchByObjectTypes", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "searchByObjectTypes", "required": [ "keyword", "types", "start", "count" ], "type": "object", "properties": { "keyword": { "type": "string" }, "types": { "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": "searchByObjectTypesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "searchByObjectTypesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/customSearch": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "customSearch", "operationId": "customSearch", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "customSearch", "required": [ "filters", "type", "options", "start", "count" ], "type": "object", "properties": { "filters": { "type": "string" }, "type": { "type": "string" }, "options": { "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": "customSearchResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "customSearchResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/purgeHistoryNow": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "purgeHistoryNow", "operationId": "purgeHistoryNow", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "purgeHistoryNow", "required": [ "untilWhenTimestamp", "numberOfDaysToKeep", "numberOfMonthsToKeep", "waitOption" ], "type": "object", "properties": { "untilWhenTimestamp": { "type": "string" }, "numberOfDaysToKeep": { "type": "integer", "format": "int32" }, "numberOfMonthsToKeep": { "type": "integer", "format": "int32" }, "waitOption": { "type": "boolean" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "purgeHistoryNowResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int32", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "purgeHistoryNowResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addZoneTemplate": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addZoneTemplate", "operationId": "addZoneTemplate", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addZoneTemplate", "required": [ "parentId", "name", "properties" ], "type": "object", "properties": { "parentId": { "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": "addZoneTemplateResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addZoneTemplateResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/assignOrUpdateTemplate": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "assignOrUpdateTemplate", "operationId": "assignOrUpdateTemplate", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "assignOrUpdateTemplate", "required": [ "entityId", "templateId", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "templateId": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "assignOrUpdateTemplateResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/reapplyTemplate": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "reapplyTemplate", "operationId": "reapplyTemplate", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "reapplyTemplate", "required": [ "templateId", "properties" ], "type": "object", "properties": { "templateId": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "reapplyTemplateResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addCustomOptionDefinition": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addCustomOptionDefinition", "operationId": "addCustomOptionDefinition", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addCustomOptionDefinition", "required": [ "configurationId", "name", "optionId", "optionType", "allowMultiple", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "optionId": { "type": "integer", "format": "int64" }, "optionType": { "type": "string" }, "allowMultiple": { "type": "boolean" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addCustomOptionDefinitionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addCustomOptionDefinitionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDeviceType": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDeviceType", "operationId": "addDeviceType", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDeviceType", "required": [ "name", "properties" ], "type": "object", "properties": { "name": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDeviceTypeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDeviceTypeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDeviceSubtype": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDeviceSubtype", "operationId": "addDeviceSubtype", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDeviceSubtype", "required": [ "parentId", "name", "properties" ], "type": "object", "properties": { "parentId": { "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": "addDeviceSubtypeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDeviceSubtypeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDevice": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDevice", "operationId": "addDevice", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDevice", "required": [ "configurationId", "name", "deviceTypeId", "deviceSubtypeId", "ip4Addresses", "ip6Addresses", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "deviceTypeId": { "type": "integer", "format": "int64" }, "deviceSubtypeId": { "type": "integer", "format": "int64" }, "ip4Addresses": { "type": "string" }, "ip6Addresses": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDeviceResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDeviceResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getIPRangedByIP": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getIPRangedByIP", "operationId": "getIPRangedByIP", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getIPRangedByIP", "required": [ "containerId", "type", "address" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "address": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getIPRangedByIPResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getIPRangedByIPResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addBulkHostRecord": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addBulkHostRecord", "operationId": "addBulkHostRecord", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addBulkHostRecord", "required": [ "viewId", "absoluteName", "ttl", "networkId", "startAddress", "numberOfAddresses", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "networkId": { "type": "integer", "format": "int64" }, "startAddress": { "type": "string" }, "numberOfAddresses": { "type": "integer", "format": "int32" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addBulkHostRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addBulkHostRecordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/migrateFile": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "migrateFile", "operationId": "migrateFile", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "migrateFile", "required": [ "filename" ], "type": "object", "properties": { "filename": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "migrateFileResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/isMigrationRunning": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "isMigrationRunning", "operationId": "isMigrationRunning", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "isMigrationRunning", "required": [ "filename" ], "type": "object", "properties": { "filename": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "isMigrationRunningResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "boolean", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "isMigrationRunningResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addIP4ReconciliationPolicy": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addIP4ReconciliationPolicy", "operationId": "addIP4ReconciliationPolicy", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addIP4ReconciliationPolicy", "required": [ "parentId", "name", "properties" ], "type": "object", "properties": { "parentId": { "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": "addIP4ReconciliationPolicyResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP4ReconciliationPolicyResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/changeStateIP4Address": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "changeStateIP4Address", "operationId": "changeStateIP4Address", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "changeStateIP4Address", "required": [ "addressId", "targetState", "macAddress" ], "type": "object", "properties": { "addressId": { "type": "integer", "format": "int64" }, "targetState": { "type": "string" }, "macAddress": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "changeStateIP4AddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getUserDefinedFields": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getUserDefinedFields", "operationId": "getUserDefinedFields", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getUserDefinedFields", "required": [ "type", "requiredFieldsOnly" ], "type": "object", "properties": { "type": { "type": "string" }, "requiredFieldsOnly": { "type": "boolean" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getUserDefinedFieldsResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getUserDefinedFieldsResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addIP4IPGroupByRange": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addIP4IPGroupByRange", "operationId": "addIP4IPGroupByRange", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addIP4IPGroupByRange", "required": [ "parentId", "name", "start", "end", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addIP4IPGroupByRangeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP4IPGroupByRangeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addIP4IPGroupBySize": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addIP4IPGroupBySize", "operationId": "addIP4IPGroupBySize", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addIP4IPGroupBySize", "required": [ "parentId", "name", "size", "positionRangeBy", "positionValue", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "size": { "type": "integer", "format": "int32" }, "positionRangeBy": { "type": "string" }, "positionValue": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addIP4IPGroupBySizeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP4IPGroupBySizeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/splitIP4Network": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "splitIP4Network", "operationId": "splitIP4Network", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "splitIP4Network", "required": [ "networkId", "numberOfParts", "options" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" }, "numberOfParts": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "splitIP4NetworkResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "splitIP4NetworkResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/splitIP6Range": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "splitIP6Range", "operationId": "splitIP6Range", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "splitIP6Range", "required": [ "rangeId", "numberOfParts", "options" ], "type": "object", "properties": { "rangeId": { "type": "integer", "format": "int64" }, "numberOfParts": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "splitIP6RangeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "splitIP6RangeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addDeviceInstance": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addDeviceInstance", "operationId": "addDeviceInstance", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addDeviceInstance", "required": [ "configName", "deviceName", "ipAddressMode", "ipEntity", "viewName", "zoneName", "recordName", "macAddressMode", "macEntity", "options" ], "type": "object", "properties": { "configName": { "type": "string" }, "deviceName": { "type": "string" }, "ipAddressMode": { "type": "string" }, "ipEntity": { "type": "string" }, "viewName": { "type": "string" }, "zoneName": { "type": "string" }, "recordName": { "type": "string" }, "macAddressMode": { "type": "string" }, "macEntity": { "type": "string" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addDeviceInstanceResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDeviceInstanceResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deleteDeviceInstance": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deleteDeviceInstance", "operationId": "deleteDeviceInstance", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deleteDeviceInstance", "required": [ "configName", "identifier", "options" ], "type": "object", "properties": { "configName": { "type": "string" }, "identifier": { "type": "string" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deleteDeviceInstanceResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getKSK": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getKSK", "operationId": "getKSK", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getKSK", "required": [ "entityId", "format" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "format": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getKSKResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getKSKResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addResponsePolicy": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addResponsePolicy", "operationId": "addResponsePolicy", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addResponsePolicy", "required": [ "configurationId", "name", "responsePolicyType", "ttl", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "responsePolicyType": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addResponsePolicyResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addResponsePolicyResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/uploadResponsePolicyItems": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "uploadResponsePolicyItems", "operationId": "uploadResponsePolicyItems", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "uploadResponsePolicyItems", "required": [ "parentId", "data" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "data": { "type": "string", "format": "binary" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "uploadResponsePolicyItemsResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/configureReplication": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "configureReplication", "operationId": "configureReplication", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "configureReplication", "required": [ "standbyServer", "compressReplication", "replicationQueueThreshold", "replicationBreakThreshold", "properties" ], "type": "object", "properties": { "standbyServer": { "type": "string" }, "compressReplication": { "type": "boolean" }, "replicationQueueThreshold": { "type": "integer", "format": "int64" }, "replicationBreakThreshold": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "configureReplicationResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/configureStreamingReplication": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "configureStreamingReplication", "operationId": "configureStreamingReplication", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "configureStreamingReplication", "required": [ "standbyServer", "compressReplication", "latencyWarningThreshold", "latencyCriticalThreshold", "properties" ], "type": "object", "properties": { "standbyServer": { "type": "string" }, "compressReplication": { "type": "boolean" }, "latencyWarningThreshold": { "type": "integer", "format": "int64" }, "latencyCriticalThreshold": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "configureStreamingReplicationResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/establishTrustRelationship": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "establishTrustRelationship", "operationId": "establishTrustRelationship", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "establishTrustRelationship", "required": [ "remoteIP", "username", "password", "properties" ], "type": "object", "properties": { "remoteIP": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "establishTrustRelationshipResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/removeTrustRelationship": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "removeTrustRelationship", "operationId": "removeTrustRelationship", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "removeTrustRelationship", "required": [ "otherBAMIP", "properties" ], "type": "object", "properties": { "otherBAMIP": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "removeTrustRelationshipResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getReplicationInfo": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getReplicationInfo", "operationId": "getReplicationInfo", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getReplicationInfo", "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getReplicationInfoResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getReplicationInfoResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/failoverReplication": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "failoverReplication", "operationId": "failoverReplication", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "failoverReplication", "required": [ "standbyServer", "properties" ], "type": "object", "properties": { "standbyServer": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "failoverReplicationResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/breakReplication": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "breakReplication", "operationId": "breakReplication", "parameters": [], "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "breakReplicationResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDiscoveredDevices": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDiscoveredDevices", "operationId": "getDiscoveredDevices", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDiscoveredDevices", "required": [ "policyId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDiscoveredDevicesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDevicesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDiscoveredDevice": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDiscoveredDevice", "operationId": "getDiscoveredDevice", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDiscoveredDevice", "required": [ "policyId", "deviceId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "deviceId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDiscoveredDeviceResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDeviceResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDiscoveredDeviceInterfaces": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDiscoveredDeviceInterfaces", "operationId": "getDiscoveredDeviceInterfaces", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDiscoveredDeviceInterfaces", "required": [ "policyId", "deviceId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "deviceId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDiscoveredDeviceInterfacesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDeviceInterfacesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDiscoveredDeviceNetworks": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDiscoveredDeviceNetworks", "operationId": "getDiscoveredDeviceNetworks", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDiscoveredDeviceNetworks", "required": [ "policyId", "deviceId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "deviceId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDiscoveredDeviceNetworksResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDeviceNetworksResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDiscoveredDeviceHosts": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDiscoveredDeviceHosts", "operationId": "getDiscoveredDeviceHosts", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDiscoveredDeviceHosts", "required": [ "policyId", "deviceId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "deviceId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDiscoveredDeviceHostsResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDeviceHostsResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDiscoveredDeviceVlans": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDiscoveredDeviceVlans", "operationId": "getDiscoveredDeviceVlans", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDiscoveredDeviceVlans", "required": [ "policyId", "deviceId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "deviceId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDiscoveredDeviceVlansResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDeviceVlansResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDiscoveredDeviceArpEntries": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDiscoveredDeviceArpEntries", "operationId": "getDiscoveredDeviceArpEntries", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDiscoveredDeviceArpEntries", "required": [ "policyId", "deviceId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "deviceId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDiscoveredDeviceArpEntriesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDeviceArpEntriesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDiscoveredDeviceMacAddressEntries": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDiscoveredDeviceMacAddressEntries", "operationId": "getDiscoveredDeviceMacAddressEntries", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDiscoveredDeviceMacAddressEntries", "required": [ "policyId", "deviceId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "deviceId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDiscoveredDeviceMacAddressEntriesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDeviceMacAddressEntriesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/startProbe": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "startProbe", "operationId": "startProbe", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "startProbe", "required": [ "definedProbe", "properties" ], "type": "object", "properties": { "definedProbe": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "startProbeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getProbeData": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getProbeData", "operationId": "getProbeData", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getProbeData", "required": [ "definedProbe", "properties" ], "type": "object", "properties": { "definedProbe": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getProbeDataResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getProbeDataResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/shareNetwork": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "shareNetwork", "operationId": "shareNetwork", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "shareNetwork", "required": [ "networkId", "tagId" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" }, "tagId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "shareNetworkResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/unshareNetwork": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "unshareNetwork", "operationId": "unshareNetwork", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "unshareNetwork", "required": [ "networkId" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "unshareNetworkResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getSharedNetworks": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getSharedNetworks", "operationId": "getSharedNetworks", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getSharedNetworks", "required": [ "tagId" ], "type": "object", "properties": { "tagId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getSharedNetworksResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getSharedNetworksResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getLocationByCode": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getLocationByCode", "operationId": "getLocationByCode", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getLocationByCode", "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getLocationByCodeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getLocationByCodeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getAllUsedLocations": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getAllUsedLocations", "operationId": "getAllUsedLocations", "parameters": [], "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getAllUsedLocationsResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getAllUsedLocationsResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/searchResponsePolicyItems": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "searchResponsePolicyItems", "operationId": "searchResponsePolicyItems", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "searchResponsePolicyItems", "required": [ "keyword", "scope", "start", "count", "properties" ], "type": "object", "properties": { "keyword": { "type": "string" }, "scope": { "type": "string" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "searchResponsePolicyItemsResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "searchResponsePolicyItemsResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getConfigurationSetting": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getConfigurationSetting", "operationId": "getConfigurationSetting", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getConfigurationSetting", "required": [ "configurationId", "settingName" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "settingName": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getConfigurationSettingResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getConfigurationSettingResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateConfigurationSetting": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateConfigurationSetting", "operationId": "updateConfigurationSetting", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateConfigurationSetting", "required": [ "configurationId", "settingName", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "settingName": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateConfigurationSettingResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addRawDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addRawDeploymentOption", "operationId": "addRawDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addRawDeploymentOption", "required": [ "parentId", "optionType", "rawData", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "optionType": { "type": "string" }, "rawData": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addRawDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addRawDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateRawDeploymentOption": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateRawDeploymentOption", "operationId": "updateRawDeploymentOption", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateRawDeploymentOption", "required": [ "option" ], "type": "object", "properties": { "option": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateRawDeploymentOptionResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateUserPassword": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateUserPassword", "operationId": "updateUserPassword", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateUserPassword", "required": [ "userId", "newPassword", "options" ], "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "newPassword": { "type": "string" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateUserPasswordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateBAMSystemUserPassword": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateBAMSystemUserPassword", "operationId": "updateBAMSystemUserPassword", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateBAMSystemUserPassword", "required": [ "systemUserName", "newPassword", "options" ], "type": "object", "properties": { "systemUserName": { "type": "string" }, "newPassword": { "type": "string" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateBAMSystemUserPasswordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/updateBDDSSystemUserPassword": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "updateBDDSSystemUserPassword", "operationId": "updateBDDSSystemUserPassword", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "updateBDDSSystemUserPassword", "required": [ "serverId", "systemUserName", "newPassword", "options" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "systemUserName": { "type": "string" }, "newPassword": { "type": "string" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateBDDSSystemUserPasswordResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addResponsePolicyItem": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addResponsePolicyItem", "operationId": "addResponsePolicyItem", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addResponsePolicyItem", "required": [ "policyId", "itemName", "options" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "itemName": { "type": "string" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "addResponsePolicyItemResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "boolean", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addResponsePolicyItemResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deleteResponsePolicyItem": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deleteResponsePolicyItem", "operationId": "deleteResponsePolicyItem", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deleteResponsePolicyItem", "required": [ "policyId", "itemName", "options" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "itemName": { "type": "string" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "deleteResponsePolicyItemResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int32", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "deleteResponsePolicyItemResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/findResponsePoliciesWithItem": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "findResponsePoliciesWithItem", "operationId": "findResponsePoliciesWithItem", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "findResponsePoliciesWithItem", "required": [ "configurationId", "itemName", "options" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "itemName": { "type": "string" }, "options": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "findResponsePoliciesWithItemResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "findResponsePoliciesWithItemResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/selectiveDeploy": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "selectiveDeploy", "operationId": "selectiveDeploy", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "selectiveDeploy", "required": [ "entityIds", "properties" ], "type": "object", "properties": { "entityIds": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "selectiveDeployResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "selectiveDeployResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/terminateUserSessions": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "terminateUserSessions", "operationId": "terminateUserSessions", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "terminateUserSessions", "required": [ "username", "properties" ], "type": "object", "properties": { "username": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "terminateUserSessionsResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getDeploymentTaskStatus": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getDeploymentTaskStatus", "operationId": "getDeploymentTaskStatus", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getDeploymentTaskStatus", "required": [ "deploymentTaskToken" ], "type": "object", "properties": { "deploymentTaskToken": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getDeploymentTaskStatusResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDeploymentTaskStatusResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getServerDeploymentStatus": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getServerDeploymentStatus", "operationId": "getServerDeploymentStatus", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getServerDeploymentStatus", "required": [ "serverId", "properties" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getServerDeploymentStatusResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int32", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getServerDeploymentStatusResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/deployServer": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "deployServer", "operationId": "deployServer", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "deployServer", "required": [ "serverId" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deployServerResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getSystemInfo": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getSystemInfo", "operationId": "getSystemInfo", "parameters": [], "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getSystemInfoResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getSystemInfoResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getLinkedEntities": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getLinkedEntities", "operationId": "getLinkedEntities", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getLinkedEntities", "required": [ "entityId", "type", "start", "count" ], "type": "object", "properties": { "entityId": { "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": "getLinkedEntitiesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getLinkedEntitiesResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getIP6Address": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getIP6Address", "operationId": "getIP6Address", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getIP6Address", "required": [ "containerId", "address" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "address": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getIP6AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getIP6AddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getAccessRight": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getAccessRight", "operationId": "getAccessRight", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getAccessRight", "required": [ "entityId", "userId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getAccessRightResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getAccessRightResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getIP4Address": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getIP4Address", "operationId": "getIP4Address", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getIP4Address", "required": [ "containerId", "address" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "address": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getIP4AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getIP4AddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addIP4Network": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addIP4Network", "operationId": "addIP4Network", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addIP4Network", "required": [ "blockId", "CIDR", "properties" ], "type": "object", "properties": { "blockId": { "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": "addIP4NetworkResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP4NetworkResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addIP4NetworkTemplate": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addIP4NetworkTemplate", "operationId": "addIP4NetworkTemplate", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addIP4NetworkTemplate", "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": "addIP4NetworkTemplateResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP4NetworkTemplateResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getNextAvailableIP4Network": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getNextAvailableIP4Network", "operationId": "getNextAvailableIP4Network", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getNextAvailableIP4Network", "required": [ "parentId", "size", "isLargerAllowed", "autoCreate" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "size": { "type": "integer", "format": "int64" }, "isLargerAllowed": { "type": "boolean" }, "autoCreate": { "type": "boolean" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getNextAvailableIP4NetworkResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getNextAvailableIP4NetworkResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getNextAvailableIP4Address": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getNextAvailableIP4Address", "operationId": "getNextAvailableIP4Address", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getNextAvailableIP4Address", "required": [ "parentId" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getNextAvailableIP4AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getNextAvailableIP4AddressResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getNextAvailableIPRange": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getNextAvailableIPRange", "operationId": "getNextAvailableIPRange", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getNextAvailableIPRange", "required": [ "parentId", "size", "type", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "size": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "properties": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getNextAvailableIPRangeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getNextAvailableIPRangeResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/addTag": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "addTag", "operationId": "addTag", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "addTag", "required": [ "parentId", "name", "properties" ], "type": "object", "properties": { "parentId": { "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": "addTagResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addTagResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/update": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "update", "operationId": "update", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "update", "required": [ "entity" ], "type": "object", "properties": { "entity": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "updateResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/getParent": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "getParent", "operationId": "getParent", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "getParent", "required": [ "entityId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "title": "getParentResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getParentResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } }, "/delete": { "post": { "tags": [ "ProteusAPIPortBinding" ], "summary": "delete", "operationId": "delete", "parameters": [], "requestBody": { "description": "", "content": { "application/xml": { "schema": { "title": "delete", "required": [ "objectId" ], "type": "object", "properties": { "objectId": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved the response", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "xml": { "name": "deleteResponse", "attribute": false, "wrapped": false } } } } } }, "deprecated": false } } }, "components": { "schemas": { "getEntityByIdResponse": { "title": "getEntityByIdResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntityByIdResponse", "attribute": false, "wrapped": false } }, "addServerResponse": { "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 } }, "getEntitiesResponse": { "title": "getEntitiesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntitiesResponse", "attribute": false, "wrapped": false } }, "addUserResponse": { "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 } }, "addAccessRightResponse": { "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 } }, "addEntityResponse": { "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 } }, "getProbeStatusResponse": { "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 } }, "addIP4BlockByCIDRResponse": { "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 } }, "addIP4BlockByRangeResponse": { "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 } }, "addDHCP4RangeResponse": { "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 } }, "addDHCP4RangeBySizeResponse": { "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 } }, "addDHCP6RangeResponse": { "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 } }, "addDHCP6RangeBySizeResponse": { "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 } }, "addDHCPMatchClassResponse": { "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 } }, "addDHCPSubClassResponse": { "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 } }, "addViewResponse": { "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 } }, "addZoneResponse": { "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 } }, "addExternalHostRecordResponse": { "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 } }, "addEnumZoneResponse": { "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 } }, "addEnumNumberResponse": { "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 } }, "addResourceRecordResponse": { "title": "addResourceRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addResourceRecordResponse", "attribute": false, "wrapped": false } }, "addHostRecordResponse": { "title": "addHostRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addHostRecordResponse", "attribute": false, "wrapped": false } }, "addAliasRecordResponse": { "title": "addAliasRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addAliasRecordResponse", "attribute": false, "wrapped": false } }, "addMXRecordResponse": { "title": "addMXRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addMXRecordResponse", "attribute": false, "wrapped": false } }, "addSRVRecordResponse": { "title": "addSRVRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addSRVRecordResponse", "attribute": false, "wrapped": false } }, "addTXTRecordResponse": { "title": "addTXTRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addTXTRecordResponse", "attribute": false, "wrapped": false } }, "addHINFORecordResponse": { "title": "addHINFORecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addHINFORecordResponse", "attribute": false, "wrapped": false } }, "addNAPTRRecordResponse": { "title": "addNAPTRRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addNAPTRRecordResponse", "attribute": false, "wrapped": false } }, "addGenericRecordResponse": { "title": "addGenericRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addGenericRecordResponse", "attribute": false, "wrapped": false } }, "addStartOfAuthorityResponse": { "title": "addStartOfAuthorityResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addStartOfAuthorityResponse", "attribute": false, "wrapped": false } }, "addACLResponse": { "title": "addACLResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addACLResponse", "attribute": false, "wrapped": false } }, "addUserGroupResponse": { "title": "addUserGroupResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addUserGroupResponse", "attribute": false, "wrapped": false } }, "addTagGroupResponse": { "title": "addTagGroupResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addTagGroupResponse", "attribute": false, "wrapped": false } }, "addTFTPGroupResponse": { "title": "addTFTPGroupResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addTFTPGroupResponse", "attribute": false, "wrapped": false } }, "addTFTPFolderResponse": { "title": "addTFTPFolderResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addTFTPFolderResponse", "attribute": false, "wrapped": false } }, "addTFTPFileResponse": { "title": "addTFTPFileResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addTFTPFileResponse", "attribute": false, "wrapped": false } }, "addTFTPDeploymentRoleResponse": { "title": "addTFTPDeploymentRoleResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addTFTPDeploymentRoleResponse", "attribute": false, "wrapped": false } }, "createXHAPairResponse": { "title": "createXHAPairResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "createXHAPairResponse", "attribute": false, "wrapped": false } }, "getAdditionalIPAddressesResponse": { "title": "getAdditionalIPAddressesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getAdditionalIPAddressesResponse", "attribute": false, "wrapped": false } }, "assignIP4AddressResponse": { "title": "assignIP4AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "assignIP4AddressResponse", "attribute": false, "wrapped": false } }, "assignNextAvailableIP4AddressResponse": { "title": "assignNextAvailableIP4AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "assignNextAvailableIP4AddressResponse", "attribute": false, "wrapped": false } }, "getNextIP4AddressResponse": { "title": "getNextIP4AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getNextIP4AddressResponse", "attribute": false, "wrapped": false } }, "getMaxAllowedRangeResponse": { "title": "getMaxAllowedRangeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getMaxAllowedRangeResponse", "attribute": false, "wrapped": false } }, "getNextAvailableIPRangesResponse": { "title": "getNextAvailableIPRangesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getNextAvailableIPRangesResponse", "attribute": false, "wrapped": false } }, "getDependentRecordsResponse": { "title": "getDependentRecordsResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDependentRecordsResponse", "attribute": false, "wrapped": false } }, "getNetworkLinkedPropertiesResponse": { "title": "getNetworkLinkedPropertiesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getNetworkLinkedPropertiesResponse", "attribute": false, "wrapped": false } }, "getServerForRoleResponse": { "title": "getServerForRoleResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getServerForRoleResponse", "attribute": false, "wrapped": false } }, "getMACAddressesInPoolResponse": { "title": "getMACAddressesInPoolResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getMACAddressesInPoolResponse", "attribute": false, "wrapped": false } }, "getMACAddressResponse": { "title": "getMACAddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getMACAddressResponse", "attribute": false, "wrapped": false } }, "getEntityByNameResponse": { "title": "getEntityByNameResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntityByNameResponse", "attribute": false, "wrapped": false } }, "getEntitiesByNameResponse": { "title": "getEntitiesByNameResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntitiesByNameResponse", "attribute": false, "wrapped": false } }, "getEntitiesByNameUsingOptionsResponse": { "title": "getEntitiesByNameUsingOptionsResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntitiesByNameUsingOptionsResponse", "attribute": false, "wrapped": false } }, "getAliasesByHintResponse": { "title": "getAliasesByHintResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getAliasesByHintResponse", "attribute": false, "wrapped": false } }, "getHostRecordsByHintResponse": { "title": "getHostRecordsByHintResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getHostRecordsByHintResponse", "attribute": false, "wrapped": false } }, "getZonesByHintResponse": { "title": "getZonesByHintResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getZonesByHintResponse", "attribute": false, "wrapped": false } }, "getIP4NetworksByHintResponse": { "title": "getIP4NetworksByHintResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getIP4NetworksByHintResponse", "attribute": false, "wrapped": false } }, "getIP6ObjectsByHintResponse": { "title": "getIP6ObjectsByHintResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getIP6ObjectsByHintResponse", "attribute": false, "wrapped": false } }, "getEntityByCIDRResponse": { "title": "getEntityByCIDRResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntityByCIDRResponse", "attribute": false, "wrapped": false } }, "getEntityByRangeResponse": { "title": "getEntityByRangeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntityByRangeResponse", "attribute": false, "wrapped": false } }, "getAccessRightsForEntityResponse": { "title": "getAccessRightsForEntityResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getAccessRightsForEntityResponse", "attribute": false, "wrapped": false } }, "getAccessRightsForUserResponse": { "title": "getAccessRightsForUserResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getAccessRightsForUserResponse", "attribute": false, "wrapped": false } }, "getDeploymentRolesResponse": { "title": "getDeploymentRolesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDeploymentRolesResponse", "attribute": false, "wrapped": false } }, "getServerDeploymentRolesResponse": { "title": "getServerDeploymentRolesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getServerDeploymentRolesResponse", "attribute": false, "wrapped": false } }, "getDNSDeploymentRoleResponse": { "title": "getDNSDeploymentRoleResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDNSDeploymentRoleResponse", "attribute": false, "wrapped": false } }, "getDNSDeploymentRoleForViewResponse": { "title": "getDNSDeploymentRoleForViewResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDNSDeploymentRoleForViewResponse", "attribute": false, "wrapped": false } }, "getDHCPDeploymentRoleResponse": { "title": "getDHCPDeploymentRoleResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDHCPDeploymentRoleResponse", "attribute": false, "wrapped": false } }, "addDNSDeploymentRoleResponse": { "title": "addDNSDeploymentRoleResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDNSDeploymentRoleResponse", "attribute": false, "wrapped": false } }, "addDHCPDeploymentRoleResponse": { "title": "addDHCPDeploymentRoleResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCPDeploymentRoleResponse", "attribute": false, "wrapped": false } }, "getDeploymentOptionsResponse": { "title": "getDeploymentOptionsResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDeploymentOptionsResponse", "attribute": false, "wrapped": false } }, "getDNSDeploymentOptionResponse": { "title": "getDNSDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDNSDeploymentOptionResponse", "attribute": false, "wrapped": false } }, "getDHCPClientDeploymentOptionResponse": { "title": "getDHCPClientDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDHCPClientDeploymentOptionResponse", "attribute": false, "wrapped": false } }, "getDHCP6ClientDeploymentOptionResponse": { "title": "getDHCP6ClientDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDHCP6ClientDeploymentOptionResponse", "attribute": false, "wrapped": false } }, "getDHCPServiceDeploymentOptionResponse": { "title": "getDHCPServiceDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDHCPServiceDeploymentOptionResponse", "attribute": false, "wrapped": false } }, "getDHCP6ServiceDeploymentOptionResponse": { "title": "getDHCP6ServiceDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDHCP6ServiceDeploymentOptionResponse", "attribute": false, "wrapped": false } }, "addDNSDeploymentOptionResponse": { "title": "addDNSDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDNSDeploymentOptionResponse", "attribute": false, "wrapped": false } }, "addDHCPClientDeploymentOptionResponse": { "title": "addDHCPClientDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCPClientDeploymentOptionResponse", "attribute": false, "wrapped": false } }, "addDHCP6ClientDeploymentOptionResponse": { "title": "addDHCP6ClientDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCP6ClientDeploymentOptionResponse", "attribute": false, "wrapped": false } }, "addDHCPServiceDeploymentOptionResponse": { "title": "addDHCPServiceDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCPServiceDeploymentOptionResponse", "attribute": false, "wrapped": false } }, "addDHCP6ServiceDeploymentOptionResponse": { "title": "addDHCP6ServiceDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCP6ServiceDeploymentOptionResponse", "attribute": false, "wrapped": false } }, "addMACAddressResponse": { "title": "addMACAddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addMACAddressResponse", "attribute": false, "wrapped": false } }, "isAddressAllocatedResponse": { "title": "isAddressAllocatedResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "boolean", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "isAddressAllocatedResponse", "attribute": false, "wrapped": false } }, "addParentBlockResponse": { "title": "addParentBlockResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addParentBlockResponse", "attribute": false, "wrapped": false } }, "addParentBlockWithPropertiesResponse": { "title": "addParentBlockWithPropertiesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addParentBlockWithPropertiesResponse", "attribute": false, "wrapped": false } }, "updateBulkUdfResponse": { "title": "updateBulkUdfResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "format": "binary", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "updateBulkUdfResponse", "attribute": false, "wrapped": false } }, "addVendorProfileResponse": { "title": "addVendorProfileResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addVendorProfileResponse", "attribute": false, "wrapped": false } }, "addVendorOptionDefinitionResponse": { "title": "addVendorOptionDefinitionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addVendorOptionDefinitionResponse", "attribute": false, "wrapped": false } }, "addDHCPVendorDeploymentOptionResponse": { "title": "addDHCPVendorDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDHCPVendorDeploymentOptionResponse", "attribute": false, "wrapped": false } }, "getDHCPVendorDeploymentOptionResponse": { "title": "getDHCPVendorDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDHCPVendorDeploymentOptionResponse", "attribute": false, "wrapped": false } }, "addIP6BlockByPrefixResponse": { "title": "addIP6BlockByPrefixResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP6BlockByPrefixResponse", "attribute": false, "wrapped": false } }, "addIP6BlockByMACAddressResponse": { "title": "addIP6BlockByMACAddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP6BlockByMACAddressResponse", "attribute": false, "wrapped": false } }, "getEntityByPrefixResponse": { "title": "getEntityByPrefixResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getEntityByPrefixResponse", "attribute": false, "wrapped": false } }, "addIP6NetworkByPrefixResponse": { "title": "addIP6NetworkByPrefixResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP6NetworkByPrefixResponse", "attribute": false, "wrapped": false } }, "addIP6AddressResponse": { "title": "addIP6AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP6AddressResponse", "attribute": false, "wrapped": false } }, "assignIP6AddressResponse": { "title": "assignIP6AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "boolean", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "assignIP6AddressResponse", "attribute": false, "wrapped": false } }, "reassignIP6AddressResponse": { "title": "reassignIP6AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "reassignIP6AddressResponse", "attribute": false, "wrapped": false } }, "clearIP6AddressResponse": { "title": "clearIP6AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "boolean", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "clearIP6AddressResponse", "attribute": false, "wrapped": false } }, "searchByCategoryResponse": { "title": "searchByCategoryResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "searchByCategoryResponse", "attribute": false, "wrapped": false } }, "searchByObjectTypesResponse": { "title": "searchByObjectTypesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "searchByObjectTypesResponse", "attribute": false, "wrapped": false } }, "customSearchResponse": { "title": "customSearchResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "customSearchResponse", "attribute": false, "wrapped": false } }, "purgeHistoryNowResponse": { "title": "purgeHistoryNowResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int32", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "purgeHistoryNowResponse", "attribute": false, "wrapped": false } }, "addZoneTemplateResponse": { "title": "addZoneTemplateResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addZoneTemplateResponse", "attribute": false, "wrapped": false } }, "addCustomOptionDefinitionResponse": { "title": "addCustomOptionDefinitionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addCustomOptionDefinitionResponse", "attribute": false, "wrapped": false } }, "addDeviceTypeResponse": { "title": "addDeviceTypeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDeviceTypeResponse", "attribute": false, "wrapped": false } }, "addDeviceSubtypeResponse": { "title": "addDeviceSubtypeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDeviceSubtypeResponse", "attribute": false, "wrapped": false } }, "addDeviceResponse": { "title": "addDeviceResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDeviceResponse", "attribute": false, "wrapped": false } }, "getIPRangedByIPResponse": { "title": "getIPRangedByIPResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getIPRangedByIPResponse", "attribute": false, "wrapped": false } }, "addBulkHostRecordResponse": { "title": "addBulkHostRecordResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addBulkHostRecordResponse", "attribute": false, "wrapped": false } }, "isMigrationRunningResponse": { "title": "isMigrationRunningResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "boolean", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "isMigrationRunningResponse", "attribute": false, "wrapped": false } }, "addIP4ReconciliationPolicyResponse": { "title": "addIP4ReconciliationPolicyResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP4ReconciliationPolicyResponse", "attribute": false, "wrapped": false } }, "getUserDefinedFieldsResponse": { "title": "getUserDefinedFieldsResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getUserDefinedFieldsResponse", "attribute": false, "wrapped": false } }, "addIP4IPGroupByRangeResponse": { "title": "addIP4IPGroupByRangeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP4IPGroupByRangeResponse", "attribute": false, "wrapped": false } }, "addIP4IPGroupBySizeResponse": { "title": "addIP4IPGroupBySizeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP4IPGroupBySizeResponse", "attribute": false, "wrapped": false } }, "splitIP4NetworkResponse": { "title": "splitIP4NetworkResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "splitIP4NetworkResponse", "attribute": false, "wrapped": false } }, "splitIP6RangeResponse": { "title": "splitIP6RangeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "splitIP6RangeResponse", "attribute": false, "wrapped": false } }, "addDeviceInstanceResponse": { "title": "addDeviceInstanceResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addDeviceInstanceResponse", "attribute": false, "wrapped": false } }, "getKSKResponse": { "title": "getKSKResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getKSKResponse", "attribute": false, "wrapped": false } }, "addResponsePolicyResponse": { "title": "addResponsePolicyResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addResponsePolicyResponse", "attribute": false, "wrapped": false } }, "getReplicationInfoResponse": { "title": "getReplicationInfoResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getReplicationInfoResponse", "attribute": false, "wrapped": false } }, "getDiscoveredDevicesResponse": { "title": "getDiscoveredDevicesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDevicesResponse", "attribute": false, "wrapped": false } }, "getDiscoveredDeviceResponse": { "title": "getDiscoveredDeviceResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDeviceResponse", "attribute": false, "wrapped": false } }, "getDiscoveredDeviceInterfacesResponse": { "title": "getDiscoveredDeviceInterfacesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDeviceInterfacesResponse", "attribute": false, "wrapped": false } }, "getDiscoveredDeviceNetworksResponse": { "title": "getDiscoveredDeviceNetworksResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDeviceNetworksResponse", "attribute": false, "wrapped": false } }, "getDiscoveredDeviceHostsResponse": { "title": "getDiscoveredDeviceHostsResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDeviceHostsResponse", "attribute": false, "wrapped": false } }, "getDiscoveredDeviceVlansResponse": { "title": "getDiscoveredDeviceVlansResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDeviceVlansResponse", "attribute": false, "wrapped": false } }, "getDiscoveredDeviceArpEntriesResponse": { "title": "getDiscoveredDeviceArpEntriesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDeviceArpEntriesResponse", "attribute": false, "wrapped": false } }, "getDiscoveredDeviceMacAddressEntriesResponse": { "title": "getDiscoveredDeviceMacAddressEntriesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDiscoveredDeviceMacAddressEntriesResponse", "attribute": false, "wrapped": false } }, "getProbeDataResponse": { "title": "getProbeDataResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getProbeDataResponse", "attribute": false, "wrapped": false } }, "getSharedNetworksResponse": { "title": "getSharedNetworksResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getSharedNetworksResponse", "attribute": false, "wrapped": false } }, "getLocationByCodeResponse": { "title": "getLocationByCodeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getLocationByCodeResponse", "attribute": false, "wrapped": false } }, "getAllUsedLocationsResponse": { "title": "getAllUsedLocationsResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getAllUsedLocationsResponse", "attribute": false, "wrapped": false } }, "searchResponsePolicyItemsResponse": { "title": "searchResponsePolicyItemsResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "searchResponsePolicyItemsResponse", "attribute": false, "wrapped": false } }, "getConfigurationSettingResponse": { "title": "getConfigurationSettingResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getConfigurationSettingResponse", "attribute": false, "wrapped": false } }, "addRawDeploymentOptionResponse": { "title": "addRawDeploymentOptionResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addRawDeploymentOptionResponse", "attribute": false, "wrapped": false } }, "addResponsePolicyItemResponse": { "title": "addResponsePolicyItemResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "boolean", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addResponsePolicyItemResponse", "attribute": false, "wrapped": false } }, "deleteResponsePolicyItemResponse": { "title": "deleteResponsePolicyItemResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int32", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "deleteResponsePolicyItemResponse", "attribute": false, "wrapped": false } }, "findResponsePoliciesWithItemResponse": { "title": "findResponsePoliciesWithItemResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "findResponsePoliciesWithItemResponse", "attribute": false, "wrapped": false } }, "selectiveDeployResponse": { "title": "selectiveDeployResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "selectiveDeployResponse", "attribute": false, "wrapped": false } }, "getDeploymentTaskStatusResponse": { "title": "getDeploymentTaskStatusResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getDeploymentTaskStatusResponse", "attribute": false, "wrapped": false } }, "getServerDeploymentStatusResponse": { "title": "getServerDeploymentStatusResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int32", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getServerDeploymentStatusResponse", "attribute": false, "wrapped": false } }, "getSystemInfoResponse": { "title": "getSystemInfoResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getSystemInfoResponse", "attribute": false, "wrapped": false } }, "getLinkedEntitiesResponse": { "title": "getLinkedEntitiesResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getLinkedEntitiesResponse", "attribute": false, "wrapped": false } }, "getIP6AddressResponse": { "title": "getIP6AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getIP6AddressResponse", "attribute": false, "wrapped": false } }, "getAccessRightResponse": { "title": "getAccessRightResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getAccessRightResponse", "attribute": false, "wrapped": false } }, "getIP4AddressResponse": { "title": "getIP4AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getIP4AddressResponse", "attribute": false, "wrapped": false } }, "addIP4NetworkResponse": { "title": "addIP4NetworkResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP4NetworkResponse", "attribute": false, "wrapped": false } }, "addIP4NetworkTemplateResponse": { "title": "addIP4NetworkTemplateResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addIP4NetworkTemplateResponse", "attribute": false, "wrapped": false } }, "getNextAvailableIP4NetworkResponse": { "title": "getNextAvailableIP4NetworkResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getNextAvailableIP4NetworkResponse", "attribute": false, "wrapped": false } }, "getNextAvailableIP4AddressResponse": { "title": "getNextAvailableIP4AddressResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getNextAvailableIP4AddressResponse", "attribute": false, "wrapped": false } }, "getNextAvailableIPRangeResponse": { "title": "getNextAvailableIPRangeResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getNextAvailableIPRangeResponse", "attribute": false, "wrapped": false } }, "addTagResponse": { "title": "addTagResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "integer", "format": "int64", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "addTagResponse", "attribute": false, "wrapped": false } }, "getParentResponse": { "title": "getParentResponse", "required": [ "return" ], "type": "object", "properties": { "return": { "type": "string", "xml": { "name": "return", "attribute": false, "wrapped": false } } }, "xml": { "name": "getParentResponse", "attribute": false, "wrapped": false } }, "getEntityById": { "title": "getEntityById", "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" } } }, "replaceServer": { "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" } } }, "addServer": { "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" } } }, "moveDeploymentRoles": { "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" } } }, "getEntities": { "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" } } }, "login": { "title": "login", "required": [ "username", "password" ], "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } } }, "addUser": { "title": "addUser", "required": [ "username", "password", "properties" ], "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "properties": { "type": "string" } } }, "addAccessRight": { "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" } } }, "addEntity": { "title": "addEntity", "required": [ "parentId", "entity" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "entity": { "type": "string" } } }, "getProbeStatus": { "title": "getProbeStatus", "required": [ "definedProbe" ], "type": "object", "properties": { "definedProbe": { "type": "string" } } }, "loginWithOptions": { "title": "loginWithOptions", "required": [ "username", "password", "options" ], "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "options": { "type": "string" } } }, "addIP4BlockByCIDR": { "title": "addIP4BlockByCIDR", "required": [ "parentId", "CIDR", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "CIDR": { "type": "string" }, "properties": { "type": "string" } } }, "addIP4BlockByRange": { "title": "addIP4BlockByRange", "required": [ "parentId", "start", "end", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "start": { "type": "string" }, "end": { "type": "string" }, "properties": { "type": "string" } } }, "addDHCP4Range": { "title": "addDHCP4Range", "required": [ "networkId", "start", "end", "properties" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" }, "start": { "type": "string" }, "end": { "type": "string" }, "properties": { "type": "string" } } }, "addDHCP4RangeBySize": { "title": "addDHCP4RangeBySize", "required": [ "networkId", "offset", "size", "properties" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" }, "offset": { "type": "string" }, "size": { "type": "string" }, "properties": { "type": "string" } } }, "addDHCP6Range": { "title": "addDHCP6Range", "required": [ "networkId", "start", "end", "properties" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" }, "start": { "type": "string" }, "end": { "type": "string" }, "properties": { "type": "string" } } }, "addDHCP6RangeBySize": { "title": "addDHCP6RangeBySize", "required": [ "networkId", "start", "size", "properties" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" }, "start": { "type": "string" }, "size": { "type": "string" }, "properties": { "type": "string" } } }, "addDHCPMatchClass": { "title": "addDHCPMatchClass", "required": [ "configurationId", "name", "matchCriteria", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "matchCriteria": { "type": "string" }, "properties": { "type": "string" } } }, "addDHCPSubClass": { "title": "addDHCPSubClass", "required": [ "matchClassId", "matchValue", "properties" ], "type": "object", "properties": { "matchClassId": { "type": "integer", "format": "int64" }, "matchValue": { "type": "string" }, "properties": { "type": "string" } } }, "addView": { "title": "addView", "required": [ "configurationId", "name", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "addZone": { "title": "addZone", "required": [ "parentId", "absoluteName", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "properties": { "type": "string" } } }, "addExternalHostRecord": { "title": "addExternalHostRecord", "required": [ "viewId", "name", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "addEnumZone": { "title": "addEnumZone", "required": [ "parentId", "prefix", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "prefix": { "type": "integer", "format": "int32" }, "properties": { "type": "string" } } }, "addEnumNumber": { "title": "addEnumNumber", "required": [ "enumZoneId", "number", "properties" ], "type": "object", "properties": { "enumZoneId": { "type": "integer", "format": "int64" }, "number": { "type": "integer", "format": "int32" }, "properties": { "type": "string" } } }, "addResourceRecord": { "title": "addResourceRecord", "required": [ "viewId", "absoluteName", "type", "rdata", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "type": { "type": "string" }, "rdata": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "addHostRecord": { "title": "addHostRecord", "required": [ "viewId", "absoluteName", "addresses", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "addresses": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "addAliasRecord": { "title": "addAliasRecord", "required": [ "viewId", "absoluteName", "linkedRecordName", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "linkedRecordName": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "addMXRecord": { "title": "addMXRecord", "required": [ "viewId", "absoluteName", "priority", "linkedRecordName", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "linkedRecordName": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "addSRVRecord": { "title": "addSRVRecord", "required": [ "viewId", "absoluteName", "priority", "port", "weight", "linkedRecordName", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "port": { "type": "integer", "format": "int32" }, "weight": { "type": "integer", "format": "int32" }, "linkedRecordName": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "addTXTRecord": { "title": "addTXTRecord", "required": [ "viewId", "absoluteName", "txt", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "txt": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "addHINFORecord": { "title": "addHINFORecord", "required": [ "viewId", "absoluteName", "cpu", "os", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "cpu": { "type": "string" }, "os": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "addNAPTRRecord": { "title": "addNAPTRRecord", "required": [ "viewId", "absoluteName", "order", "preference", "service", "regexp", "replacement", "flags", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "preference": { "type": "integer", "format": "int32" }, "service": { "type": "string" }, "regexp": { "type": "string" }, "replacement": { "type": "string" }, "flags": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "addGenericRecord": { "title": "addGenericRecord", "required": [ "viewId", "absoluteName", "type", "rdata", "ttl", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "type": { "type": "string" }, "rdata": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "addStartOfAuthority": { "title": "addStartOfAuthority", "required": [ "parentId", "email", "refresh", "retry", "expire", "minimum", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "email": { "type": "string" }, "refresh": { "type": "integer", "format": "int64" }, "retry": { "type": "integer", "format": "int64" }, "expire": { "type": "integer", "format": "int64" }, "minimum": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "addACL": { "title": "addACL", "required": [ "configurationId", "name", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "addUserGroup": { "title": "addUserGroup", "required": [ "name", "properties" ], "type": "object", "properties": { "name": { "type": "string" }, "properties": { "type": "string" } } }, "addTagGroup": { "title": "addTagGroup", "required": [ "name", "properties" ], "type": "object", "properties": { "name": { "type": "string" }, "properties": { "type": "string" } } }, "addTFTPGroup": { "title": "addTFTPGroup", "required": [ "configurationId", "name", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "addTFTPFolder": { "title": "addTFTPFolder", "required": [ "parentId", "name", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "addTFTPFile": { "title": "addTFTPFile", "required": [ "parentId", "name", "version", "data", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "version": { "type": "string" }, "data": { "type": "string", "format": "binary" }, "properties": { "type": "string" } } }, "addTFTPDeploymentRole": { "title": "addTFTPDeploymentRole", "required": [ "entityId", "serverId", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverId": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "createXHAPair": { "title": "createXHAPair", "required": [ "configurationId", "activeServerId", "passiveServerId", "activeServerNewIPv4Address", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "activeServerId": { "type": "integer", "format": "int64" }, "passiveServerId": { "type": "integer", "format": "int64" }, "activeServerNewIPv4Address": { "type": "string" }, "properties": { "type": "string" } } }, "editXHAPair": { "title": "editXHAPair", "required": [ "xHAServerId", "name", "properties" ], "type": "object", "properties": { "xHAServerId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "failoverXHA": { "title": "failoverXHA", "required": [ "xHAServerId" ], "type": "object", "properties": { "xHAServerId": { "type": "integer", "format": "int64" } } }, "breakXHAPair": { "title": "breakXHAPair", "required": [ "xHAServerId", "breakInProteusOnly" ], "type": "object", "properties": { "xHAServerId": { "type": "integer", "format": "int64" }, "breakInProteusOnly": { "type": "boolean" } } }, "importServer": { "title": "importServer", "required": [ "serverId", "importDns", "importDhcp", "properties" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "importDns": { "type": "boolean" }, "importDhcp": { "type": "boolean" }, "properties": { "type": "string" } } }, "deployServerServices": { "title": "deployServerServices", "required": [ "serverId", "services" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "services": { "type": "string" } } }, "deployServerConfig": { "title": "deployServerConfig", "required": [ "serverId", "properties" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "addAdditionalIPAddresses": { "title": "addAdditionalIPAddresses", "required": [ "serverId", "ipsToAdd", "properties" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "ipsToAdd": { "type": "string" }, "properties": { "type": "string" } } }, "removeAdditionalIPAddresses": { "title": "removeAdditionalIPAddresses", "required": [ "serverId", "ipsToRemove", "properties" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "ipsToRemove": { "type": "string" }, "properties": { "type": "string" } } }, "getAdditionalIPAddresses": { "title": "getAdditionalIPAddresses", "required": [ "adonisID", "properties" ], "type": "object", "properties": { "adonisID": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "assignIP4Address": { "title": "assignIP4Address", "required": [ "configurationId", "ip4Address", "macAddress", "hostInfo", "action", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "ip4Address": { "type": "string" }, "macAddress": { "type": "string" }, "hostInfo": { "type": "string" }, "action": { "type": "string" }, "properties": { "type": "string" } } }, "assignNextAvailableIP4Address": { "title": "assignNextAvailableIP4Address", "required": [ "configurationId", "parentId", "macAddress", "hostInfo", "action", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "parentId": { "type": "integer", "format": "int64" }, "macAddress": { "type": "string" }, "hostInfo": { "type": "string" }, "action": { "type": "string" }, "properties": { "type": "string" } } }, "getNextIP4Address": { "title": "getNextIP4Address", "required": [ "parentId", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "getMaxAllowedRange": { "title": "getMaxAllowedRange", "required": [ "rangeId" ], "type": "object", "properties": { "rangeId": { "type": "integer", "format": "int64" } } }, "getNextAvailableIPRanges": { "title": "getNextAvailableIPRanges", "required": [ "parentId", "size", "type", "count", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "size": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "properties": { "type": "string" } } }, "tagEntity": { "title": "tagEntity", "required": [ "entityId", "tagId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "tagId": { "type": "integer", "format": "int64" } } }, "untagEntity": { "title": "untagEntity", "required": [ "entityId", "tagId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "tagId": { "type": "integer", "format": "int64" } } }, "quickDeploy": { "title": "quickDeploy", "required": [ "entityId", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "getDependentRecords": { "title": "getDependentRecords", "required": [ "entityId", "start", "count" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "getNetworkLinkedProperties": { "title": "getNetworkLinkedProperties", "required": [ "networkId" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" } } }, "linkEntities": { "title": "linkEntities", "required": [ "entity1Id", "entity2Id", "properties" ], "type": "object", "properties": { "entity1Id": { "type": "integer", "format": "int64" }, "entity2Id": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "unlinkEntities": { "title": "unlinkEntities", "required": [ "entity1Id", "entity2Id", "properties" ], "type": "object", "properties": { "entity1Id": { "type": "integer", "format": "int64" }, "entity2Id": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "getServerForRole": { "title": "getServerForRole", "required": [ "roleId" ], "type": "object", "properties": { "roleId": { "type": "integer", "format": "int64" } } }, "getMACAddressesInPool": { "title": "getMACAddressesInPool", "required": [ "macPoolId", "start", "count" ], "type": "object", "properties": { "macPoolId": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "getMACAddress": { "title": "getMACAddress", "required": [ "configurationId", "macAddress" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "macAddress": { "type": "string" } } }, "getEntityByName": { "title": "getEntityByName", "required": [ "parentId", "name", "type" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "type": { "type": "string" } } }, "getEntitiesByName": { "title": "getEntitiesByName", "required": [ "parentId", "name", "type", "start", "count" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "type": { "type": "string" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "getEntitiesByNameUsingOptions": { "title": "getEntitiesByNameUsingOptions", "required": [ "parentId", "name", "type", "start", "count", "options" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "type": { "type": "string" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } }, "getAliasesByHint": { "title": "getAliasesByHint", "required": [ "start", "count", "options" ], "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } }, "getHostRecordsByHint": { "title": "getHostRecordsByHint", "required": [ "start", "count", "options" ], "type": "object", "properties": { "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } }, "getZonesByHint": { "title": "getZonesByHint", "required": [ "containerId", "start", "count", "options" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } }, "getIP4NetworksByHint": { "title": "getIP4NetworksByHint", "required": [ "containerId", "start", "count", "options" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } }, "getIP6ObjectsByHint": { "title": "getIP6ObjectsByHint", "required": [ "containerId", "objectType", "start", "count", "options" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "objectType": { "type": "string" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } }, "getEntityByCIDR": { "title": "getEntityByCIDR", "required": [ "parentId", "cidr", "type" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "cidr": { "type": "string" }, "type": { "type": "string" } } }, "getEntityByRange": { "title": "getEntityByRange", "required": [ "parentId", "address1", "address2", "type" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "type": { "type": "string" } } }, "deleteWithOptions": { "title": "deleteWithOptions", "required": [ "objectId", "options" ], "type": "object", "properties": { "objectId": { "type": "integer", "format": "int64" }, "options": { "type": "string" } } }, "updateWithOptions": { "title": "updateWithOptions", "required": [ "entity", "options" ], "type": "object", "properties": { "entity": { "type": "string" }, "options": { "type": "string" } } }, "getAccessRightsForEntity": { "title": "getAccessRightsForEntity", "required": [ "entityId", "start", "count" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "getAccessRightsForUser": { "title": "getAccessRightsForUser", "required": [ "userId", "start", "count" ], "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "deleteAccessRight": { "title": "deleteAccessRight", "required": [ "entityId", "userId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64" } } }, "updateAccessRight": { "title": "updateAccessRight", "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" } } }, "getDeploymentRoles": { "title": "getDeploymentRoles", "required": [ "entityId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" } } }, "getServerDeploymentRoles": { "title": "getServerDeploymentRoles", "required": [ "serverId" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" } } }, "getDNSDeploymentRole": { "title": "getDNSDeploymentRole", "required": [ "entityId", "serverInterfaceId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" } } }, "getDNSDeploymentRoleForView": { "title": "getDNSDeploymentRoleForView", "required": [ "entityId", "serverInterfaceId", "viewId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" }, "viewId": { "type": "integer", "format": "int64" } } }, "getDHCPDeploymentRole": { "title": "getDHCPDeploymentRole", "required": [ "entityId", "serverInterfaceId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" } } }, "addDNSDeploymentRole": { "title": "addDNSDeploymentRole", "required": [ "entityId", "serverInterfaceId", "type", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "addDHCPDeploymentRole": { "title": "addDHCPDeploymentRole", "required": [ "entityId", "serverInterfaceId", "type", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "deleteDNSDeploymentRole": { "title": "deleteDNSDeploymentRole", "required": [ "entityId", "serverInterfaceId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" } } }, "deleteDNSDeploymentRoleForView": { "title": "deleteDNSDeploymentRoleForView", "required": [ "entityId", "serverInterfaceId", "viewId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" }, "viewId": { "type": "integer", "format": "int64" } } }, "deleteDHCPDeploymentRole": { "title": "deleteDHCPDeploymentRole", "required": [ "entityId", "serverInterfaceId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "serverInterfaceId": { "type": "integer", "format": "int64" } } }, "updateDNSDeploymentRole": { "title": "updateDNSDeploymentRole", "required": [ "role" ], "type": "object", "properties": { "role": { "type": "string" } } }, "updateDHCPDeploymentRole": { "title": "updateDHCPDeploymentRole", "required": [ "role" ], "type": "object", "properties": { "role": { "type": "string" } } }, "getDeploymentOptions": { "title": "getDeploymentOptions", "required": [ "entityId", "optionTypes", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "optionTypes": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } }, "getDNSDeploymentOption": { "title": "getDNSDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } }, "getDHCPClientDeploymentOption": { "title": "getDHCPClientDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } }, "getDHCP6ClientDeploymentOption": { "title": "getDHCP6ClientDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } }, "getDHCPServiceDeploymentOption": { "title": "getDHCPServiceDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } }, "getDHCP6ServiceDeploymentOption": { "title": "getDHCP6ServiceDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } }, "addDNSDeploymentOption": { "title": "addDNSDeploymentOption", "required": [ "entityId", "name", "value", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } }, "addDHCPClientDeploymentOption": { "title": "addDHCPClientDeploymentOption", "required": [ "entityId", "name", "value", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } }, "addDHCP6ClientDeploymentOption": { "title": "addDHCP6ClientDeploymentOption", "required": [ "entityId", "name", "value", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } }, "addDHCPServiceDeploymentOption": { "title": "addDHCPServiceDeploymentOption", "required": [ "entityId", "name", "value", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } }, "addDHCP6ServiceDeploymentOption": { "title": "addDHCP6ServiceDeploymentOption", "required": [ "entityId", "name", "value", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } }, "deleteDNSDeploymentOption": { "title": "deleteDNSDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } }, "deleteDHCPClientDeploymentOption": { "title": "deleteDHCPClientDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } }, "deleteDHCP6ClientDeploymentOption": { "title": "deleteDHCP6ClientDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } }, "deleteDHCPServiceDeploymentOption": { "title": "deleteDHCPServiceDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } }, "deleteDHCP6ServiceDeploymentOption": { "title": "deleteDHCP6ServiceDeploymentOption", "required": [ "entityId", "name", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serverId": { "type": "integer", "format": "int64" } } }, "updateDNSDeploymentOption": { "title": "updateDNSDeploymentOption", "required": [ "option" ], "type": "object", "properties": { "option": { "type": "string" } } }, "updateDHCPClientDeploymentOption": { "title": "updateDHCPClientDeploymentOption", "required": [ "option" ], "type": "object", "properties": { "option": { "type": "string" } } }, "updateDHCP6ClientDeploymentOption": { "title": "updateDHCP6ClientDeploymentOption", "required": [ "option" ], "type": "object", "properties": { "option": { "type": "string" } } }, "updateDHCPServiceDeploymentOption": { "title": "updateDHCPServiceDeploymentOption", "required": [ "option" ], "type": "object", "properties": { "option": { "type": "string" } } }, "updateDHCP6ServiceDeploymentOption": { "title": "updateDHCP6ServiceDeploymentOption", "required": [ "option" ], "type": "object", "properties": { "option": { "type": "string" } } }, "addMACAddress": { "title": "addMACAddress", "required": [ "configurationId", "macAddress", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "macAddress": { "type": "string" }, "properties": { "type": "string" } } }, "associateMACAddressWithPool": { "title": "associateMACAddressWithPool", "required": [ "configurationId", "macAddress", "poolId" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "macAddress": { "type": "string" }, "poolId": { "type": "integer", "format": "int64" } } }, "denyMACAddress": { "title": "denyMACAddress", "required": [ "configurationId", "macAddress" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "macAddress": { "type": "string" } } }, "isAddressAllocated": { "title": "isAddressAllocated", "required": [ "configurationId", "ipAddress", "macAddress" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "ipAddress": { "type": "string" }, "macAddress": { "type": "string" } } }, "mergeSelectedBlocksOrNetworks": { "title": "mergeSelectedBlocksOrNetworks", "required": [ "blockOrNetworkIds", "blockOrNetworkToKeep" ], "type": "object", "properties": { "blockOrNetworkIds": { "type": "string" }, "blockOrNetworkToKeep": { "type": "integer", "format": "int64" } } }, "addParentBlock": { "title": "addParentBlock", "required": [ "blockOrNetworkIds" ], "type": "object", "properties": { "blockOrNetworkIds": { "type": "string" } } }, "addParentBlockWithProperties": { "title": "addParentBlockWithProperties", "required": [ "blockOrNetworkIds", "properties" ], "type": "object", "properties": { "blockOrNetworkIds": { "type": "string" }, "properties": { "type": "string" } } }, "mergeBlocksWithParent": { "title": "mergeBlocksWithParent", "required": [ "blockIds" ], "type": "object", "properties": { "blockIds": { "type": "string" } } }, "resizeRange": { "title": "resizeRange", "required": [ "objectId", "range", "options" ], "type": "object", "properties": { "objectId": { "type": "integer", "format": "int64" }, "range": { "type": "string" }, "options": { "type": "string" } } }, "moveIP4Object": { "title": "moveIP4Object", "required": [ "objectId", "address" ], "type": "object", "properties": { "objectId": { "type": "integer", "format": "int64" }, "address": { "type": "string" } } }, "moveIPObject": { "title": "moveIPObject", "required": [ "objectId", "address", "options" ], "type": "object", "properties": { "objectId": { "type": "integer", "format": "int64" }, "address": { "type": "string" }, "options": { "type": "string" } } }, "moveResourceRecord": { "title": "moveResourceRecord", "required": [ "resourceRecordId", "destinationZone" ], "type": "object", "properties": { "resourceRecordId": { "type": "integer", "format": "int64" }, "destinationZone": { "type": "string" } } }, "updateBulkUdf": { "title": "updateBulkUdf", "required": [ "data", "properties" ], "type": "object", "properties": { "data": { "type": "string", "format": "binary" }, "properties": { "type": "string" } } }, "addVendorProfile": { "title": "addVendorProfile", "required": [ "identifier", "name", "description", "properties" ], "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "properties": { "type": "string" } } }, "addVendorOptionDefinition": { "title": "addVendorOptionDefinition", "required": [ "vendorProfileId", "optionId", "name", "optionType", "description", "allowMultiple", "properties" ], "type": "object", "properties": { "vendorProfileId": { "type": "integer", "format": "int64" }, "optionId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "optionType": { "type": "string" }, "description": { "type": "string" }, "allowMultiple": { "type": "boolean" }, "properties": { "type": "string" } } }, "addDHCPVendorDeploymentOption": { "title": "addDHCPVendorDeploymentOption", "required": [ "parentId", "optionId", "value", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "optionId": { "type": "integer", "format": "int64" }, "value": { "type": "string" }, "properties": { "type": "string" } } }, "getDHCPVendorDeploymentOption": { "title": "getDHCPVendorDeploymentOption", "required": [ "entityId", "optionId", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "optionId": { "type": "integer", "format": "int64" }, "serverId": { "type": "integer", "format": "int64" } } }, "updateDHCPVendorDeploymentOption": { "title": "updateDHCPVendorDeploymentOption", "required": [ "option" ], "type": "object", "properties": { "option": { "type": "string" } } }, "deleteDHCPVendorDeploymentOption": { "title": "deleteDHCPVendorDeploymentOption", "required": [ "entityId", "optionId", "serverId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "optionId": { "type": "integer", "format": "int64" }, "serverId": { "type": "integer", "format": "int64" } } }, "addIP6BlockByPrefix": { "title": "addIP6BlockByPrefix", "required": [ "parentId", "prefix", "name", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "prefix": { "type": "string" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "addIP6BlockByMACAddress": { "title": "addIP6BlockByMACAddress", "required": [ "parentId", "macAddress", "name", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "macAddress": { "type": "string" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "getEntityByPrefix": { "title": "getEntityByPrefix", "required": [ "containerId", "prefix", "type" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "prefix": { "type": "string" }, "type": { "type": "string" } } }, "addIP6NetworkByPrefix": { "title": "addIP6NetworkByPrefix", "required": [ "parentId", "prefix", "name", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "prefix": { "type": "string" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "addIP6Address": { "title": "addIP6Address", "required": [ "containerId", "address", "type", "name", "properties" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "address": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "assignIP6Address": { "title": "assignIP6Address", "required": [ "containerId", "address", "action", "macAddress", "hostInfo", "properties" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "address": { "type": "string" }, "action": { "type": "string" }, "macAddress": { "type": "string" }, "hostInfo": { "type": "string" }, "properties": { "type": "string" } } }, "reassignIP6Address": { "title": "reassignIP6Address", "required": [ "oldAddressId", "destination", "properties" ], "type": "object", "properties": { "oldAddressId": { "type": "integer", "format": "int64" }, "destination": { "type": "string" }, "properties": { "type": "string" } } }, "clearIP6Address": { "title": "clearIP6Address", "required": [ "addressId" ], "type": "object", "properties": { "addressId": { "type": "integer", "format": "int64" } } }, "searchByCategory": { "title": "searchByCategory", "required": [ "keyword", "category", "start", "count" ], "type": "object", "properties": { "keyword": { "type": "string" }, "category": { "type": "string" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "searchByObjectTypes": { "title": "searchByObjectTypes", "required": [ "keyword", "types", "start", "count" ], "type": "object", "properties": { "keyword": { "type": "string" }, "types": { "type": "string" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "customSearch": { "title": "customSearch", "required": [ "filters", "type", "options", "start", "count" ], "type": "object", "properties": { "filters": { "type": "string" }, "type": { "type": "string" }, "options": { "type": "string" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "purgeHistoryNow": { "title": "purgeHistoryNow", "required": [ "untilWhenTimestamp", "numberOfDaysToKeep", "numberOfMonthsToKeep", "waitOption" ], "type": "object", "properties": { "untilWhenTimestamp": { "type": "string" }, "numberOfDaysToKeep": { "type": "integer", "format": "int32" }, "numberOfMonthsToKeep": { "type": "integer", "format": "int32" }, "waitOption": { "type": "boolean" } } }, "addZoneTemplate": { "title": "addZoneTemplate", "required": [ "parentId", "name", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "assignOrUpdateTemplate": { "title": "assignOrUpdateTemplate", "required": [ "entityId", "templateId", "properties" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "templateId": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "reapplyTemplate": { "title": "reapplyTemplate", "required": [ "templateId", "properties" ], "type": "object", "properties": { "templateId": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "addCustomOptionDefinition": { "title": "addCustomOptionDefinition", "required": [ "configurationId", "name", "optionId", "optionType", "allowMultiple", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "optionId": { "type": "integer", "format": "int64" }, "optionType": { "type": "string" }, "allowMultiple": { "type": "boolean" }, "properties": { "type": "string" } } }, "addDeviceType": { "title": "addDeviceType", "required": [ "name", "properties" ], "type": "object", "properties": { "name": { "type": "string" }, "properties": { "type": "string" } } }, "addDeviceSubtype": { "title": "addDeviceSubtype", "required": [ "parentId", "name", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "addDevice": { "title": "addDevice", "required": [ "configurationId", "name", "deviceTypeId", "deviceSubtypeId", "ip4Addresses", "ip6Addresses", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "deviceTypeId": { "type": "integer", "format": "int64" }, "deviceSubtypeId": { "type": "integer", "format": "int64" }, "ip4Addresses": { "type": "string" }, "ip6Addresses": { "type": "string" }, "properties": { "type": "string" } } }, "getIPRangedByIP": { "title": "getIPRangedByIP", "required": [ "containerId", "type", "address" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "address": { "type": "string" } } }, "addBulkHostRecord": { "title": "addBulkHostRecord", "required": [ "viewId", "absoluteName", "ttl", "networkId", "startAddress", "numberOfAddresses", "properties" ], "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "absoluteName": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "networkId": { "type": "integer", "format": "int64" }, "startAddress": { "type": "string" }, "numberOfAddresses": { "type": "integer", "format": "int32" }, "properties": { "type": "string" } } }, "migrateFile": { "title": "migrateFile", "required": [ "filename" ], "type": "object", "properties": { "filename": { "type": "string" } } }, "isMigrationRunning": { "title": "isMigrationRunning", "required": [ "filename" ], "type": "object", "properties": { "filename": { "type": "string" } } }, "addIP4ReconciliationPolicy": { "title": "addIP4ReconciliationPolicy", "required": [ "parentId", "name", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "changeStateIP4Address": { "title": "changeStateIP4Address", "required": [ "addressId", "targetState", "macAddress" ], "type": "object", "properties": { "addressId": { "type": "integer", "format": "int64" }, "targetState": { "type": "string" }, "macAddress": { "type": "string" } } }, "getUserDefinedFields": { "title": "getUserDefinedFields", "required": [ "type", "requiredFieldsOnly" ], "type": "object", "properties": { "type": { "type": "string" }, "requiredFieldsOnly": { "type": "boolean" } } }, "addIP4IPGroupByRange": { "title": "addIP4IPGroupByRange", "required": [ "parentId", "name", "start", "end", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" }, "properties": { "type": "string" } } }, "addIP4IPGroupBySize": { "title": "addIP4IPGroupBySize", "required": [ "parentId", "name", "size", "positionRangeBy", "positionValue", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "size": { "type": "integer", "format": "int32" }, "positionRangeBy": { "type": "string" }, "positionValue": { "type": "string" }, "properties": { "type": "string" } } }, "splitIP4Network": { "title": "splitIP4Network", "required": [ "networkId", "numberOfParts", "options" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" }, "numberOfParts": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } }, "splitIP6Range": { "title": "splitIP6Range", "required": [ "rangeId", "numberOfParts", "options" ], "type": "object", "properties": { "rangeId": { "type": "integer", "format": "int64" }, "numberOfParts": { "type": "integer", "format": "int32" }, "options": { "type": "string" } } }, "addDeviceInstance": { "title": "addDeviceInstance", "required": [ "configName", "deviceName", "ipAddressMode", "ipEntity", "viewName", "zoneName", "recordName", "macAddressMode", "macEntity", "options" ], "type": "object", "properties": { "configName": { "type": "string" }, "deviceName": { "type": "string" }, "ipAddressMode": { "type": "string" }, "ipEntity": { "type": "string" }, "viewName": { "type": "string" }, "zoneName": { "type": "string" }, "recordName": { "type": "string" }, "macAddressMode": { "type": "string" }, "macEntity": { "type": "string" }, "options": { "type": "string" } } }, "deleteDeviceInstance": { "title": "deleteDeviceInstance", "required": [ "configName", "identifier", "options" ], "type": "object", "properties": { "configName": { "type": "string" }, "identifier": { "type": "string" }, "options": { "type": "string" } } }, "getKSK": { "title": "getKSK", "required": [ "entityId", "format" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "format": { "type": "string" } } }, "addResponsePolicy": { "title": "addResponsePolicy", "required": [ "configurationId", "name", "responsePolicyType", "ttl", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "responsePolicyType": { "type": "string" }, "ttl": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "uploadResponsePolicyItems": { "title": "uploadResponsePolicyItems", "required": [ "parentId", "data" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "data": { "type": "string", "format": "binary" } } }, "configureReplication": { "title": "configureReplication", "required": [ "standbyServer", "compressReplication", "replicationQueueThreshold", "replicationBreakThreshold", "properties" ], "type": "object", "properties": { "standbyServer": { "type": "string" }, "compressReplication": { "type": "boolean" }, "replicationQueueThreshold": { "type": "integer", "format": "int64" }, "replicationBreakThreshold": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "configureStreamingReplication": { "title": "configureStreamingReplication", "required": [ "standbyServer", "compressReplication", "latencyWarningThreshold", "latencyCriticalThreshold", "properties" ], "type": "object", "properties": { "standbyServer": { "type": "string" }, "compressReplication": { "type": "boolean" }, "latencyWarningThreshold": { "type": "integer", "format": "int64" }, "latencyCriticalThreshold": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "establishTrustRelationship": { "title": "establishTrustRelationship", "required": [ "remoteIP", "username", "password", "properties" ], "type": "object", "properties": { "remoteIP": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "properties": { "type": "string" } } }, "removeTrustRelationship": { "title": "removeTrustRelationship", "required": [ "otherBAMIP", "properties" ], "type": "object", "properties": { "otherBAMIP": { "type": "string" }, "properties": { "type": "string" } } }, "getReplicationInfo": { "title": "getReplicationInfo", "required": [ "properties" ], "type": "object", "properties": { "properties": { "type": "string" } } }, "failoverReplication": { "title": "failoverReplication", "required": [ "standbyServer", "properties" ], "type": "object", "properties": { "standbyServer": { "type": "string" }, "properties": { "type": "string" } } }, "getDiscoveredDevices": { "title": "getDiscoveredDevices", "required": [ "policyId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" } } }, "getDiscoveredDevice": { "title": "getDiscoveredDevice", "required": [ "policyId", "deviceId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "deviceId": { "type": "integer", "format": "int64" } } }, "getDiscoveredDeviceInterfaces": { "title": "getDiscoveredDeviceInterfaces", "required": [ "policyId", "deviceId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "deviceId": { "type": "integer", "format": "int64" } } }, "getDiscoveredDeviceNetworks": { "title": "getDiscoveredDeviceNetworks", "required": [ "policyId", "deviceId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "deviceId": { "type": "integer", "format": "int64" } } }, "getDiscoveredDeviceHosts": { "title": "getDiscoveredDeviceHosts", "required": [ "policyId", "deviceId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "deviceId": { "type": "integer", "format": "int64" } } }, "getDiscoveredDeviceVlans": { "title": "getDiscoveredDeviceVlans", "required": [ "policyId", "deviceId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "deviceId": { "type": "integer", "format": "int64" } } }, "getDiscoveredDeviceArpEntries": { "title": "getDiscoveredDeviceArpEntries", "required": [ "policyId", "deviceId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "deviceId": { "type": "integer", "format": "int64" } } }, "getDiscoveredDeviceMacAddressEntries": { "title": "getDiscoveredDeviceMacAddressEntries", "required": [ "policyId", "deviceId" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "deviceId": { "type": "integer", "format": "int64" } } }, "startProbe": { "title": "startProbe", "required": [ "definedProbe", "properties" ], "type": "object", "properties": { "definedProbe": { "type": "string" }, "properties": { "type": "string" } } }, "getProbeData": { "title": "getProbeData", "required": [ "definedProbe", "properties" ], "type": "object", "properties": { "definedProbe": { "type": "string" }, "properties": { "type": "string" } } }, "shareNetwork": { "title": "shareNetwork", "required": [ "networkId", "tagId" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" }, "tagId": { "type": "integer", "format": "int64" } } }, "unshareNetwork": { "title": "unshareNetwork", "required": [ "networkId" ], "type": "object", "properties": { "networkId": { "type": "integer", "format": "int64" } } }, "getSharedNetworks": { "title": "getSharedNetworks", "required": [ "tagId" ], "type": "object", "properties": { "tagId": { "type": "integer", "format": "int64" } } }, "getLocationByCode": { "title": "getLocationByCode", "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" } } }, "searchResponsePolicyItems": { "title": "searchResponsePolicyItems", "required": [ "keyword", "scope", "start", "count", "properties" ], "type": "object", "properties": { "keyword": { "type": "string" }, "scope": { "type": "string" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "properties": { "type": "string" } } }, "getConfigurationSetting": { "title": "getConfigurationSetting", "required": [ "configurationId", "settingName" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "settingName": { "type": "string" } } }, "updateConfigurationSetting": { "title": "updateConfigurationSetting", "required": [ "configurationId", "settingName", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "settingName": { "type": "string" }, "properties": { "type": "string" } } }, "addRawDeploymentOption": { "title": "addRawDeploymentOption", "required": [ "parentId", "optionType", "rawData", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "optionType": { "type": "string" }, "rawData": { "type": "string" }, "properties": { "type": "string" } } }, "updateRawDeploymentOption": { "title": "updateRawDeploymentOption", "required": [ "option" ], "type": "object", "properties": { "option": { "type": "string" } } }, "updateUserPassword": { "title": "updateUserPassword", "required": [ "userId", "newPassword", "options" ], "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "newPassword": { "type": "string" }, "options": { "type": "string" } } }, "updateBAMSystemUserPassword": { "title": "updateBAMSystemUserPassword", "required": [ "systemUserName", "newPassword", "options" ], "type": "object", "properties": { "systemUserName": { "type": "string" }, "newPassword": { "type": "string" }, "options": { "type": "string" } } }, "updateBDDSSystemUserPassword": { "title": "updateBDDSSystemUserPassword", "required": [ "serverId", "systemUserName", "newPassword", "options" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "systemUserName": { "type": "string" }, "newPassword": { "type": "string" }, "options": { "type": "string" } } }, "addResponsePolicyItem": { "title": "addResponsePolicyItem", "required": [ "policyId", "itemName", "options" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "itemName": { "type": "string" }, "options": { "type": "string" } } }, "deleteResponsePolicyItem": { "title": "deleteResponsePolicyItem", "required": [ "policyId", "itemName", "options" ], "type": "object", "properties": { "policyId": { "type": "integer", "format": "int64" }, "itemName": { "type": "string" }, "options": { "type": "string" } } }, "findResponsePoliciesWithItem": { "title": "findResponsePoliciesWithItem", "required": [ "configurationId", "itemName", "options" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "itemName": { "type": "string" }, "options": { "type": "string" } } }, "selectiveDeploy": { "title": "selectiveDeploy", "required": [ "entityIds", "properties" ], "type": "object", "properties": { "entityIds": { "type": "string" }, "properties": { "type": "string" } } }, "terminateUserSessions": { "title": "terminateUserSessions", "required": [ "username", "properties" ], "type": "object", "properties": { "username": { "type": "string" }, "properties": { "type": "string" } } }, "getDeploymentTaskStatus": { "title": "getDeploymentTaskStatus", "required": [ "deploymentTaskToken" ], "type": "object", "properties": { "deploymentTaskToken": { "type": "string" } } }, "getServerDeploymentStatus": { "title": "getServerDeploymentStatus", "required": [ "serverId", "properties" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" }, "properties": { "type": "string" } } }, "deployServer": { "title": "deployServer", "required": [ "serverId" ], "type": "object", "properties": { "serverId": { "type": "integer", "format": "int64" } } }, "getLinkedEntities": { "title": "getLinkedEntities", "required": [ "entityId", "type", "start", "count" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "start": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "getIP6Address": { "title": "getIP6Address", "required": [ "containerId", "address" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "address": { "type": "string" } } }, "getAccessRight": { "title": "getAccessRight", "required": [ "entityId", "userId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64" } } }, "getIP4Address": { "title": "getIP4Address", "required": [ "containerId", "address" ], "type": "object", "properties": { "containerId": { "type": "integer", "format": "int64" }, "address": { "type": "string" } } }, "addIP4Network": { "title": "addIP4Network", "required": [ "blockId", "CIDR", "properties" ], "type": "object", "properties": { "blockId": { "type": "integer", "format": "int64" }, "CIDR": { "type": "string" }, "properties": { "type": "string" } } }, "addIP4NetworkTemplate": { "title": "addIP4NetworkTemplate", "required": [ "configurationId", "name", "properties" ], "type": "object", "properties": { "configurationId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "getNextAvailableIP4Network": { "title": "getNextAvailableIP4Network", "required": [ "parentId", "size", "isLargerAllowed", "autoCreate" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "size": { "type": "integer", "format": "int64" }, "isLargerAllowed": { "type": "boolean" }, "autoCreate": { "type": "boolean" } } }, "getNextAvailableIP4Address": { "title": "getNextAvailableIP4Address", "required": [ "parentId" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" } } }, "getNextAvailableIPRange": { "title": "getNextAvailableIPRange", "required": [ "parentId", "size", "type", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "size": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "addTag": { "title": "addTag", "required": [ "parentId", "name", "properties" ], "type": "object", "properties": { "parentId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "update": { "title": "update", "required": [ "entity" ], "type": "object", "properties": { "entity": { "type": "string" } } }, "getParent": { "title": "getParent", "required": [ "entityId" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int64" } } }, "delete": { "title": "delete", "required": [ "objectId" ], "type": "object", "properties": { "objectId": { "type": "integer", "format": "int64" } } } } }, "tags": [ { "name": "ProteusAPIPortBinding", "description": "" } ] }