UNPKG

@itentialopensource/adapter-bluecat

Version:

This adapter integrates with system described as: BlueCat ProteusAPI.

2,038 lines 382 kB
{ "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: getNetworkLinkedProper