{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/v1/addACL": { "post": { "tags": [ "DnsMethods" ], "operationId": "addACL", "description": "The parameters and request body are for method: addACL. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addAliasRecord": { "post": { "tags": [ "DnsMethods" ], "operationId": "addAliasRecord", "description": "The parameters and request body are for method: addAliasRecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "absoluteName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "linkedRecordName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ttl", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addBulkHostRecord": { "post": { "tags": [ "DnsMethods" ], "operationId": "addBulkHostRecord", "description": "The parameters and request body are for method: addBulkHostRecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "absoluteName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "networkId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "numberOfAddresses", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "startAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ttl", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDNSDeploymentOption": { "post": { "tags": [ "DnsMethods" ], "operationId": "addDNSDeploymentOption", "description": "The parameters and request body are for method: addDNSDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addEnumNumber": { "post": { "tags": [ "DnsMethods" ], "operationId": "addEnumNumber", "description": "The parameters and request body are for method: addEnumNumber. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "enumZoneId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "number", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addEnumZone": { "post": { "tags": [ "DnsMethods" ], "operationId": "addEnumZone", "description": "The parameters and request body are for method: addEnumZone. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "prefix", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addExternalHostRecord": { "post": { "tags": [ "DnsMethods" ], "operationId": "addExternalHostRecord", "description": "The parameters and request body are for method: addExternalHostRecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addGenericRecord": { "post": { "tags": [ "DnsMethods" ], "operationId": "addGenericRecord", "description": "The parameters and request body are for method: addGenericRecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "absoluteName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "rdata", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ttl", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addHINFORecord": { "post": { "tags": [ "DnsMethods" ], "operationId": "addHINFORecord", "description": "The parameters and request body are for method: addHINFORecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "absoluteName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "cpu", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "os", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ttl", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addHostRecord": { "post": { "tags": [ "DnsMethods" ], "operationId": "addHostRecord", "description": "The parameters and request body are for method: addHostRecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "absoluteName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "addresses", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ttl", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addMXRecord": { "post": { "tags": [ "DnsMethods" ], "operationId": "addMXRecord", "description": "The parameters and request body are for method: addMXRecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "absoluteName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "linkedRecordName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "priority", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ttl", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addNAPTRRecord": { "post": { "tags": [ "DnsMethods" ], "operationId": "addNAPTRRecord", "description": "The parameters and request body are for method: addNAPTRRecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "absoluteName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "flags", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "preference", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "regexp", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "replacement", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "service", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ttl", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addResourceRecord": { "post": { "tags": [ "DnsMethods" ], "operationId": "addResourceRecord", "description": "The parameters and request body are for method: addResourceRecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "absoluteName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "rdata", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ttl", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addResponsePolicy": { "post": { "tags": [ "DnsMethods" ], "operationId": "addResponsePolicy", "description": "The parameters and request body are for method: addResponsePolicy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "responsePolicyType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ttl", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addResponsePolicyItem": { "post": { "tags": [ "DnsMethods" ], "operationId": "addResponsePolicyItem", "description": "The parameters and request body are for method: addResponsePolicyItem. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "itemName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addSRVRecord": { "post": { "tags": [ "DnsMethods" ], "operationId": "addSRVRecord", "description": "The parameters and request body are for method: addSRVRecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "absoluteName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "linkedRecordName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "port", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "priority", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ttl", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "weight", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addStartOfAuthority": { "post": { "tags": [ "DnsMethods" ], "operationId": "addStartOfAuthority", "description": "The parameters and request body are for method: addStartOfAuthority. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "email", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "expire", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "minimum", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "refresh", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "retry", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addTXTRecord": { "post": { "tags": [ "DnsMethods" ], "operationId": "addTXTRecord", "description": "The parameters and request body are for method: addTXTRecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "absoluteName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ttl", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "txt", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addView": { "post": { "tags": [ "DnsMethods" ], "operationId": "addView", "description": "The parameters and request body are for method: addView. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addZone": { "post": { "tags": [ "DnsMethods" ], "operationId": "addZone", "description": "The parameters and request body are for method: addZone. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "absoluteName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addZoneTemplate": { "post": { "tags": [ "DnsMethods" ], "operationId": "addZoneTemplate", "description": "The parameters and request body are for method: addZoneTemplate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deleteDNSDeploymentOption": { "delete": { "tags": [ "DnsMethods" ], "operationId": "deleteDNSDeploymentOption", "description": "The parameters and request body are for method: deleteDNSDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deleteResponsePolicyItem": { "delete": { "tags": [ "DnsMethods" ], "operationId": "deleteResponsePolicyItem", "description": "The parameters and request body are for method: deleteResponsePolicyItem. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "itemName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/findResponsePoliciesWithItem": { "get": { "tags": [ "DnsMethods" ], "operationId": "findResponsePoliciesWithItem", "description": "The parameters and request body are for method: findResponsePoliciesWithItem. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "itemName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDNSDeploymentOption": { "get": { "tags": [ "DnsMethods" ], "operationId": "getDNSDeploymentOption", "description": "The parameters and request body are for method: getDNSDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 1, "type": "string", "name": "string", "value": "string", "properties": "string" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getHostRecordsByHint": { "get": { "tags": [ "DnsMethods" ], "operationId": "getHostRecordsByHint", "description": "The parameters and request body are for method: getHostRecordsByHint. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getKSK": { "get": { "tags": [ "DnsMethods" ], "operationId": "getKSK", "description": "The parameters and request body are for method: getKSK. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "string", "string", "string" ] } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getNetworkLinkedProperties": { "get": { "tags": [ "DnsMethods" ], "operationId": "getNetworkLinkedProperties", "description": "The parameters and request body are for method: getNetworkLinkedProperties. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "networkId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getZonesByHint": { "get": { "tags": [ "DnsMethods" ], "operationId": "getZonesByHint", "description": "The parameters and request body are for method: getZonesByHint. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "containerId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/moveResourceRecord": { "put": { "tags": [ "DnsMethods" ], "operationId": "moveResourceRecord", "description": "The parameters and request body are for method: moveResourceRecord. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "destinationZone", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "resourceRecordId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/searchResponsePolicyItems": { "get": { "tags": [ "DnsMethods" ], "operationId": "searchResponsePolicyItems", "description": "The parameters and request body are for method: searchResponsePolicyItems. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "policyType": { "type": "string" }, "parentIds": { "type": "string" }, "category": { "type": "string" }, "configId": { "type": "number" } } } }, "example": [ { "name": "...", "policyType": "...", "parentIds": "...", "category": "...", "configId": 12345 } ] } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/updateDNSDeploymentOption": { "put": { "tags": [ "DnsMethods" ], "operationId": "updateDNSDeploymentOption", "description": "The parameters and request body are for method: updateDNSDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/uploadResponsePolicyItems": { "post": { "tags": [ "DnsMethods" ], "operationId": "uploadResponsePolicyItems", "description": "The parameters and request body are for method: uploadResponsePolicyItems. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } } }, "/v1/addAccessRight": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "addAccessRight", "description": "The parameters and request body are for method: addAccessRight. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "overrides", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDevice": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "addDevice", "description": "The parameters and request body are for method: addDevice. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "deviceSubtypeId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "deviceTypeId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ip4Addresses", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ip6Addresses", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDeviceSubtype": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "addDeviceSubtype", "description": "The parameters and request body are for method: addDeviceSubtype. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDeviceType": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "addDeviceType", "description": "The parameters and request body are for method: addDeviceType. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addMACAddress": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "addMACAddress", "description": "The parameters and request body are for method: addMACAddress. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "macAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addTag": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "addTag", "description": "The parameters and request body are for method: addTag. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addTagGroup": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "addTagGroup", "description": "The parameters and request body are for method: addTagGroup. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addUser": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "addUser", "description": "The parameters and request body are for method: addUser. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "password", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addUserGroup": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "addUserGroup", "description": "The parameters and request body are for method: addUserGroup. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/associateMACAddressWithPool": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "associateMACAddressWithPool", "description": "The parameters and request body are for method: associateMACAddressWithPool. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "macAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "poolId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/breakReplication": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "breakReplication", "description": "The parameters and request body are for method: breakReplication. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/configureStreamingReplication": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "configureStreamingReplication", "description": "The parameters and request body are for method: configureStreamingReplication. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "compressReplication", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "latencyCriticalThreshold", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "latencyWarningThreshold", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "standbyServer", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deleteAccessRight": { "delete": { "tags": [ "BamObjectMethods" ], "operationId": "deleteAccessRight", "description": "The parameters and request body are for method: deleteAccessRight. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/denyMACAddress": { "put": { "tags": [ "BamObjectMethods" ], "operationId": "denyMACAddress", "description": "The parameters and request body are for method: denyMACAddress. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "macAddress", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/establishTrustRelationship": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "establishTrustRelationship", "description": "The parameters and request body are for method: establishTrustRelationship. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "password", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "remoteIP", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/failoverReplication": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "failoverReplication", "description": "The parameters and request body are for method: failoverReplication. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "standbyServer", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getAccessRight": { "get": { "tags": [ "BamObjectMethods" ], "operationId": "getAccessRight", "description": "The parameters and request body are for method: getAccessRight. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "number" }, "userId": { "type": "number" }, "value": { "type": "string" }, "overrides": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "entityId": 5, "userId": 1, "value": "string", "overrides": "string", "properties": "string" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getAccessRightsForEntity": { "get": { "tags": [ "BamObjectMethods" ], "operationId": "getAccessRightsForEntity", "description": "The parameters and request body are for method: getAccessRightsForEntity. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "entityId": { "type": "number" }, "userId": { "type": "number" }, "value": { "type": "string" }, "overrides": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "entityId": 12345, "userId": 12345, "value": "...", "overrides": "...", "properties": "..." }, { "entityId": 12345, "userId": 12345, "value": "...", "overrides": "...", "properties": "..." }, { "entityId": 12345, "userId": 12345, "value": "...", "overrides": "...", "properties": "..." }, { "entityId": 12345, "userId": 12345, "value": "...", "overrides": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getAccessRightsForUser": { "get": { "tags": [ "BamObjectMethods" ], "operationId": "getAccessRightsForUser", "description": "The parameters and request body are for method: getAccessRightsForUser. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "entityId": { "type": "number" }, "userId": { "type": "number" }, "value": { "type": "string" }, "overrides": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "entityId": 12345, "userId": 12345, "value": "...", "overrides": "...", "properties": "..." }, { "entityId": 12345, "userId": 12345, "value": "...", "overrides": "...", "properties": "..." }, { "entityId": 12345, "userId": 12345, "value": "...", "overrides": "...", "properties": "..." }, { "entityId": 12345, "userId": 12345, "value": "...", "overrides": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getAllUsedLocations": { "get": { "tags": [ "BamObjectMethods" ], "operationId": "getAllUsedLocations", "description": "The parameters and request body are for method: getAllUsedLocations. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getConfigurationGroups": { "get": { "tags": [ "BamObjectMethods" ], "operationId": "getConfigurationGroups", "description": "The parameters and request body are for method: getConfigurationGroups. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "string" ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getConfigurationSetting": { "get": { "tags": [ "BamObjectMethods" ], "operationId": "getConfigurationSetting", "description": "The parameters and request body are for method: getConfigurationSetting. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "settingName", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getConfigurationsByGroup": { "get": { "tags": [ "BamObjectMethods" ], "operationId": "getConfigurationsByGroup", "description": "The parameters and request body are for method: getConfigurationsByGroup. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "groupName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getLocationByCode": { "get": { "tags": [ "BamObjectMethods" ], "operationId": "getLocationByCode", "description": "The parameters and request body are for method: getLocationByCode. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 10, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getMACAddress": { "get": { "tags": [ "BamObjectMethods" ], "operationId": "getMACAddress", "description": "The parameters and request body are for method: getMACAddress. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 4, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "macAddress", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getReplicationInfo": { "get": { "tags": [ "BamObjectMethods" ], "operationId": "getReplicationInfo", "description": "The parameters and request body are for method: getReplicationInfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/purgeHistoryNow": { "put": { "tags": [ "BamObjectMethods" ], "operationId": "purgeHistoryNow", "description": "The parameters and request body are for method: purgeHistoryNow. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "numberOfDaysToKeep", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "numberOfMonthsToKeep", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "untilWhenTimestamp", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "waitOption", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/removeTrustRelationship": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "removeTrustRelationship", "description": "The parameters and request body are for method: removeTrustRelationship. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "otherBAMIP", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/terminateUserSessions": { "post": { "tags": [ "BamObjectMethods" ], "operationId": "terminateUserSessions", "description": "The parameters and request body are for method: terminateUserSessions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/updateAccessRight": { "put": { "tags": [ "BamObjectMethods" ], "operationId": "updateAccessRight", "description": "The parameters and request body are for method: updateAccessRight. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "overrides", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/updateConfigurationSetting": { "put": { "tags": [ "BamObjectMethods" ], "operationId": "updateConfigurationSetting", "description": "The parameters and request body are for method: updateConfigurationSetting. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "settingName", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/updateUserPassword": { "put": { "tags": [ "BamObjectMethods" ], "operationId": "updateUserPassword", "description": "The parameters and request body are for method: updateUserPassword. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "newPassword", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addAdditionalIPAddresses": { "post": { "tags": [ "IpamMethods" ], "operationId": "addAdditionalIPAddresses", "description": "The parameters and request body are for method: addAdditionalIPAddresses. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "ipsToAdd", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDeviceInstance": { "post": { "tags": [ "IpamMethods" ], "operationId": "addDeviceInstance", "description": "The parameters and request body are for method: addDeviceInstance. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "deviceName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ipAddressMode", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ipEntity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "macAddressMode", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "macEntity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "recordName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "viewName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "zoneName", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addIP4BlockByCIDR": { "post": { "tags": [ "IpamMethods" ], "operationId": "addIP4BlockByCIDR", "description": "The parameters and request body are for method: addIP4BlockByCIDR. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "cIDR", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addIP4BlockByRange": { "post": { "tags": [ "IpamMethods" ], "operationId": "addIP4BlockByRange", "description": "The parameters and request body are for method: addIP4BlockByRange. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "end", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addIP4IPGroupByRange": { "post": { "tags": [ "IpamMethods" ], "operationId": "addIP4IPGroupByRange", "description": "The parameters and request body are for method: addIP4IPGroupByRange. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "end", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addIP4IPGroupBySize": { "post": { "tags": [ "IpamMethods" ], "operationId": "addIP4IPGroupBySize", "description": "The parameters and request body are for method: addIP4IPGroupBySize. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "positionRangeBy", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "positionValue", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addIP4Network": { "post": { "tags": [ "IpamMethods" ], "operationId": "addIP4Network", "description": "The parameters and request body are for method: addIP4Network. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "cIDR", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "blockId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addIP4NetworkTemplate": { "post": { "tags": [ "IpamMethods" ], "operationId": "addIP4NetworkTemplate", "description": "The parameters and request body are for method: addIP4NetworkTemplate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addIP4ReconciliationPolicy": { "post": { "tags": [ "IpamMethods" ], "operationId": "addIP4ReconciliationPolicy", "description": "The parameters and request body are for method: addIP4ReconciliationPolicy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addIP6Address": { "post": { "tags": [ "IpamMethods" ], "operationId": "addIP6Address", "description": "The parameters and request body are for method: addIP6Address. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "address", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "containerId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addIP6BlockByMACAddress": { "post": { "tags": [ "IpamMethods" ], "operationId": "addIP6BlockByMACAddress", "description": "The parameters and request body are for method: addIP6BlockByMACAddress. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "macAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addIP6BlockByPrefix": { "post": { "tags": [ "IpamMethods" ], "operationId": "addIP6BlockByPrefix", "description": "The parameters and request body are for method: addIP6BlockByPrefix. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "prefix", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addIP6NetworkByPrefix": { "post": { "tags": [ "IpamMethods" ], "operationId": "addIP6NetworkByPrefix", "description": "The parameters and request body are for method: addIP6NetworkByPrefix. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "prefix", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addParentBlock": { "post": { "tags": [ "IpamMethods" ], "operationId": "addParentBlock", "description": "The parameters and request body are for method: addParentBlock. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/addParentBlockWithProperties": { "post": { "tags": [ "IpamMethods" ], "operationId": "addParentBlockWithProperties", "description": "The parameters and request body are for method: addParentBlockWithProperties. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/applyIP4NetworkTemplate": { "post": { "tags": [ "IpamMethods" ], "operationId": "applyIP4NetworkTemplate", "description": "The parameters and request body are for method: applyIP4NetworkTemplate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "networkId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/assignIP4Address": { "post": { "tags": [ "IpamMethods" ], "operationId": "assignIP4Address", "description": "The parameters and request body are for method: assignIP4Address. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "action", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "hostInfo", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ip4Address", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "macAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/assignIP4NetworkTemplate": { "post": { "tags": [ "IpamMethods" ], "operationId": "assignIP4NetworkTemplate", "description": "The parameters and request body are for method: assignIP4NetworkTemplate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "networkId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/assignIP6Address": { "post": { "tags": [ "IpamMethods" ], "operationId": "assignIP6Address", "description": "The parameters and request body are for method: assignIP6Address. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "action", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "address", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "containerId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "hostInfo", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "macAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/assignNextAvailableIP4Address": { "post": { "tags": [ "IpamMethods" ], "operationId": "assignNextAvailableIP4Address", "description": "The parameters and request body are for method: assignNextAvailableIP4Address. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 9, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "action", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "hostInfo", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "macAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/changeStateIP4Address": { "put": { "tags": [ "IpamMethods" ], "operationId": "changeStateIP4Address", "description": "The parameters and request body are for method: changeStateIP4Address. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "addressId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "macAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "targetState", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/clearIP6Address": { "delete": { "tags": [ "IpamMethods" ], "operationId": "clearIP6Address", "description": "The parameters and request body are for method: clearIP6Address. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "addressId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deleteDeviceInstance": { "delete": { "tags": [ "IpamMethods" ], "operationId": "deleteDeviceInstance", "description": "The parameters and request body are for method: deleteDeviceInstance. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getAdditionalIPAddresses": { "get": { "tags": [ "IpamMethods" ], "operationId": "getAdditionalIPAddresses", "description": "The parameters and request body are for method: getAdditionalIPAddresses. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "adonisID", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getAliasesByHint": { "get": { "tags": [ "IpamMethods" ], "operationId": "getAliasesByHint", "description": "The parameters and request body are for method: getAliasesByHint. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDiscoveredDevice": { "get": { "tags": [ "IpamMethods" ], "operationId": "getDiscoveredDevice", "description": "The parameters and request body are for method: getDiscoveredDevice. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 10, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDiscoveredDeviceArpEntries": { "get": { "tags": [ "IpamMethods" ], "operationId": "getDiscoveredDeviceArpEntries", "description": "The parameters and request body are for method: getDiscoveredDeviceArpEntries. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDiscoveredDeviceHosts": { "get": { "tags": [ "IpamMethods" ], "operationId": "getDiscoveredDeviceHosts", "description": "The parameters and request body are for method: getDiscoveredDeviceHosts. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDiscoveredDeviceInterfaces": { "get": { "tags": [ "IpamMethods" ], "operationId": "getDiscoveredDeviceInterfaces", "description": "The parameters and request body are for method: getDiscoveredDeviceInterfaces. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDiscoveredDeviceMacAddressEntries": { "get": { "tags": [ "IpamMethods" ], "operationId": "getDiscoveredDeviceMacAddressEntries", "description": "The parameters and request body are for method: getDiscoveredDeviceMacAddressEntries. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDiscoveredDeviceNetworks": { "get": { "tags": [ "IpamMethods" ], "operationId": "getDiscoveredDeviceNetworks", "description": "The parameters and request body are for method: getDiscoveredDeviceNetworks. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDiscoveredDeviceVlans": { "get": { "tags": [ "IpamMethods" ], "operationId": "getDiscoveredDeviceVlans", "description": "The parameters and request body are for method: getDiscoveredDeviceVlans. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDiscoveredDevices": { "get": { "tags": [ "IpamMethods" ], "operationId": "getDiscoveredDevices", "description": "The parameters and request body are for method: getDiscoveredDevices. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "policyId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getIP4Address": { "get": { "tags": [ "IpamMethods" ], "operationId": "getIP4Address", "description": "The parameters and request body are for method: getIP4Address. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 1, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "address", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "containerId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getIP4NetworksByHint": { "get": { "tags": [ "IpamMethods" ], "operationId": "getIP4NetworksByHint", "description": "The parameters and request body are for method: getIP4NetworksByHint. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "containerId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getIP6Address": { "get": { "tags": [ "IpamMethods" ], "operationId": "getIP6Address", "description": "The parameters and request body are for method: getIP6Address. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 7, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "address", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "containerId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getIP6ObjectsByHint": { "get": { "tags": [ "IpamMethods" ], "operationId": "getIP6ObjectsByHint", "description": "The parameters and request body are for method: getIP6ObjectsByHint. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "containerId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "objectType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getIPRangedByIP": { "get": { "tags": [ "IpamMethods" ], "operationId": "getIPRangedByIP", "description": "The parameters and request body are for method: getIPRangedByIP. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 8, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "address", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "containerId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getLinkedNetworkConflicts": { "get": { "tags": [ "IpamMethods" ], "operationId": "getLinkedNetworkConflicts", "description": "The parameters and request body are for method: getLinkedNetworkConflicts. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "networkId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getMaxAllowedRange": { "get": { "tags": [ "IpamMethods" ], "operationId": "getMaxAllowedRange", "description": "The parameters and request body are for method: getMaxAllowedRange. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "string", "string", "string", "string" ] } } } }, "parameters": [ { "name": "rangeId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getNextAvailableIP4Address": { "get": { "tags": [ "IpamMethods" ], "operationId": "getNextAvailableIP4Address", "description": "The parameters and request body are for method: getNextAvailableIP4Address. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getNextAvailableIP4Network": { "get": { "tags": [ "IpamMethods" ], "operationId": "getNextAvailableIP4Network", "description": "The parameters and request body are for method: getNextAvailableIP4Network. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "autoCreate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "isLargerAllowed", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getNextAvailableIP6Address": { "get": { "tags": [ "IpamMethods" ], "operationId": "getNextAvailableIP6Address", "description": "The parameters and request body are for method: getNextAvailableIP6Address. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getNextAvailableIPRange": { "get": { "tags": [ "IpamMethods" ], "operationId": "getNextAvailableIPRange", "description": "The parameters and request body are for method: getNextAvailableIPRange. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 8, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getNextAvailableIPRanges": { "get": { "tags": [ "IpamMethods" ], "operationId": "getNextAvailableIPRanges", "description": "The parameters and request body are for method: getNextAvailableIPRanges. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getNextIP4Address": { "get": { "tags": [ "IpamMethods" ], "operationId": "getNextIP4Address", "description": "The parameters and request body are for method: getNextIP4Address. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getTemplateTaskStatus": { "get": { "tags": [ "IpamMethods" ], "operationId": "getTemplateTaskStatus", "description": "The parameters and request body are for method: getTemplateTaskStatus. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "taskId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/isAddressAllocated": { "get": { "tags": [ "IpamMethods" ], "operationId": "isAddressAllocated", "description": "The parameters and request body are for method: isAddressAllocated. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "ipAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "macAddress", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/mergeBlocksWithParent": { "post": { "tags": [ "IpamMethods" ], "operationId": "mergeBlocksWithParent", "description": "The parameters and request body are for method: mergeBlocksWithParent. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/mergeSelectedBlocksOrNetworks": { "post": { "tags": [ "IpamMethods" ], "operationId": "mergeSelectedBlocksOrNetworks", "description": "The parameters and request body are for method: mergeSelectedBlocksOrNetworks. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "blockOrNetworkToKeep", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/moveIPObject": { "put": { "tags": [ "IpamMethods" ], "operationId": "moveIPObject", "description": "The parameters and request body are for method: moveIPObject. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "address", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "objectId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/reapplyTemplate": { "post": { "tags": [ "IpamMethods" ], "operationId": "reapplyTemplate", "description": "The parameters and request body are for method: reapplyTemplate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/reassignIP6Address": { "post": { "tags": [ "IpamMethods" ], "operationId": "reassignIP6Address", "description": "The parameters and request body are for method: reassignIP6Address. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "destination", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "oldAddressId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/removeAdditionalIPAddresses": { "delete": { "tags": [ "IpamMethods" ], "operationId": "removeAdditionalIPAddresses", "description": "The parameters and request body are for method: removeAdditionalIPAddresses. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "ipsToRemove", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/resizeRange": { "put": { "tags": [ "IpamMethods" ], "operationId": "resizeRange", "description": "The parameters and request body are for method: resizeRange. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "objectId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/splitIP4Network": { "post": { "tags": [ "IpamMethods" ], "operationId": "splitIP4Network", "description": "The parameters and request body are for method: splitIP4Network. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "networkId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "numberOfParts", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/splitIP6Range": { "post": { "tags": [ "IpamMethods" ], "operationId": "splitIP6Range", "description": "The parameters and request body are for method: splitIP6Range. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "numberOfParts", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "rangeId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/unassignIP4NetworkTemplate": { "post": { "tags": [ "IpamMethods" ], "operationId": "unassignIP4NetworkTemplate", "description": "The parameters and request body are for method: unassignIP4NetworkTemplate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "networkId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addCustomOptionDefinition": { "post": { "tags": [ "DhcpMethods" ], "operationId": "addCustomOptionDefinition", "description": "The parameters and request body are for method: addCustomOptionDefinition. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "allowMultiple", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "optionId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "optionType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDHCP4Range": { "post": { "tags": [ "DhcpMethods" ], "operationId": "addDHCP4Range", "description": "The parameters and request body are for method: addDHCP4Range. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "end", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "networkId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDHCP4RangeBySize": { "post": { "tags": [ "DhcpMethods" ], "operationId": "addDHCP4RangeBySize", "description": "The parameters and request body are for method: addDHCP4RangeBySize. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "networkId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDHCP6ClientDeploymentOption": { "post": { "tags": [ "DhcpMethods" ], "operationId": "addDHCP6ClientDeploymentOption", "description": "The parameters and request body are for method: addDHCP6ClientDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDHCP6Range": { "post": { "tags": [ "DhcpMethods" ], "operationId": "addDHCP6Range", "description": "The parameters and request body are for method: addDHCP6Range. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "end", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "networkId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDHCP6RangeBySize": { "post": { "tags": [ "DhcpMethods" ], "operationId": "addDHCP6RangeBySize", "description": "The parameters and request body are for method: addDHCP6RangeBySize. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "networkId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDHCP6ServiceDeploymentOption": { "post": { "tags": [ "DhcpMethods" ], "operationId": "addDHCP6ServiceDeploymentOption", "description": "The parameters and request body are for method: addDHCP6ServiceDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDHCPClientDeploymentOption": { "post": { "tags": [ "DhcpMethods" ], "operationId": "addDHCPClientDeploymentOption", "description": "The parameters and request body are for method: addDHCPClientDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDHCPMatchClass": { "post": { "tags": [ "DhcpMethods" ], "operationId": "addDHCPMatchClass", "description": "The parameters and request body are for method: addDHCPMatchClass. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "matchCriteria", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDHCPServiceDeploymentOption": { "post": { "tags": [ "DhcpMethods" ], "operationId": "addDHCPServiceDeploymentOption", "description": "The parameters and request body are for method: addDHCPServiceDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDHCPSubClass": { "post": { "tags": [ "DhcpMethods" ], "operationId": "addDHCPSubClass", "description": "The parameters and request body are for method: addDHCPSubClass. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "matchClassId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "matchValue", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDHCPVendorDeploymentOption": { "post": { "tags": [ "DhcpMethods" ], "operationId": "addDHCPVendorDeploymentOption", "description": "The parameters and request body are for method: addDHCPVendorDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "optionId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addVendorOptionDefinition": { "post": { "tags": [ "DhcpMethods" ], "operationId": "addVendorOptionDefinition", "description": "The parameters and request body are for method: addVendorOptionDefinition. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "allowMultiple", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "optionId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "optionType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "vendorProfileId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addVendorProfile": { "post": { "tags": [ "DhcpMethods" ], "operationId": "addVendorProfile", "description": "The parameters and request body are for method: addVendorProfile. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "description", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deleteDHCP6ClientDeploymentOption": { "delete": { "tags": [ "DhcpMethods" ], "operationId": "deleteDHCP6ClientDeploymentOption", "description": "The parameters and request body are for method: deleteDHCP6ClientDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deleteDHCP6ServiceDeploymentOption": { "delete": { "tags": [ "DhcpMethods" ], "operationId": "deleteDHCP6ServiceDeploymentOption", "description": "The parameters and request body are for method: deleteDHCP6ServiceDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deleteDHCPClientDeploymentOption": { "delete": { "tags": [ "DhcpMethods" ], "operationId": "deleteDHCPClientDeploymentOption", "description": "The parameters and request body are for method: deleteDHCPClientDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deleteDHCPServiceDeploymentOption": { "delete": { "tags": [ "DhcpMethods" ], "operationId": "deleteDHCPServiceDeploymentOption", "description": "The parameters and request body are for method: deleteDHCPServiceDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deleteDHCPVendorDeploymentOption": { "delete": { "tags": [ "DhcpMethods" ], "operationId": "deleteDHCPVendorDeploymentOption", "description": "The parameters and request body are for method: deleteDHCPVendorDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "optionId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDHCP6ClientDeploymentOption": { "get": { "tags": [ "DhcpMethods" ], "operationId": "getDHCP6ClientDeploymentOption", "description": "The parameters and request body are for method: getDHCP6ClientDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 2, "type": "string", "name": "string", "value": "string", "properties": "string" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDHCP6ServiceDeploymentOption": { "get": { "tags": [ "DhcpMethods" ], "operationId": "getDHCP6ServiceDeploymentOption", "description": "The parameters and request body are for method: getDHCP6ServiceDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 2, "type": "string", "name": "string", "value": "string", "properties": "string" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDHCPClientDeploymentOption": { "get": { "tags": [ "DhcpMethods" ], "operationId": "getDHCPClientDeploymentOption", "description": "The parameters and request body are for method: getDHCPClientDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 5, "type": "string", "name": "string", "value": "string", "properties": "string" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDHCPServiceDeploymentOption": { "get": { "tags": [ "DhcpMethods" ], "operationId": "getDHCPServiceDeploymentOption", "description": "The parameters and request body are for method: getDHCPServiceDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 10, "type": "string", "name": "string", "value": "string", "properties": "string" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDHCPVendorDeploymentOption": { "get": { "tags": [ "DhcpMethods" ], "operationId": "getDHCPVendorDeploymentOption", "description": "The parameters and request body are for method: getDHCPVendorDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 4, "type": "string", "name": "string", "value": "string", "properties": "string" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "optionId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getSharedNetworks": { "get": { "tags": [ "DhcpMethods" ], "operationId": "getSharedNetworks", "description": "The parameters and request body are for method: getSharedNetworks. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "tagId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/shareNetwork": { "put": { "tags": [ "DhcpMethods" ], "operationId": "shareNetwork", "description": "The parameters and request body are for method: shareNetwork. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "networkId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "tagId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/unshareNetwork": { "put": { "tags": [ "DhcpMethods" ], "operationId": "unshareNetwork", "description": "The parameters and request body are for method: unshareNetwork. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "networkId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/updateDHCP6ClientDeploymentOption": { "put": { "tags": [ "DhcpMethods" ], "operationId": "updateDHCP6ClientDeploymentOption", "description": "The parameters and request body are for method: updateDHCP6ClientDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/updateDHCP6ServiceDeploymentOption": { "put": { "tags": [ "DhcpMethods" ], "operationId": "updateDHCP6ServiceDeploymentOption", "description": "The parameters and request body are for method: updateDHCP6ServiceDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/updateDHCPClientDeploymentOption": { "put": { "tags": [ "DhcpMethods" ], "operationId": "updateDHCPClientDeploymentOption", "description": "The parameters and request body are for method: updateDHCPClientDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/updateDHCPServiceDeploymentOption": { "put": { "tags": [ "DhcpMethods" ], "operationId": "updateDHCPServiceDeploymentOption", "description": "The parameters and request body are for method: updateDHCPServiceDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/updateDHCPVendorDeploymentOption": { "put": { "tags": [ "DhcpMethods" ], "operationId": "updateDHCPVendorDeploymentOption", "description": "The parameters and request body are for method: updateDHCPVendorDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/addDHCPDeploymentRole": { "post": { "tags": [ "ServerDeploymentMethods" ], "operationId": "addDHCPDeploymentRole", "description": "The parameters and request body are for method: addDHCPDeploymentRole. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverInterfaceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addDNSDeploymentRole": { "post": { "tags": [ "ServerDeploymentMethods" ], "operationId": "addDNSDeploymentRole", "description": "The parameters and request body are for method: addDNSDeploymentRole. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverInterfaceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addServer": { "post": { "tags": [ "ServerDeploymentMethods" ], "operationId": "addServer", "description": "The parameters and request body are for method: addServer. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "defaultInterfaceAddress", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "fullHostName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "profile", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addTFTPDeploymentRole": { "post": { "tags": [ "ServerDeploymentMethods" ], "operationId": "addTFTPDeploymentRole", "description": "The parameters and request body are for method: addTFTPDeploymentRole. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deleteDHCPDeploymentRole": { "delete": { "tags": [ "ServerDeploymentMethods" ], "operationId": "deleteDHCPDeploymentRole", "description": "The parameters and request body are for method: deleteDHCPDeploymentRole. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverInterfaceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deleteDNSDeploymentRole": { "delete": { "tags": [ "ServerDeploymentMethods" ], "operationId": "deleteDNSDeploymentRole", "description": "The parameters and request body are for method: deleteDNSDeploymentRole. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverInterfaceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deleteDNSDeploymentRoleForView": { "delete": { "tags": [ "ServerDeploymentMethods" ], "operationId": "deleteDNSDeploymentRoleForView", "description": "The parameters and request body are for method: deleteDNSDeploymentRoleForView. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverInterfaceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deployServer": { "post": { "tags": [ "ServerDeploymentMethods" ], "operationId": "deployServer", "description": "The parameters and request body are for method: deployServer. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deployServerConfig": { "post": { "tags": [ "ServerDeploymentMethods" ], "operationId": "deployServerConfig", "description": "The parameters and request body are for method: deployServerConfig. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deployServerServices": { "post": { "tags": [ "ServerDeploymentMethods" ], "operationId": "deployServerServices", "description": "The parameters and request body are for method: deployServerServices. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "services", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDHCPDeploymentRole": { "get": { "tags": [ "ServerDeploymentMethods" ], "operationId": "getDHCPDeploymentRole", "description": "The parameters and request body are for method: getDHCPDeploymentRole. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "service": { "type": "string" }, "entityId": { "type": "number" }, "serverInterfaceId": { "type": "number" }, "properties": { "type": "string" } } }, "example": { "id": 8, "type": "string", "service": "string", "entityId": 7, "serverInterfaceId": 10, "properties": "string" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverInterfaceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDNSDeploymentRole": { "get": { "tags": [ "ServerDeploymentMethods" ], "operationId": "getDNSDeploymentRole", "description": "The parameters and request body are for method: getDNSDeploymentRole. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "service": { "type": "string" }, "entityId": { "type": "number" }, "serverInterfaceId": { "type": "number" }, "properties": { "type": "string" } } }, "example": { "id": 10, "type": "string", "service": "string", "entityId": 7, "serverInterfaceId": 7, "properties": "string" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverInterfaceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDNSDeploymentRoleForView": { "get": { "tags": [ "ServerDeploymentMethods" ], "operationId": "getDNSDeploymentRoleForView", "description": "The parameters and request body are for method: getDNSDeploymentRoleForView. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "service": { "type": "string" }, "entityId": { "type": "number" }, "serverInterfaceId": { "type": "number" }, "properties": { "type": "string" } } }, "example": { "id": 6, "type": "string", "service": "string", "entityId": 6, "serverInterfaceId": 3, "properties": "string" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverInterfaceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "viewId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDeploymentRoles": { "get": { "tags": [ "ServerDeploymentMethods" ], "operationId": "getDeploymentRoles", "description": "The parameters and request body are for method: getDeploymentRoles. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "service": { "type": "string" }, "entityId": { "type": "number" }, "serverInterfaceId": { "type": "number" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "type": "...", "service": "...", "entityId": 12345, "serverInterfaceId": 12345, "properties": "..." }, { "id": 12345, "type": "...", "service": "...", "entityId": 12345, "serverInterfaceId": 12345, "properties": "..." } ] } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getDeploymentTaskStatus": { "get": { "tags": [ "ServerDeploymentMethods" ], "operationId": "getDeploymentTaskStatus", "description": "The parameters and request body are for method: getDeploymentTaskStatus. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deploymentTaskToken", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getServerDeploymentRoles": { "get": { "tags": [ "ServerDeploymentMethods" ], "operationId": "getServerDeploymentRoles", "description": "The parameters and request body are for method: getServerDeploymentRoles. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "service": { "type": "string" }, "entityId": { "type": "number" }, "serverInterfaceId": { "type": "number" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "type": "...", "service": "...", "entityId": 12345, "serverInterfaceId": 12345, "properties": "..." }, { "id": 12345, "type": "...", "service": "...", "entityId": 12345, "serverInterfaceId": 12345, "properties": "..." }, { "id": 12345, "type": "...", "service": "...", "entityId": 12345, "serverInterfaceId": 12345, "properties": "..." }, { "id": 12345, "type": "...", "service": "...", "entityId": 12345, "serverInterfaceId": 12345, "properties": "..." } ] } } } }, "parameters": [ { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getServerDeploymentStatus": { "get": { "tags": [ "ServerDeploymentMethods" ], "operationId": "getServerDeploymentStatus", "description": "The parameters and request body are for method: getServerDeploymentStatus. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getServerForRole": { "get": { "tags": [ "ServerDeploymentMethods" ], "operationId": "getServerForRole", "description": "The parameters and request body are for method: getServerForRole. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 6, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "roleId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/moveDeploymentRoles": { "put": { "tags": [ "ServerDeploymentMethods" ], "operationId": "moveDeploymentRoles", "description": "The parameters and request body are for method: moveDeploymentRoles. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "moveDhcpRoles", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "moveDnsRoles", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sourceServerId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "targetServerInterfaceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/quickDeploy": { "post": { "tags": [ "ServerDeploymentMethods" ], "operationId": "quickDeploy", "description": "The parameters and request body are for method: quickDeploy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/replaceServer": { "put": { "tags": [ "ServerDeploymentMethods" ], "operationId": "replaceServer", "description": "The parameters and request body are for method: replaceServer. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "defaultInterface", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "hostName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "password", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "upgrade", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/selectiveDeploy": { "post": { "tags": [ "ServerDeploymentMethods" ], "operationId": "selectiveDeploy", "description": "The parameters and request body are for method: selectiveDeploy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/updateDHCPDeploymentRole": { "put": { "tags": [ "ServerDeploymentMethods" ], "operationId": "updateDHCPDeploymentRole", "description": "The parameters and request body are for method: updateDHCPDeploymentRole. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/updateDNSDeploymentRole": { "put": { "tags": [ "ServerDeploymentMethods" ], "operationId": "updateDNSDeploymentRole", "description": "The parameters and request body are for method: updateDNSDeploymentRole. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/addEntity": { "post": { "tags": [ "GenericMethods" ], "operationId": "addEntity", "description": "The parameters and request body are for method: addEntity. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/assignOrUpdateTemplate": { "post": { "tags": [ "GenericMethods" ], "operationId": "assignOrUpdateTemplate", "description": "The parameters and request body are for method: assignOrUpdateTemplate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "templateId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/customSearch": { "get": { "tags": [ "GenericMethods" ], "operationId": "customSearch", "description": "The parameters and request body are for method: customSearch. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/delete": { "delete": { "tags": [ "GenericMethods" ], "operationId": "delete", "description": "The parameters and request body are for method: delete. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "objectId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/deleteWithOptions": { "delete": { "tags": [ "GenericMethods" ], "operationId": "deleteWithOptions", "description": "The parameters and request body are for method: deleteWithOptions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "objectId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getEntities": { "get": { "tags": [ "GenericMethods" ], "operationId": "getEntities", "description": "The parameters and request body are for method: getEntities. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getEntitiesByName": { "get": { "tags": [ "GenericMethods" ], "operationId": "getEntitiesByName", "description": "The parameters and request body are for method: getEntitiesByName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getEntitiesByNameUsingOptions": { "get": { "tags": [ "GenericMethods" ], "operationId": "getEntitiesByNameUsingOptions", "description": "The parameters and request body are for method: getEntitiesByNameUsingOptions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getEntityByCIDR": { "get": { "tags": [ "GenericMethods" ], "operationId": "getEntityByCIDR", "description": "The parameters and request body are for method: getEntityByCIDR. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 1, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "cidr", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getEntityById": { "get": { "tags": [ "GenericMethods" ], "operationId": "getEntityById", "description": "The parameters and request body are for method: getEntityById. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 10, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getEntityByName": { "get": { "tags": [ "GenericMethods" ], "operationId": "getEntityByName", "description": "The parameters and request body are for method: getEntityByName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 8, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getEntityByPrefix": { "get": { "tags": [ "GenericMethods" ], "operationId": "getEntityByPrefix", "description": "The parameters and request body are for method: getEntityByPrefix. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 8, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "containerId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "prefix", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getEntityByRange": { "get": { "tags": [ "GenericMethods" ], "operationId": "getEntityByRange", "description": "The parameters and request body are for method: getEntityByRange. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 4, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "address1", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "address2", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getLinkedEntities": { "get": { "tags": [ "GenericMethods" ], "operationId": "getLinkedEntities", "description": "The parameters and request body are for method: getLinkedEntities. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getParent": { "get": { "tags": [ "GenericMethods" ], "operationId": "getParent", "description": "The parameters and request body are for method: getParent. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "id": 9, "name": "string", "type": "string", "properties": "string" } } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getSystemInfo": { "get": { "tags": [ "GenericMethods" ], "operationId": "getSystemInfo", "description": "The parameters and request body are for method: getSystemInfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/linkEntities": { "put": { "tags": [ "GenericMethods" ], "operationId": "linkEntities", "description": "The parameters and request body are for method: linkEntities. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entity1Id", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "entity2Id", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/login": { "get": { "tags": [ "GenericMethods" ], "operationId": "login", "description": "The parameters and request body are for method: login. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "password", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/loginWithOptions": { "get": { "tags": [ "GenericMethods" ], "operationId": "loginWithOptions", "description": "The parameters and request body are for method: loginWithOptions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "password", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/logout": { "get": { "tags": [ "GenericMethods" ], "operationId": "logout", "description": "The parameters and request body are for method: logout. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/searchByCategory": { "get": { "tags": [ "GenericMethods" ], "operationId": "searchByCategory", "description": "The parameters and request body are for method: searchByCategory. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "category", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/searchByObjectTypes": { "get": { "tags": [ "GenericMethods" ], "operationId": "searchByObjectTypes", "description": "The parameters and request body are for method: searchByObjectTypes. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "name": "...", "type": "...", "properties": "..." }, { "id": 12345, "name": "...", "type": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "types", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/unlinkEntities": { "put": { "tags": [ "GenericMethods" ], "operationId": "unlinkEntities", "description": "The parameters and request body are for method: unlinkEntities. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entity1Id", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "entity2Id", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/update": { "put": { "tags": [ "GenericMethods" ], "operationId": "update", "description": "The parameters and request body are for method: update. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/updateWithOptions": { "put": { "tags": [ "GenericMethods" ], "operationId": "updateWithOptions", "description": "The parameters and request body are for method: updateWithOptions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "options", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/addRawDeploymentOption": { "post": { "tags": [ "GenericDeploymentOptionMethods" ], "operationId": "addRawDeploymentOption", "description": "The parameters and request body are for method: addRawDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/getDeploymentOptions": { "get": { "tags": [ "GenericDeploymentOptionMethods" ], "operationId": "getDeploymentOptions", "description": "The parameters and request body are for method: getDeploymentOptions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "string" } } } }, "example": [ { "id": 12345, "type": "...", "name": "...", "value": "...", "properties": "..." }, { "id": 12345, "type": "...", "name": "...", "value": "...", "properties": "..." } ] } } } }, "parameters": [ { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "optionTypes", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serverId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/updateRawDeploymentOption": { "put": { "tags": [ "GenericDeploymentOptionMethods" ], "operationId": "updateRawDeploymentOption", "description": "The parameters and request body are for method: updateRawDeploymentOption. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/addTFTPFile": { "post": { "tags": [ "TftpMethods" ], "operationId": "addTFTPFile", "description": "The parameters and request body are for method: addTFTPFile. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } } }, "/v1/addTFTPFolder": { "post": { "tags": [ "TftpMethods" ], "operationId": "addTFTPFolder", "description": "The parameters and request body are for method: addTFTPFolder. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addTFTPGroup": { "post": { "tags": [ "TftpMethods" ], "operationId": "addTFTPGroup", "description": "The parameters and request body are for method: addTFTPGroup. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/addUserDefinedField": { "post": { "tags": [ "UdfMethods" ], "operationId": "addUserDefinedField", "description": "The parameters and request body are for method: addUserDefinedField. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/deleteUserDefinedField": { "delete": { "tags": [ "UdfMethods" ], "operationId": "deleteUserDefinedField", "description": "The parameters and request body are for method: deleteUserDefinedField. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getUserDefinedFields": { "get": { "tags": [ "UdfMethods" ], "operationId": "getUserDefinedFields", "description": "The parameters and request body are for method: getUserDefinedFields. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "displayName": { "type": "string" }, "type": { "type": "string" }, "defaultValue": { "type": "string" }, "validatorProperties": { "type": "string" }, "properties": { "type": "string" }, "predefinedValues": { "type": "string" }, "required": { "type": "boolean" }, "hideFromSearch": { "type": "boolean" } } } }, "example": [ { "name": "...", "displayName": "...", "type": "...", "defaultValue": "...", "validatorProperties": "...", "properties": "...", "predefinedValues": "...", "required": true, "hideFromSearch": true }, { "name": "...", "displayName": "...", "type": "...", "defaultValue": "...", "validatorProperties": "...", "properties": "...", "predefinedValues": "...", "required": true, "hideFromSearch": true }, { "name": "...", "displayName": "...", "type": "...", "defaultValue": "...", "validatorProperties": "...", "properties": "...", "predefinedValues": "...", "required": true, "hideFromSearch": true } ] } } } }, "parameters": [ { "name": "requiredFieldsOnly", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/updateBulkUdf": { "post": { "tags": [ "UdfMethods" ], "operationId": "updateBulkUdf", "description": "The parameters and request body are for method: updateBulkUdf. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "number" } }, "example": [ 8, 2, 4, 6 ] } } } }, "parameters": [ { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string" } } }, "example": { "body": "body" } } } } } }, "/v1/updateUserDefinedField": { "put": { "tags": [ "UdfMethods" ], "operationId": "updateUserDefinedField", "description": "The parameters and request body are for method: updateUserDefinedField. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/breakXHAPair": { "post": { "tags": [ "XhaMethods" ], "operationId": "breakXHAPair", "description": "The parameters and request body are for method: breakXHAPair. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "breakInProteusOnly", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "xHAServerId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/createXHAPair": { "post": { "tags": [ "XhaMethods" ], "operationId": "createXHAPair", "description": "The parameters and request body are for method: createXHAPair. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "activeServerId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "activeServerNewIPv4Address", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "passiveServerId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/editXHAPair": { "put": { "tags": [ "XhaMethods" ], "operationId": "editXHAPair", "description": "The parameters and request body are for method: editXHAPair. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "xHAServerId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/failoverXHA": { "put": { "tags": [ "XhaMethods" ], "operationId": "failoverXHA", "description": "The parameters and request body are for method: failoverXHA. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "xHAServerId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/cleanBrokenTrustRelationship": { "post": { "tags": [ "Undocumented" ], "operationId": "cleanBrokenTrustRelationship", "description": "The parameters and request body are for method: cleanBrokenTrustRelationship. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "ipsToRemove", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/configureReplication": { "post": { "tags": [ "Undocumented" ], "operationId": "configureReplication", "description": "The parameters and request body are for method: configureReplication. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "compressReplication", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "replicationBreakThreshold", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "replicationQueueThreshold", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "standbyServer", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/exchangeKeyBundles": { "post": { "tags": [ "Undocumented" ], "operationId": "exchangeKeyBundles", "description": "The parameters and request body are for method: exchangeKeyBundles. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "IP": { "type": "string" }, "ip": { "type": "string" }, "sshUser": { "type": "string" }, "hostPublicKey": { "type": "string" }, "hostPublicKeyGeneratedTimestamp": { "type": "number" }, "userPublicKey": { "type": "string" }, "userPublicKeyGeneratedTimestamp": { "type": "number" } } } }, "example": [ { "IP": "...", "ip": "...", "sshUser": "...", "hostPublicKey": "...", "hostPublicKeyGeneratedTimestamp": 12345, "userPublicKey": "...", "userPublicKeyGeneratedTimestamp": 12345 }, { "IP": "...", "ip": "...", "sshUser": "...", "hostPublicKey": "...", "hostPublicKeyGeneratedTimestamp": 12345, "userPublicKey": "...", "userPublicKeyGeneratedTimestamp": 12345 }, { "IP": "...", "ip": "...", "sshUser": "...", "hostPublicKey": "...", "hostPublicKeyGeneratedTimestamp": 12345, "userPublicKey": "...", "userPublicKeyGeneratedTimestamp": 12345 }, { "IP": "...", "ip": "...", "sshUser": "...", "hostPublicKey": "...", "hostPublicKeyGeneratedTimestamp": 12345, "userPublicKey": "...", "userPublicKeyGeneratedTimestamp": 12345 } ] } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/moveIP4Object": { "put": { "tags": [ "Undocumented" ], "operationId": "moveIP4Object", "description": "The parameters and request body are for method: moveIP4Object. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "address", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "objectId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getProbeData": { "get": { "tags": [ "DataCollectionMethods" ], "operationId": "getProbeData", "description": "The parameters and request body are for method: getProbeData. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "properties": { "type": "string" } } }, "example": { "name": "string", "properties": "string" } } } } }, "parameters": [ { "name": "definedProbe", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/getProbeStatus": { "get": { "tags": [ "DataCollectionMethods" ], "operationId": "getProbeStatus", "description": "The parameters and request body are for method: getProbeStatus. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "definedProbe", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/startProbe": { "put": { "tags": [ "DataCollectionMethods" ], "operationId": "startProbe", "description": "The parameters and request body are for method: startProbe. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "definedProbe", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/isMigrationRunning": { "get": { "tags": [ "MigrationMethods" ], "operationId": "isMigrationRunning", "description": "The parameters and request body are for method: isMigrationRunning. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "filename", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/migrateFile": { "post": { "tags": [ "MigrationMethods" ], "operationId": "migrateFile", "description": "The parameters and request body are for method: migrateFile. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "filename", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } } }, "components": { "schemas": {} } }