{ "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "http", "https" ], "swagger": "2.0", "info": { "description": "The WAPI Portal provides access to the DNS Application, a Universal DDI service that is authoritative for all DNS resource records and acts as a primary DNS server", "title": "DNS Data Web API", "version": "v3" }, "basePath": "/wapi/v3/", "paths": { "/record:a": { "get": { "description": "Use this method to retrieve __RecordA__ objects.", "tags": [ "record:a" ], "summary": "Retrieve RecordA objects.", "operationId": "record:aList", "parameters": [ { "type": "string", "description": "infoblox.ddi.wapi.paging", "name": "paging", "in": "query" }, { "type": "string", "description": "infoblox.ddi.wapi.options", "name": "options", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3ListRecordAResponse" } } } }, "post": { "description": "Use this method to create a __RecordA__ object.", "tags": [ "record:a" ], "summary": "Create a RecordA object.", "operationId": "record:aCreate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordA" } } ], "responses": { "201": { "description": "POST operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:a/{payload.ref.ref_data}/**": { "put": { "description": "Use this method to update the __RecordA__ object.", "tags": [ "record:a" ], "summary": "Update the RecordA object.", "operationId": "record:aUpdate", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "payload.ref.ref_data", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordA" } } ], "responses": { "200": { "description": "PUT operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:a/{ref.ref_data}/**": { "get": { "description": "Use this method to retrieve the __RecordA__ object.", "tags": [ "record:a" ], "summary": "Retrieve the RecordA object.", "operationId": "record:aRead", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" }, { "type": "string", "description": "\n\nA collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource.\n\nSpecify this parameter as a comma-separated list of JSON tag names.\n\n\t\t\t\t\t\t", "name": "_fields", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3RecordA" } } } }, "delete": { "description": "Use this method to move the __RecordA__ object to the recycle bin.", "tags": [ "record:a" ], "summary": "Move the RecordA object to the recycle bin.", "operationId": "record:aDelete", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" } ], "responses": { "200": { "description": "DELETE operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:aaaa": { "get": { "description": "Use this method to retrieve __RecordAAAA__ objects.", "tags": [ "record:aaaa" ], "summary": "Retrieve RecordAAAA objects.", "operationId": "record:aaaaList", "parameters": [ { "type": "string", "description": "infoblox.ddi.wapi.paging", "name": "paging", "in": "query" }, { "type": "string", "description": "infoblox.ddi.wapi.options", "name": "options", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3ListRecordAAAAResponse" } } } }, "post": { "description": "Use this method to create a __RecordAAAA__ object.", "tags": [ "record:aaaa" ], "summary": "Create a RecordAAAA object.", "operationId": "record:aaaaCreate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordAAAA" } } ], "responses": { "201": { "description": "POST operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:aaaa/{payload.ref.ref_data}/**": { "put": { "description": "Use this method to update the __RecordAAAA__ object.", "tags": [ "record:aaaa" ], "summary": "Update the RecordAAAA object.", "operationId": "record:aaaaUpdate", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "payload.ref.ref_data", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordAAAA" } } ], "responses": { "200": { "description": "PUT operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:aaaa/{ref.ref_data}/**": { "get": { "description": "Use this method to retrieve the __RecordAAAA__ object.", "tags": [ "record:aaaa" ], "summary": "Retrieve the RecordAAAA object.", "operationId": "record:aaaaRead", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" }, { "type": "string", "description": "\n\nA collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource.\n\nSpecify this parameter as a comma-separated list of JSON tag names.\n\n\t\t\t\t\t\t", "name": "_fields", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3RecordAAAA" } } } }, "delete": { "description": "Use this method to move the __RecordAAAA__ object to the recycle bin.", "tags": [ "record:aaaa" ], "summary": "Move the RecordAAAA object to the recycle bin.", "operationId": "record:aaaaDelete", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" } ], "responses": { "200": { "description": "DELETE operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:alias": { "get": { "description": "Use this method to retrieve __RecordAlias__ objects.", "tags": [ "record:alias" ], "summary": "Retrieve RecordAlias objects.", "operationId": "record:aliasList", "parameters": [ { "type": "string", "description": "infoblox.ddi.wapi.paging", "name": "paging", "in": "query" }, { "type": "string", "description": "infoblox.ddi.wapi.options", "name": "options", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3ListRecordAliasResponse" } } } }, "post": { "description": "Use this method to create a __RecordAlias__ object.", "tags": [ "record:alias" ], "summary": "Create a RecordAlias object.", "operationId": "record:aliasCreate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordAlias" } } ], "responses": { "201": { "description": "POST operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:alias/{payload.ref.ref_data}/**": { "put": { "description": "Use this method to update the __RecordAlias__ object.", "tags": [ "record:alias" ], "summary": "Update a RecordAlias object.", "operationId": "record:aliasUpdate", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "payload.ref.ref_data", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordAlias" } } ], "responses": { "200": { "description": "PUT operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:alias/{ref.ref_data}/**": { "get": { "description": "Use this method to retrieve the __RecordAlias__ object.", "tags": [ "record:alias" ], "summary": "Retrieve a RecordAlias object.", "operationId": "record:aliasRead", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" }, { "type": "string", "description": "\n\nA collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource.\n\nSpecify this parameter as a comma-separated list of JSON tag names.\n\n\t\t\t\t\t\t", "name": "_fields", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3RecordAlias" } } } }, "delete": { "description": "Use this method to move the __RecordAlias__ object to the recycle bin.", "tags": [ "record:alias" ], "summary": "Move a RecordAlias object to the recycle bin.", "operationId": "record:aliasDelete", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" } ], "responses": { "200": { "description": "DELETE operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:cname": { "get": { "description": "Use this method to retrieve __RecordCNAME__ objects.", "tags": [ "record:cname" ], "summary": "Retrieve RecordCNAME objects.", "operationId": "record:cnameList", "parameters": [ { "type": "string", "description": "infoblox.ddi.wapi.paging", "name": "paging", "in": "query" }, { "type": "string", "description": "infoblox.ddi.wapi.options", "name": "options", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3ListRecordCNAMEResponse" } } } }, "post": { "description": "Use this method to create a __RecordCNAME__ object.", "tags": [ "record:cname" ], "summary": "Create a RecordCNAME object.", "operationId": "record:cnameCreate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordCNAME" } } ], "responses": { "201": { "description": "POST operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:cname/{payload.ref.ref_data}/**": { "put": { "description": "Use this method to update the __RecordCNAME__ object.", "tags": [ "record:cname" ], "summary": "Update the RecordCNAME object.", "operationId": "record:cnameUpdate", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "payload.ref.ref_data", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordCNAME" } } ], "responses": { "200": { "description": "PUT operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:cname/{ref.ref_data}/**": { "get": { "description": "Use this method to retrieve the __RecordCNAME__ object.", "tags": [ "record:cname" ], "summary": "Retrieve the RecordCNAME object.", "operationId": "record:cnameRead", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" }, { "type": "string", "description": "\n\nA collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource.\n\nSpecify this parameter as a comma-separated list of JSON tag names.\n\n\t\t\t\t\t\t", "name": "_fields", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3RecordCNAME" } } } }, "delete": { "description": "Use this method to move the __RecordCNAME__ object to the recycle bin.", "tags": [ "record:cname" ], "summary": "Move the RecordCNAME object to the recycle bin.", "operationId": "record:cnameDelete", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" } ], "responses": { "200": { "description": "DELETE operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:dname": { "get": { "description": "Use this method to retrieve __RecordDNAME__ objects.", "tags": [ "record:dname" ], "summary": "Retrieve RecordDNAME objects.", "operationId": "record:dnameList", "parameters": [ { "type": "string", "description": "infoblox.ddi.wapi.paging", "name": "paging", "in": "query" }, { "type": "string", "description": "infoblox.ddi.wapi.options", "name": "options", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3ListRecordDNAMEResponse" } } } }, "post": { "description": "Use this method to create a __RecordDNAME__ object.", "tags": [ "record:dname" ], "summary": "Create a RecordDNAME object.", "operationId": "record:dnameCreate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordDNAME" } } ], "responses": { "201": { "description": "POST operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:dname/{payload.ref.ref_data}/**": { "put": { "description": "Use this method to update the __RecordDNAME__ object.", "tags": [ "record:dname" ], "summary": "Update a RecordDNAME object.", "operationId": "record:dnameUpdate", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "payload.ref.ref_data", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordDNAME" } } ], "responses": { "200": { "description": "PUT operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:dname/{ref.ref_data}/**": { "get": { "description": "Use this method to retrieve the __RecordDNAME__ object.", "tags": [ "record:dname" ], "summary": "Retrieve a RecordDNAME object.", "operationId": "record:dnameRead", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" }, { "type": "string", "description": "\n\nA collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource.\n\nSpecify this parameter as a comma-separated list of JSON tag names.\n\n\t\t\t\t\t\t", "name": "_fields", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3RecordDNAME" } } } }, "delete": { "description": "Use this method to move the __RecordDNAME__ object to the recycle bin.", "tags": [ "record:dname" ], "summary": "Move a RecordDNAME object to the recycle bin.", "operationId": "record:dnameDelete", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" } ], "responses": { "200": { "description": "DELETE operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:https": { "get": { "description": "Use this method to retrieve __RecordHTTPS__ objects.", "tags": [ "record:https" ], "summary": "Retrieve RecordHTTPS objects.", "operationId": "record:httpsList", "parameters": [ { "type": "string", "description": "infoblox.ddi.wapi.paging", "name": "paging", "in": "query" }, { "type": "string", "description": "infoblox.ddi.wapi.options", "name": "options", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3ListRecordHTTPSResponse" } } } }, "post": { "description": "Use this method to create a __RecordHTTPS__ object.", "tags": [ "record:https" ], "summary": "Create a RecordHTTPS object.", "operationId": "record:httpsCreate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordHTTPS" } } ], "responses": { "201": { "description": "POST operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:https/{payload.ref.ref_data}/**": { "put": { "description": "Use this method to update the __RecordHTTPS__ object.", "tags": [ "record:https" ], "summary": "Update the RecordHTTPS object.", "operationId": "record:httpsUpdate", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "payload.ref.ref_data", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordHTTPS" } } ], "responses": { "200": { "description": "PUT operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:https/{ref.ref_data}/**": { "get": { "description": "Use this method to retrieve the __RecordHTTPS__ object.", "tags": [ "record:https" ], "summary": "Retrieve the RecordHTTPS object.", "operationId": "record:httpsRead", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" }, { "type": "string", "description": "\n\nA collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource.\n\nSpecify this parameter as a comma-separated list of JSON tag names.\n\n\t\t\t\t\t\t", "name": "_fields", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3RecordHTTPS" } } } }, "delete": { "description": "Use this method to move the __RecordHTTPS__ object to the recycle bin.", "tags": [ "record:https" ], "summary": "Move the RecordHTTPS object to the recycle bin.", "operationId": "record:httpsDelete", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" } ], "responses": { "200": { "description": "DELETE operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:mx": { "get": { "description": "Use this method to retrieve __RecordMX__ objects.", "tags": [ "record:mx" ], "summary": "Retrieve RecordMX objects.", "operationId": "record:mxList", "parameters": [ { "type": "string", "description": "infoblox.ddi.wapi.paging", "name": "paging", "in": "query" }, { "type": "string", "description": "infoblox.ddi.wapi.options", "name": "options", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3ListRecordMXResponse" } } } }, "post": { "description": "Use this method to create a __RecordMX__ object.", "tags": [ "record:mx" ], "summary": "Create a RecordMX object.", "operationId": "record:mxCreate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordMX" } } ], "responses": { "201": { "description": "POST operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:mx/{payload.ref.ref_data}/**": { "put": { "description": "Use this method to update the __RecordMX__ object.", "tags": [ "record:mx" ], "summary": "Update a RecordMX object.", "operationId": "record:mxUpdate", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "payload.ref.ref_data", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordMX" } } ], "responses": { "200": { "description": "PUT operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:mx/{ref.ref_data}/**": { "get": { "description": "Use this method to retrieve the __RecordMX__ object.", "tags": [ "record:mx" ], "summary": "Retrieve a RecordMX object.", "operationId": "record:mxRead", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" }, { "type": "string", "description": "\n\nA collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource.\n\nSpecify this parameter as a comma-separated list of JSON tag names.\n\n\t\t\t\t\t\t", "name": "_fields", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3RecordMX" } } } }, "delete": { "description": "Use this method to move the __RecordMX__ object to the recycle bin.", "tags": [ "record:mx" ], "summary": "Move a RecordMX object to the recycle bin.", "operationId": "record:mxDelete", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" } ], "responses": { "200": { "description": "DELETE operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:naptr": { "get": { "description": "Use this method to retrieve __RecordNAPTR__ objects.", "tags": [ "record:naptr" ], "summary": "Retrieve RecordNAPTR objects.", "operationId": "record:naptrList", "parameters": [ { "type": "string", "description": "infoblox.ddi.wapi.paging", "name": "paging", "in": "query" }, { "type": "string", "description": "infoblox.ddi.wapi.options", "name": "options", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3ListRecordNAPTRResponse" } } } }, "post": { "description": "Use this method to create a __RecordNAPTR__ object.", "tags": [ "record:naptr" ], "summary": "Create a RecordNAPTR object.", "operationId": "record:naptrCreate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordNAPTR" } } ], "responses": { "201": { "description": "POST operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:naptr/{payload.ref.ref_data}/**": { "put": { "description": "Use this method to update the __RecordNAPTR__ object.", "tags": [ "record:naptr" ], "summary": "Update a RecordNAPTR object.", "operationId": "record:naptrUpdate", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "payload.ref.ref_data", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordNAPTR" } } ], "responses": { "200": { "description": "PUT operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:naptr/{ref.ref_data}/**": { "get": { "description": "Use this method to retrieve the __RecordNAPTR__ object.", "tags": [ "record:naptr" ], "summary": "Retrieve a RecordNAPTR object.", "operationId": "record:naptrRead", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" }, { "type": "string", "description": "\n\nA collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource.\n\nSpecify this parameter as a comma-separated list of JSON tag names.\n\n\t\t\t\t\t\t", "name": "_fields", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3RecordNAPTR" } } } }, "delete": { "description": "Use this method to move the __RecordNAPTR__ object to the recycle bin.", "tags": [ "record:naptr" ], "summary": "Move a RecordNAPTR object to the recycle bin.", "operationId": "record:naptrDelete", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" } ], "responses": { "200": { "description": "DELETE operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:ns": { "get": { "description": "Use this method to retrieve __RecordNS__ objects.", "tags": [ "record:ns" ], "summary": "Retrieve RecordNS objects.", "operationId": "record:nsList", "parameters": [ { "type": "string", "description": "infoblox.ddi.wapi.paging", "name": "paging", "in": "query" }, { "type": "string", "description": "infoblox.ddi.wapi.options", "name": "options", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3ListRecordNSResponse" } } } }, "post": { "description": "Use this method to create a __RecordNS__ object.", "tags": [ "record:ns" ], "summary": "Create a RecordNS object.", "operationId": "record:nsCreate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordNS" } } ], "responses": { "201": { "description": "POST operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:ns/{payload.ref.ref_data}/**": { "put": { "description": "Use this method to update the __RecordNS__ object.", "tags": [ "record:ns" ], "summary": "Update a RecordNS object.", "operationId": "record:nsUpdate", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "payload.ref.ref_data", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordNS" } } ], "responses": { "200": { "description": "PUT operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:ns/{ref.ref_data}/**": { "get": { "description": "Use this method to retrieve the __RecordNS__ object.", "tags": [ "record:ns" ], "summary": "Retrieve a RecordNS object.", "operationId": "record:nsRead", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" }, { "type": "string", "description": "\n\nA collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource.\n\nSpecify this parameter as a comma-separated list of JSON tag names.\n\n\t\t\t\t\t\t", "name": "_fields", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3RecordNS" } } } }, "delete": { "description": "Use this method to move the __RecordNS__ object to the recycle bin.", "tags": [ "record:ns" ], "summary": "Move a RecordNS object to the recycle bin.", "operationId": "record:nsDelete", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" } ], "responses": { "200": { "description": "DELETE operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:ptr": { "get": { "description": "Use this method to retrieve __RecordPTR__ objects.", "tags": [ "record:ptr" ], "summary": "Retrieve RecordPTR objects.", "operationId": "record:ptrList", "parameters": [ { "type": "string", "description": "infoblox.ddi.wapi.paging", "name": "paging", "in": "query" }, { "type": "string", "description": "infoblox.ddi.wapi.options", "name": "options", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3ListRecordPTRResponse" } } } }, "post": { "description": "Use this method to create a __RecordPTR__ object.", "tags": [ "record:ptr" ], "summary": "Create a RecordPTR object.", "operationId": "record:ptrCreate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordPTR" } } ], "responses": { "201": { "description": "POST operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:ptr/{payload.ref.ref_data}/**": { "put": { "description": "Use this method to update the __RecordPTR__ object.", "tags": [ "record:ptr" ], "summary": "Update a RecordPTR object.", "operationId": "record:ptrUpdate", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "payload.ref.ref_data", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordPTR" } } ], "responses": { "200": { "description": "PUT operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:ptr/{ref.ref_data}/**": { "get": { "description": "Use this method to retrieve the __RecordPTR__ object.", "tags": [ "record:ptr" ], "summary": "Retrieve a RecordPTR object.", "operationId": "record:ptrRead", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" }, { "type": "string", "description": "\n\nA collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource.\n\nSpecify this parameter as a comma-separated list of JSON tag names.\n\n\t\t\t\t\t\t", "name": "_fields", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3RecordPTR" } } } }, "delete": { "description": "Use this method to move the __RecordPTR__ object to the recycle bin.", "tags": [ "record:ptr" ], "summary": "Move a RecordPTR object to the recycle bin.", "operationId": "record:ptrDelete", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" } ], "responses": { "200": { "description": "DELETE operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:srv": { "get": { "description": "Use this method to retrieve __RecordSRV__ objects.", "tags": [ "record:srv" ], "summary": "Retrieve RecordSRV objects.", "operationId": "record:srvList", "parameters": [ { "type": "string", "description": "infoblox.ddi.wapi.paging", "name": "paging", "in": "query" }, { "type": "string", "description": "infoblox.ddi.wapi.options", "name": "options", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3ListRecordSRVResponse" } } } }, "post": { "description": "Use this method to create a __RecordSRV__ object.", "tags": [ "record:srv" ], "summary": "Create a RecordSRV object.", "operationId": "record:srvCreate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordSRV" } } ], "responses": { "201": { "description": "POST operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:srv/{payload.ref.ref_data}/**": { "put": { "description": "Use this method to update the __RecordSRV__ object.", "tags": [ "record:srv" ], "summary": "Update a RecordSRV object.", "operationId": "record:srvUpdate", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "payload.ref.ref_data", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordSRV" } } ], "responses": { "200": { "description": "PUT operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:srv/{ref.ref_data}/**": { "get": { "description": "Use this method to retrieve the __RecordSRV__ object.", "tags": [ "record:srv" ], "summary": "Retrieve a RecordSRV object.", "operationId": "record:srvRead", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" }, { "type": "string", "description": "\n\nA collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource.\n\nSpecify this parameter as a comma-separated list of JSON tag names.\n\n\t\t\t\t\t\t", "name": "_fields", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3RecordSRV" } } } }, "delete": { "description": "Use this method to move the __RecordSRV__ object to the recycle bin.", "tags": [ "record:srv" ], "summary": "Move a RecordSRV object to the recycle bin.", "operationId": "record:srvDelete", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" } ], "responses": { "200": { "description": "DELETE operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:sshfp": { "get": { "description": "Use this method to retrieve __RecordSSHFP__ objects.", "tags": [ "record:sshfp" ], "summary": "Retrieve RecordSSHFP objects.", "operationId": "record:sshfpList", "parameters": [ { "type": "string", "description": "infoblox.ddi.wapi.paging", "name": "paging", "in": "query" }, { "type": "string", "description": "infoblox.ddi.wapi.options", "name": "options", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3ListRecordSSHFPResponse" } } } }, "post": { "description": "Use this method to create a __RecordSSHFP__ object.", "tags": [ "record:sshfp" ], "summary": "Create a RecordSSHFP object.", "operationId": "record:sshfpCreate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordSSHFP" } } ], "responses": { "201": { "description": "POST operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:sshfp/{payload.ref.ref_data}/**": { "put": { "description": "Use this method to update the __RecordSSHFP__ object.", "tags": [ "record:sshfp" ], "summary": "Update the RecordSSHFP object.", "operationId": "record:sshfpUpdate", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "payload.ref.ref_data", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordSSHFP" } } ], "responses": { "200": { "description": "PUT operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:sshfp/{ref.ref_data}/**": { "get": { "description": "Use this method to retrieve the __RecordSSHFP__ object.", "tags": [ "record:sshfp" ], "summary": "Retrieve the RecordSSHFP object.", "operationId": "record:sshfpRead", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" }, { "type": "string", "description": "\n\nA collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource.\n\nSpecify this parameter as a comma-separated list of JSON tag names.\n\n\t\t\t\t\t\t", "name": "_fields", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3RecordSSHFP" } } } }, "delete": { "description": "Use this method to move the __RecordSSHFP__ object to the recycle bin.", "tags": [ "record:sshfp" ], "summary": "Move the RecordSSHFP object to the recycle bin.", "operationId": "record:sshfpDelete", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" } ], "responses": { "200": { "description": "DELETE operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:svcb": { "get": { "tags": [ "record:svcb" ], "operationId": "record:svcbList", "parameters": [ { "type": "string", "description": "infoblox.ddi.wapi.paging", "name": "paging", "in": "query" }, { "type": "string", "description": "infoblox.ddi.wapi.options", "name": "options", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3ListRecordSVCBResponse" } } } }, "post": { "tags": [ "record:svcb" ], "operationId": "record:svcbCreate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordSVCB" } } ], "responses": { "201": { "description": "POST operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:svcb/{payload.ref.ref_data}/**": { "put": { "tags": [ "record:svcb" ], "operationId": "record:svcbUpdate", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "payload.ref.ref_data", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordSVCB" } } ], "responses": { "200": { "description": "PUT operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:svcb/{ref.ref_data}/**": { "get": { "tags": [ "record:svcb" ], "operationId": "record:svcbRead", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" }, { "type": "string", "description": "\n\nA collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource.\n\nSpecify this parameter as a comma-separated list of JSON tag names.\n\n\t\t\t\t\t\t", "name": "_fields", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3RecordSVCB" } } } }, "delete": { "tags": [ "record:svcb" ], "operationId": "record:svcbDelete", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" } ], "responses": { "200": { "description": "DELETE operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:txt": { "get": { "description": "Use this method to retrieve __RecordTXT__ objects.", "tags": [ "record:txt" ], "summary": "Retrieve RecordTXT objects.", "operationId": "record:txtList", "parameters": [ { "type": "string", "description": "infoblox.ddi.wapi.paging", "name": "paging", "in": "query" }, { "type": "string", "description": "infoblox.ddi.wapi.options", "name": "options", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3ListRecordTXTResponse" } } } }, "post": { "description": "Use this method to create a __RecordTXT__ object.", "tags": [ "record:txt" ], "summary": "Create a RecordTXT object.", "operationId": "record:txtCreate", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordTXT" } } ], "responses": { "201": { "description": "POST operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:txt/{payload.ref.ref_data}/**": { "put": { "description": "Use this method to update the __RecordTXT__ object.", "tags": [ "record:txt" ], "summary": "Update the RecordTXT object.", "operationId": "record:txtUpdate", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "payload.ref.ref_data", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v3RecordTXT" } } ], "responses": { "200": { "description": "PUT operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } }, "/record:txt/{ref.ref_data}/**": { "get": { "description": "Use this method to retrieve the __RecordTXT__ object.", "tags": [ "record:txt" ], "summary": "Retrieve the RecordTXT object.", "operationId": "record:txtRead", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" }, { "type": "string", "description": "\n\nA collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource.\n\nSpecify this parameter as a comma-separated list of JSON tag names.\n\n\t\t\t\t\t\t", "name": "_fields", "in": "query" } ], "responses": { "200": { "description": "GET operation response", "schema": { "$ref": "#/definitions/v3RecordTXT" } } } }, "delete": { "description": "Use this method to move the __RecordTXT__ object to the recycle bin.", "tags": [ "record:txt" ], "summary": "Move the RecordTXT object to the recycle bin.", "operationId": "record:txtDelete", "parameters": [ { "type": "string", "description": "Opaque internal object identifier and optional name components", "name": "ref.ref_data", "in": "path", "required": true }, { "type": "string", "description": "infoblox.ddi.wapi.objectref", "name": "ref", "in": "query" } ], "responses": { "200": { "description": "DELETE operation response", "schema": { "$ref": "#/definitions/resourceObjectRef" } } } } } }, "definitions": { "resourceObjectRef": { "description": "infoblox.ddi.wapi.objectref", "type": "string", "properties": { "object_type": { "type": "string", "title": "The object type being referenced" }, "ref_data": { "type": "string", "title": "Opaque internal object identifier and optional name components" } } }, "v3ListRecordAAAAResponse": { "description": "The response format to retrieve __RecordAAAA__ objects.", "type": "object", "title": "ListRecordAAAAResponse", "properties": { "next_page_id": { "description": "If there was a paging request, this is the paging token for the next page of results.\nThis field is only set when paging is enabled and there are more results to retrieve.", "type": "string" }, "result": { "description": "List of RecordAAAA objects.", "type": "array", "items": { "$ref": "#/definitions/v3RecordAAAA" } } } }, "v3ListRecordAResponse": { "description": "The response format to retrieve __RecordA__ objects.", "type": "object", "title": "ListRecordAResponse", "properties": { "next_page_id": { "description": "If there was a paging request, this is the paging token for the next page of results.\nThis field is only set when paging is enabled and there are more results to retrieve.", "type": "string" }, "result": { "description": "List of RecordA objects.", "type": "array", "items": { "$ref": "#/definitions/v3RecordA" } } } }, "v3ListRecordAliasResponse": { "description": "The response format to retrieve __RecordAlias__ objects.", "type": "object", "title": "ListRecordAliasResponse", "properties": { "next_page_id": { "description": "If there was a paging request, this is the paging token for the next page of results.\nThis field is only set when paging is enabled and there are more results to retrieve.", "type": "string" }, "result": { "description": "List of RecordAlias objects.", "type": "array", "items": { "$ref": "#/definitions/v3RecordAlias" } } } }, "v3ListRecordCNAMEResponse": { "description": "The response format to retrieve __RecordCNAME__ objects.", "type": "object", "title": "ListRecordCNAMEResponse", "properties": { "next_page_id": { "description": "If there was a paging request, this is the paging token for the next page of results.\nThis field is only set when paging is enabled and there are more results to retrieve.", "type": "string" }, "result": { "description": "List of RecordCNAME objects.", "type": "array", "items": { "$ref": "#/definitions/v3RecordCNAME" } } } }, "v3ListRecordDNAMEResponse": { "description": "The response format to retrieve __RecordDNAME__ objects.", "type": "object", "title": "ListRecordDNAMEResponse", "properties": { "next_page_id": { "description": "If there was a paging request, this is the paging token for the next page of results.\nThis field is only set when paging is enabled and there are more results to retrieve.", "type": "string" }, "result": { "description": "List of RecordDNAME objects.", "type": "array", "items": { "$ref": "#/definitions/v3RecordDNAME" } } } }, "v3ListRecordHTTPSResponse": { "description": "The response format to retrieve __RecordHTTPS__ objects.", "type": "object", "title": "ListRecordHTTPSResponse", "properties": { "next_page_id": { "description": "If there was a paging request, this is the paging token for the next page of results.\nThis field is only set when paging is enabled and there are more results to retrieve.", "type": "string" }, "result": { "description": "List of RecordHTTPS objects.", "type": "array", "items": { "$ref": "#/definitions/v3RecordHTTPS" } } } }, "v3ListRecordMXResponse": { "description": "The response format to retrieve __RecordMX__ objects.", "type": "object", "title": "ListRecordMXResponse", "properties": { "next_page_id": { "description": "If there was a paging request, this is the paging token for the next page of results.\nThis field is only set when paging is enabled and there are more results to retrieve.", "type": "string" }, "result": { "description": "List of RecordMX objects.", "type": "array", "items": { "$ref": "#/definitions/v3RecordMX" } } } }, "v3ListRecordNAPTRResponse": { "description": "The response format to retrieve __RecordNAPTR__ objects.", "type": "object", "title": "ListRecordNAPTRResponse", "properties": { "next_page_id": { "description": "If there was a paging request, this is the paging token for the next page of results.\nThis field is only set when paging is enabled and there are more results to retrieve.", "type": "string" }, "result": { "description": "List of RecordNAPTR objects.", "type": "array", "items": { "$ref": "#/definitions/v3RecordNAPTR" } } } }, "v3ListRecordNSResponse": { "description": "The response format to retrieve __RecordNS__ objects.", "type": "object", "title": "ListRecordNSResponse", "properties": { "next_page_id": { "description": "If there was a paging request, this is the paging token for the next page of results.\nThis field is only set when paging is enabled and there are more results to retrieve.", "type": "string" }, "result": { "description": "List of RecordNS objects.", "type": "array", "items": { "$ref": "#/definitions/v3RecordNS" } } } }, "v3ListRecordPTRResponse": { "description": "The response format to retrieve __RecordPTR__ objects.", "type": "object", "title": "ListRecordPTRResponse", "properties": { "next_page_id": { "description": "If there was a paging request, this is the paging token for the next page of results.\nThis field is only set when paging is enabled and there are more results to retrieve.", "type": "string" }, "result": { "description": "List of RecordPTR objects.", "type": "array", "items": { "$ref": "#/definitions/v3RecordPTR" } } } }, "v3ListRecordSRVResponse": { "description": "The response format to retrieve __RecordSRV__ objects.", "type": "object", "title": "ListRecordSRVResponse", "properties": { "next_page_id": { "description": "If there was a paging request, this is the paging token for the next page of results.\nThis field is only set when paging is enabled and there are more results to retrieve.", "type": "string" }, "result": { "description": "List of RecordSRV objects.", "type": "array", "items": { "$ref": "#/definitions/v3RecordSRV" } } } }, "v3ListRecordSSHFPResponse": { "description": "The response format to retrieve __RecordSSHFP__ objects.", "type": "object", "title": "ListRecordSSHFPResponse", "properties": { "next_page_id": { "description": "If there was a paging request, this is the paging token for the next page of results.\nThis field is only set when paging is enabled and there are more results to retrieve.", "type": "string" }, "result": { "description": "List of RecordSSHFP objects.", "type": "array", "items": { "$ref": "#/definitions/v3RecordSSHFP" } } } }, "v3ListRecordSVCBResponse": { "description": "The response format to retrieve __RecordSVCB__ objects.", "type": "object", "title": "ListRecordSVCBResponse", "properties": { "next_page_id": { "description": "If there was a paging request, this is the paging token for the next page of results.", "type": "string" }, "result": { "description": "List of RecordSVCB objects.", "type": "array", "items": { "$ref": "#/definitions/v3RecordSVCB" } } } }, "v3ListRecordTXTResponse": { "description": "The response format to retrieve __RecordTXT__ objects.", "type": "object", "title": "ListRecordTXTResponse", "properties": { "next_page_id": { "description": "If there was a paging request, this is the paging token for the next page of results.\nThis field is only set when paging is enabled and there are more results to retrieve.", "type": "string" }, "result": { "description": "List of RecordTXT objects.", "type": "array", "items": { "$ref": "#/definitions/v3RecordTXT" } } } }, "v3RecordA": { "description": "A __RecordA__ object (_dns/record_) represents a DNS resource record in an authoritative zone.\n\nFor creating a DNS resource record, following pair of fields is required:\u003cul\u003e\u003cli\u003e_ipv4addr_ and _name_: The system creates the DNS resource record object within the zone embedded in the name field. If no value of the view field is provided, default view is used automatically.\u003c/li\u003e\u003c/ul\u003e\n\nThe _ipv4addr_ and _name_ fields can be modified while updating a DNS resource record.", "type": "object", "title": "RecordA", "required": [ "ipv4addr", "name" ], "properties": { "comment": { "description": "Comment for the RecordA; maximum 1024 characters.", "type": "string" }, "creator": { "description": "Creator for the RecordA. Note that changing creator from or to 'SYSTEM' value is\nnot allowed.", "type": "string" }, "disable": { "description": "Determines if the RecordA is disabled or not. False means that the RecordA is\nenabled.", "type": "boolean", "format": "boolean" }, "ipv4addr": { "description": "The IPv4 Address of the RecordA.", "type": "string" }, "name": { "description": "Name for the RecordA in FQDN format. This value can be in unicode format.", "type": "string" }, "ref": { "description": "infoblox.ddi.wapi.objectref", "type": "string" }, "tags": { "description": "The tags for the RecordA in JSON format.", "type": "object", "additionalProperties": false }, "ttl": { "description": "The Time To Live (TTL) value for record. A 32-bit unsigned integer that\nrepresents the duration, in seconds, for which the RecordA is valid (cached).\nZero indicates that the RecordA should not be cached.", "type": "integer", "format": "int64" }, "use_ttl": { "description": "Use flag for: _ttl_. If set to _true_, the TTL value is used for the record. If set to _false_, the TTL value is inherited from the zone.", "type": "boolean", "format": "boolean" }, "view": { "description": "The name of the DNS view in which the RecordA resides. Example: \"external\".", "type": "string" }, "zone": { "description": "The name of the zone in which the RecordA resides. Example: \"zone.com\". If a\nview is not specified when searching by zone, the default view is used.", "type": "string" } } }, "v3RecordAAAA": { "description": "A __RecordAAAA__ object (_dns/record_) represents a DNS resource record in an authoritative zone.\n\nFor creating a DNS resource record, following pair of fields is required:\u003cul\u003e\u003cli\u003e_ipv6addr_ and _name_: The system creates the DNS resource record object within the zone embedded in the name field. If no value of the view field is provided, default view is used automatically.\u003c/li\u003e\u003c/ul\u003e\n\nThe _ipv6addr_ and _name_ fields can be modified while updating a DNS resource record.", "type": "object", "title": "RecordAAAA", "required": [ "ipv6addr", "name" ], "properties": { "comment": { "description": "Comment for the RecordAAAA; maximum 1024 characters.", "type": "string" }, "creator": { "description": "Creator for the RecordAAAA. Note that changing creator from or to 'SYSTEM' value is\nnot allowed.", "type": "string" }, "disable": { "description": "Determines if the RecordAAAA is disabled or not. False means that the RecordAAAA is\nenabled.", "type": "boolean", "format": "boolean" }, "ipv6addr": { "description": "The IPv6 Address of the RecordAAAA.", "type": "string" }, "name": { "description": "Name for the RecordAAAA in FQDN format. This value can be in unicode format.", "type": "string" }, "ref": { "description": "infoblox.ddi.wapi.objectref", "type": "string" }, "tags": { "description": "The tags for the RecordAAAA in JSON format.", "type": "object", "additionalProperties": false }, "ttl": { "description": "The Time To Live (TTL) value for record. A 32-bit unsigned integer that\nrepresents the duration, in seconds, for which the RecordAAAA is valid (cached).\nZero indicates that the RecordAAAA should not be cached.", "type": "integer", "format": "int64" }, "use_ttl": { "description": "Use flag for: _ttl_. If set to _true_, the TTL value is used for the record. If set to _false_, the TTL value is inherited from the zone.", "type": "boolean", "format": "boolean" }, "view": { "description": "The name of the DNS view in which the RecordAAAA resides. Example: \"external\".", "type": "string" }, "zone": { "description": "The name of the zone in which the RecordAAAA resides. Example: \"zone.com\". If a\nview is not specified when searching by zone, the default view is used.", "type": "string" } } }, "v3RecordAlias": { "description": "A __RecordAlias__ object (_dns/record_) represents a DNS ALIAS resource record in an authoritative zone.\n\nFor creating a DNS ALIAS resource record, the following fields are required:\u003cul\u003e\u003cli\u003e_name_: The fully qualified domain name of the ALIAS record.\u003c/li\u003e\u003cli\u003e_target_name_: The fully qualified domain name of the target.\u003c/li\u003e\u003cli\u003e_target_type_: The DNS resource record type to resolve for _target_name_.\u003c/li\u003e\u003c/ul\u003e\n\nThe _name_, _target_name_, and _target_type_ fields can be modified while updating a DNS resource record.", "type": "object", "title": "RecordAlias", "required": [ "name", "target_name", "target_type" ], "properties": { "comment": { "description": "Comment for the RecordAlias; maximum 1024 characters.", "type": "string" }, "creator": { "description": "Creator for the RecordAlias. Note that changing creator from or to 'SYSTEM' value is\nnot allowed.", "type": "string", "readOnly": true }, "disable": { "description": "Determines if the RecordAlias is disabled or not. False means that the RecordAlias is\nenabled.", "type": "boolean", "format": "boolean" }, "name": { "description": "The name of the RecordAlias in FQDN format.", "type": "string" }, "ref": { "description": "infoblox.ddi.wapi.objectref", "type": "string" }, "tags": { "description": "The tags for the RecordAlias in JSON format.", "type": "object", "additionalProperties": false }, "target_name": { "description": "The fully qualified domain name of the target to resolve at query time.", "type": "string" }, "target_type": { "description": "The type of DNS resource record to resolve for the target domain. Must be\none of: A, AAAA, CAA, MX, NAPTR, PTR, SPF, SRV, TXT.", "type": "string" }, "ttl": { "description": "The Time To Live (TTL) value for the record. A 32-bit unsigned integer that\nrepresents the duration, in seconds, for which the RecordAlias is valid (cached).\nZero indicates that the RecordAlias should not be cached.", "type": "integer", "format": "int64" }, "view": { "description": "The name of the DNS view in which the RecordAlias resides. Example: \"external\".", "type": "string" }, "zone": { "description": "The name of the zone in which the RecordAlias resides. Example: \"zone.com\". If a\nview is not specified when searching by zone, the default view is used.", "type": "string" } } }, "v3RecordCNAME": { "description": "A __RecordCNAME__ object (_dns/record_) represents a DNS CNAME resource record in an authoritative zone.\n\nFor creating a DNS CNAME resource record, following pair of fields is required:\u003cul\u003e\u003cli\u003e_canonical_ and _name_: The system creates the DNS resource record object within the zone embedded in the name field. If no value of the view field is provided, default view is used automatically.\u003c/li\u003e\u003c/ul\u003e\n\nThe _canonical_ and _name_ fields can be modified while updating a DNS resource record.", "type": "object", "title": "RecordCNAME", "required": [ "canonical", "name" ], "properties": { "canonical": { "description": "The canonical name (target) in FQDN format. This is the true name that the alias points to.", "type": "string" }, "comment": { "description": "Comment for the RecordCNAME; maximum 1024 characters.", "type": "string" }, "creator": { "description": "Creator for the RecordCNAME. Note that changing creator from or to 'SYSTEM' value is\nnot allowed.", "type": "string" }, "disable": { "description": "Determines if the RecordCNAME is disabled or not. False means that the RecordCNAME is\nenabled.", "type": "boolean", "format": "boolean" }, "name": { "description": "Name for the RecordCNAME (alias) in FQDN format. This value can be in unicode format.", "type": "string" }, "ref": { "description": "infoblox.ddi.wapi.objectref", "type": "string" }, "tags": { "description": "The tags for the RecordCNAME in JSON format.", "type": "object", "additionalProperties": false }, "ttl": { "description": "The Time To Live (TTL) value for record. A 32-bit unsigned integer that\nrepresents the duration, in seconds, for which the RecordCNAME is valid (cached).\nZero indicates that the RecordCNAME should not be cached.", "type": "integer", "format": "int64" }, "use_ttl": { "description": "Use flag for: _ttl_. If set to _true_, the TTL value is used for the record. If set to _false_, the TTL value is inherited from the zone.", "type": "boolean", "format": "boolean" }, "view": { "description": "The name of the DNS view in which the RecordCNAME resides. Example: \"external\".", "type": "string" }, "zone": { "description": "The name of the zone in which the RecordCNAME resides. Example: \"zone.com\". If a\nview is not specified when searching by zone, the default view is used.", "type": "string" } } }, "v3RecordDNAME": { "description": "A __RecordDNAME__ object (_dns/record_) represents a DNS resource record in an authoritative zone.\n\nA DNS DNAME record aliases an entire subtree of the DNS namespace to another domain name.", "type": "object", "title": "RecordDNAME", "required": [ "name", "target" ], "properties": { "comment": { "description": "Comment for the RecordDNAME; maximum 1024 characters.", "type": "string" }, "creator": { "description": "Creator for the RecordDNAME. Note that changing creator from or to 'SYSTEM' value is\nnot allowed.", "type": "string", "readOnly": true }, "disable": { "description": "Determines if the RecordDNAME is disabled or not. False means that the RecordDNAME is\nenabled.", "type": "boolean", "format": "boolean" }, "name": { "description": "The name of the RecordDNAME in FQDN format.", "type": "string" }, "ref": { "description": "infoblox.ddi.wapi.objectref", "type": "string" }, "tags": { "description": "The tags for the RecordDNAME in JSON format.", "type": "object", "additionalProperties": false }, "target": { "description": "The target domain name to which the DNAME record delegates.", "type": "string" }, "ttl": { "description": "The Time To Live (TTL) value for the record. A 32-bit unsigned integer that\nrepresents the duration, in seconds, for which the RecordDNAME is valid (cached).\nZero indicates that the RecordDNAME should not be cached.", "type": "integer", "format": "int64" }, "use_ttl": { "description": "Use flag for: _ttl_. If set to _true_, the TTL value is used for the record. If set to _false_, the TTL value is inherited from the zone.", "type": "boolean", "format": "boolean" }, "view": { "description": "The name of the DNS view in which the RecordDNAME resides. Example: \"external\".", "type": "string" }, "zone": { "description": "The name of the zone in which the RecordDNAME resides. Example: \"zone.com\". If a\nview is not specified when searching by zone, the default view is used.", "type": "string" } } }, "v3RecordHTTPS": { "description": "A __RecordHTTPS__ object (_dns/record_) represents a DNS HTTPS resource record in an authoritative zone.\n\nFor creating a DNS HTTPS resource record in UDDI, the required fields are _name_ and _target_name_.", "type": "object", "title": "RecordHTTPS", "required": [ "name", "target_name" ], "properties": { "comment": { "description": "Comment for the RecordHTTPS; maximum 1024 characters.", "type": "string" }, "creator": { "description": "Creator for the RecordHTTPS. Note that changing creator from or to 'SYSTEM' value is\nnot allowed.", "type": "string" }, "disable": { "description": "Determines if the RecordHTTPS is disabled or not. False means that the RecordHTTPS is\nenabled.", "type": "boolean", "format": "boolean" }, "name": { "description": "Name for the RecordHTTPS in FQDN format. This value can be in unicode format.", "type": "string" }, "priority": { "description": "Priority for HTTPS records. 0 means alias mode, \u003e0 means service mode.", "type": "integer", "format": "int64" }, "ref": { "description": "infoblox.ddi.wapi.objectref", "type": "string" }, "svc_parameters": { "description": "Service parameters.", "type": "array", "items": { "$ref": "#/definitions/v3SvcParameter" } }, "tags": { "description": "The tags for the RecordHTTPS in JSON format.", "type": "object", "additionalProperties": false }, "target_name": { "description": "Alias target name in FQDN format.", "type": "string" }, "ttl": { "description": "The Time To Live (TTL) value for record. A 32-bit unsigned integer that\nrepresents the duration, in seconds, for which the RecordHTTPS is valid (cached).\nZero indicates that the RecordHTTPS should not be cached.", "type": "integer", "format": "int64" }, "use_ttl": { "description": "Use flag for: _ttl_. If set to _true_, the TTL value is used for the record. If set to _false_, the TTL value is inherited from the zone.", "type": "boolean", "format": "boolean" }, "view": { "description": "The name of the DNS view in which the RecordHTTPS resides. Example: \"external\".", "type": "string" }, "zone": { "description": "The name of the zone in which the RecordHTTPS resides. Example: \"zone.com\". If a\nview is not specified when searching by zone, the default view is used.", "type": "string" } } }, "v3RecordMX": { "description": "A __RecordMX__ object (_dns/record_) represents a DNS resource record in an authoritative zone.\n\nA DNS MX record specifies a mail exchange server responsible for accepting email messages on behalf of a domain.", "type": "object", "title": "RecordMX", "required": [ "name", "mail_exchanger", "preference" ], "properties": { "comment": { "description": "Comment for the RecordMX; maximum 1024 characters.", "type": "string" }, "creator": { "description": "Creator for the RecordMX. Note that changing creator from or to 'SYSTEM' value is\nnot allowed.", "type": "string", "readOnly": true }, "disable": { "description": "Determines if the RecordMX is disabled or not. False means that the RecordMX is\nenabled.", "type": "boolean", "format": "boolean" }, "mail_exchanger": { "description": "The mail exchanger host in FQDN format.", "type": "string" }, "name": { "description": "The name of the RecordMX in FQDN format.", "type": "string" }, "preference": { "description": "Preference value for the MX record. An unsigned 16-bit integer which specifies the\npreference given to this RR among others at the same owner. Lower values are preferred.\nThe range of the value is 0 to 65535.", "type": "integer", "format": "int64" }, "ref": { "description": "infoblox.ddi.wapi.objectref", "type": "string" }, "tags": { "description": "The tags for the RecordMX in JSON format.", "type": "object", "additionalProperties": false }, "ttl": { "description": "The Time To Live (TTL) value for the record. A 32-bit unsigned integer that\nrepresents the duration, in seconds, for which the RecordMX is valid (cached).\nZero indicates that the RecordMX should not be cached.", "type": "integer", "format": "int64" }, "use_ttl": { "description": "Use flag for: _ttl_. If set to _true_, the TTL value is used for the record. If set to _false_, the TTL value is inherited from the zone.", "type": "boolean", "format": "boolean" }, "view": { "description": "The name of the DNS view in which the RecordMX resides. Example: \"external\".", "type": "string" }, "zone": { "description": "The name of the zone in which the RecordMX resides. Example: \"zone.com\". If a\nview is not specified when searching by zone, the default view is used.", "type": "string" } } }, "v3RecordNAPTR": { "description": "A __RecordNAPTR__ object (_dns/record_) represents a DNS resource record in an authoritative zone.\n\nA DNS NAPTR record specifies a regular expression based rewriting rule used to construct the next domain name to look up.", "type": "object", "title": "RecordNAPTR", "required": [ "name", "order", "preference", "replacement" ], "properties": { "comment": { "description": "Comment for the RecordNAPTR; maximum 1024 characters.", "type": "string" }, "creator": { "description": "Creator for the RecordNAPTR. Note that changing creator from or to 'SYSTEM' value is\nnot allowed.", "type": "string" }, "disable": { "description": "Determines if the RecordNAPTR is disabled or not. False means that the RecordNAPTR is\nenabled.", "type": "boolean", "format": "boolean" }, "flags": { "description": "A character string containing flags to control aspects of the rewriting and\ninterpretation of the fields in the record. Valid flags: S, A, U, P.", "type": "string" }, "name": { "description": "The name of the RecordNAPTR in FQDN format.", "type": "string" }, "order": { "description": "A 16-bit unsigned integer specifying the order in which NAPTR records must\nbe processed. Lower values are processed first. Range: 0–65535.", "type": "integer", "format": "int64" }, "preference": { "description": "A 16-bit unsigned integer specifying the processing preference for records\nwith equal order values. Lower values are processed first. Range: 0–65535.", "type": "integer", "format": "int64" }, "ref": { "description": "infoblox.ddi.wapi.objectref", "type": "string" }, "regexp": { "description": "A string containing a substitution expression applied to the original string\nto construct the next domain name to look up. Defaults to empty string.", "type": "string" }, "replacement": { "description": "The next name to query for NAPTR, SRV, or address records depending on\nthe value of the flags field. Can be an absolute or relative domain name.", "type": "string" }, "services": { "description": "Specifies the service(s) available down this rewrite path. May also specify\nthe protocol used to talk with a service.", "type": "string" }, "tags": { "description": "The tags for the RecordNAPTR in JSON format.", "type": "object", "additionalProperties": false }, "ttl": { "description": "The Time To Live (TTL) value for the record. A 32-bit unsigned integer that\nrepresents the duration, in seconds, for which the RecordNAPTR is valid (cached).\nZero indicates that the RecordNAPTR should not be cached.", "type": "integer", "format": "int64" }, "use_ttl": { "description": "Use flag for: _ttl_. If set to _true_, the TTL value is used for the record. If set to _false_, the TTL value is inherited from the zone.", "type": "boolean", "format": "boolean" }, "view": { "description": "The name of the DNS view in which the RecordNAPTR resides. Example: \"external\".", "type": "string" }, "zone": { "description": "The name of the zone in which the RecordNAPTR resides. Example: \"zone.com\". If a\nview is not specified when searching by zone, the default view is used.", "type": "string" } } }, "v3RecordNS": { "description": "A __RecordNS__ object (_dns/record_) represents a DNS resource record in an authoritative zone.\n\nA DNS NS record identifies an authoritative DNS server for a domain.", "type": "object", "title": "RecordNS", "required": [ "name", "nameserver" ], "properties": { "creator": { "description": "Creator for the RecordNS. Note that changing creator from or to 'SYSTEM' value is\nnot allowed.", "type": "string" }, "name": { "description": "The name of the RecordNS.", "type": "string" }, "nameserver": { "description": "The nameserver for the RecordNS.", "type": "string" }, "ref": { "description": "infoblox.ddi.wapi.objectref", "type": "string" }, "view": { "description": "The name of the DNS view in which the RecordNS resides. Example: \"external\".", "type": "string" }, "zone": { "description": "The name of the zone in which the RecordNS resides. Example: \"zone.com\". If a\nview is not specified when searching by zone, the default view is used.", "type": "string" } } }, "v3RecordPTR": { "description": "A __RecordPTR__ object (_dns/record_) represents a DNS resource record in an authoritative zone.\n\nFor creating a DNS resource record in forward zone, following pair of fields is required:\u003cul\u003e\u003cli\u003e_ptrdname_ and one of _name_, _ipv4addr_ and _ipv6addr_ : The system creates the DNS resource record object within the zone embedded in the ptrdname field. If no value of the view field is provided, default view is used automatically.\u003c/li\u003e\u003c/ul\u003e\n\nThe _ptrdname_, _name_, _ipv4addr_ and _ipv6addr_ fields can be modified while updating a DNS resource record.", "type": "object", "title": "RecordPTR", "required": [ "ptrdname" ], "properties": { "comment": { "description": "Comment for the record; maximum 1024 characters.", "type": "string" }, "creator": { "description": "Creator for the RecordPTR. Note that changing creator from or to 'SYSTEM' value is\nnot allowed.", "type": "string" }, "disable": { "description": "Determines if the record is disabled or not. False means that the record is\nenabled.", "type": "boolean", "format": "boolean" }, "ipv4addr": { "description": "The IPv4 Address of the record.", "type": "string" }, "ipv6addr": { "description": "The IPv6 Address of the record.", "type": "string" }, "name": { "description": "The name of the DNS PTR record in FQDN format.", "type": "string" }, "ptrdname": { "description": "The domain name of the record.", "type": "string" }, "ref": { "description": "infoblox.ddi.wapi.objectref", "type": "string" }, "tags": { "description": "The tags for the RecordPTR in JSON format.", "type": "object", "additionalProperties": false }, "ttl": { "description": "The Time To Live (TTL) value for record. A 32-bit unsigned integer that\nrepresents the duration, in seconds, for which the record is valid (cached).\nZero indicates that the record should not be cached.", "type": "integer", "format": "int64" }, "use_ttl": { "description": "Use flag for ttl.", "type": "boolean", "format": "boolean" }, "view": { "description": "The name of the DNS view in which the record resides. Example: \"external\".", "type": "string" }, "zone": { "description": "The name of the zone in which the record resides. Example: \"zone.com\". If a\nview is not specified when searching by zone, the default view is used.", "type": "string" } } }, "v3RecordSRV": { "description": "A __RecordSRV__ object (_dns/record_) represents a DNS resource record in an authoritative zone.\n\nFor creating a DNS resource record, the following fields are required:\u003cul\u003e\u003cli\u003e_name_: The service name in FQDN format (e.g., _sip._tcp.example.com).\u003c/li\u003e\u003cli\u003e_target_: The hostname of the server providing the service.\u003c/li\u003e\u003cli\u003e_port_: The TCP or UDP port on which the service is available.\u003c/li\u003e\u003cli\u003e_priority_: The priority of the target host.\u003c/li\u003e\u003c/ul\u003e\n\nIf no value of the _view_ field is provided, the default view is used automatically.\n\nThe _name_, _target_, _port_, _priority_, and _weight_ fields can be modified while updating a DNS resource record.", "type": "object", "title": "RecordSRV", "required": [ "name", "target", "port", "priority" ], "properties": { "comment": { "description": "Comment for the record; maximum 1024 characters.", "type": "string" }, "creator": { "description": "Creator for the RecordSRV. Note that changing creator from or to 'SYSTEM' value is\nnot allowed.", "type": "string" }, "disable": { "description": "Determines if the record is disabled or not. False means that the record is\nenabled.", "type": "boolean", "format": "boolean" }, "name": { "description": "The name of the RecordSRV in FQDN format. This is typically in the form _service._proto.domain (e.g., _sip._tcp.example.com). This value can be in unicode format.", "type": "string" }, "port": { "description": "The port for the RecordSRV.", "type": "integer", "format": "int64" }, "priority": { "description": "The priority of the RecordSRV. Lower values indicate higher priority. Clients should attempt to contact the target host with the lowest-numbered priority first.", "type": "integer", "format": "int64" }, "ref": { "description": "infoblox.ddi.wapi.objectref", "type": "string" }, "tags": { "description": "The tags for the RecordSRV in JSON format.", "type": "object", "additionalProperties": false }, "target": { "description": "The target for the RecordSRV. There must be one or more address records for this name. The target must not be an alias (CNAME). A target of \".\" means the service is decidedly not available at this domain.", "type": "string" }, "ttl": { "description": "The Time To Live (TTL) value for record. A 32-bit unsigned integer that\nrepresents the duration, in seconds, for which the record is valid (cached).\nZero indicates that the record should not be cached.", "type": "integer", "format": "int64" }, "use_ttl": { "description": "Use flag for: _ttl_. If set to _true_, the TTL value is used for the record. If set to _false_, the TTL value is inherited from the zone.", "type": "boolean", "format": "boolean" }, "view": { "description": "The name of the DNS view in which the record resides. Example: \"external\".", "type": "string" }, "weight": { "description": "The weight for the RecordSRV. Higher weights have a proportionately higher probability of being selected.", "type": "integer", "format": "int64" }, "zone": { "description": "The name of the zone in which the record resides. Example: \"zone.com\". If a\nview is not specified when searching by zone, the default view is used.", "type": "string" } } }, "v3RecordSSHFP": { "description": "A __RecordSSHFP__ object (_dns/record_) represents a DNS SSHFP resource record in an authoritative zone.\n\nFor creating a DNS SSHFP resource record, the required fields are _name_, _algorithm_, _fingerprint_type_, and _fingerprint_.", "type": "object", "title": "RecordSSHFP", "required": [ "name", "algorithm", "fingerprint_type", "fingerprint" ], "properties": { "algorithm": { "description": "The algorithm number of the public key. See RFC 4255 section 3.1.1.", "type": "integer", "format": "int64" }, "comment": { "description": "Comment for the RecordSSHFP; maximum 1024 characters.", "type": "string" }, "creator": { "description": "Creator for the RecordSSHFP. Note that changing creator from or to 'SYSTEM' value is\nnot allowed.", "type": "string" }, "disable": { "description": "Determines if the RecordSSHFP is disabled or not. False means that the RecordSSHFP is\nenabled.", "type": "boolean", "format": "boolean" }, "fingerprint": { "description": "The hex-encoded fingerprint of the public key.", "type": "string" }, "fingerprint_type": { "description": "The fingerprint type number. See RFC 4255 section 3.1.2.", "type": "integer", "format": "int64" }, "name": { "description": "Name for the RecordSSHFP in FQDN format. This value can be in unicode format.", "type": "string" }, "ref": { "description": "infoblox.ddi.wapi.objectref", "type": "string" }, "tags": { "description": "The tags for the RecordSSHFP in JSON format.", "type": "object", "additionalProperties": false }, "ttl": { "description": "The Time To Live (TTL) value for record. A 32-bit unsigned integer that\nrepresents the duration, in seconds, for which the RecordSSHFP is valid (cached).\nZero indicates that the RecordSSHFP should not be cached.", "type": "integer", "format": "int64" }, "view": { "description": "The name of the DNS view in which the RecordSSHFP resides. Example: \"external\".", "type": "string" }, "zone": { "description": "The name of the zone in which the RecordSSHFP resides. Example: \"zone.com\". If a\nview is not specified when searching by zone, the default view is used.", "type": "string" } } }, "v3RecordSVCB": { "description": "A __RecordSVCB__ object (_dns/record_) represents a DNS SVCB resource record in an authoritative zone.\n\nFor creating a DNS SVCB resource record in UDDI, the required fields are _name_ and _target_name_.", "type": "object", "title": "RecordSVCB", "required": [ "name", "target_name" ], "properties": { "comment": { "description": "Comment for the RecordSVCB; maximum 1024 characters.", "type": "string" }, "creator": { "description": "Creator for the RecordSVCB. Note that changing creator from or to 'SYSTEM' value is\nnot allowed.", "type": "string" }, "disable": { "description": "Determines if the RecordSVCB is disabled or not. False means that the RecordSVCB is\nenabled.", "type": "boolean", "format": "boolean" }, "name": { "description": "Name for the RecordSVCB in FQDN format. This value can be in unicode format.", "type": "string" }, "priority": { "description": "Priority for SVCB records. 0 means alias mode, \u003e0 means service mode.", "type": "integer", "format": "int64" }, "ref": { "description": "infoblox.ddi.wapi.objectref", "type": "string" }, "svc_parameters": { "description": "Service parameters.", "type": "array", "items": { "$ref": "#/definitions/v3SvcParameter" } }, "tags": { "description": "The tags for the RecordSVCB in JSON format.", "type": "object", "additionalProperties": false }, "target_name": { "description": "Target name in FQDN format.", "type": "string" }, "ttl": { "description": "The Time To Live (TTL) value for record. A 32-bit unsigned integer that\nrepresents the duration, in seconds, for which the RecordSVCB is valid (cached).\nZero indicates that the RecordSVCB should not be cached.", "type": "integer", "format": "int64" }, "view": { "description": "The name of the DNS view in which the RecordSVCB resides. Example: \"external\".", "type": "string" }, "zone": { "description": "The name of the zone in which the RecordSVCB resides. Example: \"zone.com\". If a\nview is not specified when searching by zone, the default view is used.", "type": "string" } } }, "v3RecordTXT": { "description": "A __RecordTXT__ object (_dns/record_) represents a DNS resource record in an authoritative zone.\n\nFor creating a DNS resource record, following pair of fields is required:\u003cul\u003e\u003cli\u003e_text_ and _name_: The system creates the DNS resource record object within the zone embedded in the name field. If no value of the view field is provided, default view is used automatically.\u003c/li\u003e\u003c/ul\u003e\n\nThe _text_ and _name_ fields can be modified while updating a DNS resource record.", "type": "object", "title": "RecordTXT", "required": [ "text", "name" ], "properties": { "comment": { "description": "Comment for the RecordTXT; maximum 1024 characters.", "type": "string" }, "creator": { "description": "Creator for the RecordTXT. Note that changing creator from or to 'SYSTEM' value is\nnot allowed.", "type": "string" }, "disable": { "description": "Determines if the RecordTXT is disabled or not. False means that the RecordTXT is\nenabled.", "type": "boolean", "format": "boolean" }, "name": { "description": "Name for the RecordTXT in FQDN format. This value can be in unicode format.", "type": "string" }, "ref": { "description": "infoblox.ddi.wapi.objectref", "type": "string" }, "tags": { "description": "The tags for the RecordTXT in JSON format.", "type": "object", "additionalProperties": false }, "text": { "description": "The text content of the RecordTXT. This is an arbitrary text string (e.g., SPF records, DKIM keys, verification tokens).", "type": "string" }, "ttl": { "description": "The Time To Live (TTL) value for record. A 32-bit unsigned integer that\nrepresents the duration, in seconds, for which the RecordTXT is valid (cached).\nZero indicates that the RecordTXT should not be cached.", "type": "integer", "format": "int64" }, "use_ttl": { "description": "Use flag for: _ttl_. If set to _true_, the TTL value is used for the record. If set to _false_, the TTL value is inherited from the zone.", "type": "boolean", "format": "boolean" }, "view": { "description": "The name of the DNS view in which the RecordTXT resides. Example: \"external\".", "type": "string" }, "zone": { "description": "The name of the zone in which the RecordTXT resides. Example: \"zone.com\". If a\nview is not specified when searching by zone, the default view is used.", "type": "string" } } }, "v3SvcParameter": { "description": "SvcParameter represents a service parameter for SVCB/HTTPS records.", "type": "object", "properties": { "mandatory": { "description": "Indicates whether this parameter is mandatory.", "type": "boolean", "format": "boolean" }, "svc_key": { "description": "SVC parameter key (for example, \"alpn\", \"port\", \"ipv4hint\").", "type": "string" }, "svc_value": { "description": "SVC parameter value.", "type": "array", "items": { "type": "string" } } } } }, "securityDefinitions": { "ApiKeyAuth": { "description": "Please provide below your API key with the _Token_ prefix, e.g. _Token \u0026lt;YOUR API KEY\u0026gt;_", "type": "apiKey", "name": "Authorization", "in": "header" } }, "security": [ { "ApiKeyAuth": [] } ] }