openapi: 3.2.0 info: description: 'API for the DNS service. Use this API to manage DNS zones, records, and other DNS resources. For more information, see [Overview of the DNS Service](/iaas/Content/DNS/Concepts/dnszonemanagement.htm). ' license: name: Oracle Corporation title: Dns API version: '20180115' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/938455c921b3bd0216b4ff25d3ce9c51a01736d0b3bfde28e72d5f02e7aefa3f.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the DNS API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/938455c921b3bd0216b4ff25d3ce9c51a01736d0b3bfde28e72d5f02e7aefa3f.yaml what: the harvested document for DNS API servers: - url: /20180115 tags: - name: dns paths: /actions/createZoneFromZoneFile: post: description: 'Creates a new zone from a zone file in the specified compartment. Not supported for private zones. ' operationId: CreateZoneFromZoneFile parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ViewIdQueryParam' responses: '201': description: A response containing a single zone object. headers: Location: description: 'The full URI of the resource related to the request. ' schema: type: string etag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Zone' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '409': $ref: '#/components/responses/409' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'POST /20180115/actions/createZoneFromZoneFile?compartmentId=ocid1.. HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> Content-Type: text/dns <Zone file contents> ' x-related-resource: '#/definitions/Zone' requestBody: content: text/dns: schema: format: binary type: string description: The zone file contents. required: true /resolvers: get: description: 'Gets a list of all resolvers within a compartment. The collection can be filtered by display name, id, or lifecycle state. It can be sorted on creation time or displayName both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include resolvers in the DELETED lifecycleState to be consistent with other operations of the API. ' operationId: ListResolvers parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/IdQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ResolversSortByQueryParam' - $ref: '#/components/parameters/ResolverLifecycleStateQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A Response containing a list of resolver objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ResolverSummary' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/Resolver' /resolvers/{resolverId}: get: description: 'Gets information about a specific resolver. Note that attempting to get a resolver in the DELETED lifecycleState will result in a `404` response to be consistent with other operations of the API. ' operationId: GetResolver parameters: - $ref: '#/components/parameters/IfModifiedSinceHeader' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ResolverIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A Response containing a single resolver object. headers: etag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Resolver' '304': $ref: '#/components/responses/304' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/Resolver' put: description: 'Updates the specified resolver with your new information. ' operationId: UpdateResolver parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ResolverIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A Response containing a single resolver object. headers: etag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Resolver' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateResolverDetails' description: New data for the resolver. required: true /resolvers/{resolverId}/actions/changeCompartment: post: description: 'Moves a resolver into a different compartment along with its protected default view and any endpoints. Zones in the default view are not moved. VCN-dedicated resolvers are initially created in the same compartment as their corresponding VCN, but can then be moved to a different compartment. ' operationId: ChangeResolverCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ResolverIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '202': $ref: '#/components/responses/EmptyResponseWithWorkRequest' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/Resolver' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeResolverCompartmentDetails' description: 'Details for moving a resolver, along with its protected default view and endpoints, into a different compartment. ' required: true /resolvers/{resolverId}/endpoints: get: description: 'Gets a list of all endpoints within a resolver. The collection can be filtered by name or lifecycle state. It can be sorted on creation time or name both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include resolver endpoints in the DELETED lifecycle state to be consistent with other operations of the API. ' operationId: ListResolverEndpoints parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ResolverIdPathParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ResolverEndpointsSortByQueryParam' - $ref: '#/components/parameters/ResolverEndpointLifecycleStateQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A Response containing a list of resolver endpoint objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ResolverEndpointSummary' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/ResolverEndpoint' post: description: 'Creates a new resolver endpoint in the same compartment as the resolver. ' operationId: CreateResolverEndpoint parameters: - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ResolverIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '201': description: A Response containing a single resolver endpoint object. headers: Location: description: 'The full URI of the resource related to the request. ' schema: type: string etag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResolverEndpoint' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '409': $ref: '#/components/responses/409' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateResolverEndpointDetails' description: Details for creating a new resolver endpoint. required: true /resolvers/{resolverId}/endpoints/{resolverEndpointName}: delete: description: 'Deletes the specified resolver endpoint. Note that attempting to delete a resolver endpoint in the DELETED lifecycle state will result in a `404` response to be consistent with other operations of the API. Resolver endpoints may not be deleted if they are referenced by a resolver rule. ' operationId: DeleteResolverEndpoint parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ResolverIdPathParam' - $ref: '#/components/parameters/ResolverEndpointNamePathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '202': $ref: '#/components/responses/EmptyResponseWithWorkRequest' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/ResolverEndpoint' get: description: 'Gets information about a specific resolver endpoint. Note that attempting to get a resolver endpoint in the DELETED lifecycle state will result in a `404` response to be consistent with other operations of the API. ' operationId: GetResolverEndpoint parameters: - $ref: '#/components/parameters/IfModifiedSinceHeader' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ResolverIdPathParam' - $ref: '#/components/parameters/ResolverEndpointNamePathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A Response containing a single resolver endpoint object. headers: etag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResolverEndpoint' '304': $ref: '#/components/responses/304' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/ResolverEndpoint' put: description: 'Updates the specified resolver endpoint with your new information. ' operationId: UpdateResolverEndpoint parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ResolverIdPathParam' - $ref: '#/components/parameters/ResolverEndpointNamePathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A Response containing a single resolver endpoint object. headers: etag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResolverEndpoint' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateResolverEndpointDetails' description: New data for the resolver endpoint. required: true /steeringPolicies: get: description: 'Gets a list of all steering policies in the specified compartment. ' operationId: ListSteeringPolicies parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/IdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/HealthCheckMonitorIdQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/TemplateQueryParam' - $ref: '#/components/parameters/SteeringPoliciesLifecycleStateQueryParam' - $ref: '#/components/parameters/SteeringPoliciesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A response containing a list of steering policy objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: The total number of items that match the query. schema: type: integer content: application/json: schema: items: $ref: '#/components/schemas/SteeringPolicySummary' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'GET /20180115/steeringPolicies?compartmentId=ocid1..HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SteeringPolicy' post: description: 'Creates a new steering policy in the specified compartment. For more information on creating policies with templates, see [Traffic Management API Guide](/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). ' operationId: CreateSteeringPolicy parameters: - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ScopeQueryParam' responses: '201': description: A response containing a single steering policy object. headers: ETag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string Location: description: 'The full URI of the resource related to the request. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SteeringPolicy' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '409': $ref: '#/components/responses/409' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: "POST /20180115/steeringPolicies HTTP/1.1\nHost: dns.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n \"displayName\": \"failover between endpoints\",\n \"ttl\": 30,\n \"healthCheckMonitorId\": \"ocid1.httpmonitor.oc1..\",\n \"template\": \"FAILOVER\",\n \"answers\": [\n {\n \"name\": \"server-primary\",\n \"rtype\": \"A\",\n \"rdata\": \"192.0.2.0\",\n \"pool\": \"primary\"\n },\n {\n \"name\": \"server-secondary\",\n \"rtype\": \"A\",\n \"rdata\": \"192.0.4.6\",\n \"pool\": \"secondary\"\n }\n ],\n \"rules\": [\n {\n \"ruleType\": \"FILTER\",\n \"defaultAnswerData\": [\n {\n \"answerCondition\": \"answer.isDisabled != true\",\n \"shouldKeep\": true\n }\n ]\n },\n {\n \"ruleType\": \"HEALTH\"\n },\n {\n \"ruleType\": \"PRIORITY\",\n \"defaultAnswerData\": [\n {\n \"answerCondition\": \"answer.pool == 'primary'\",\n \"value\": 1\n },\n {\n \"answerCondition\": \"answer.pool == 'secondary'\",\n \"value\": 99\n }\n ]\n },\n {\n \"ruleType\": \"LIMIT\",\n \"defaultCount\": 1\n }\n ]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSteeringPolicyDetails' description: Details for creating a new steering policy. required: true /steeringPolicies/{steeringPolicyId}: delete: description: 'Deletes the specified steering policy. A `204` response indicates that the delete has been successful. Deletion will fail if the policy is attached to any zones. To detach a policy from a zone, see `DeleteSteeringPolicyAttachment`. ' operationId: DeleteSteeringPolicy parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/PolicyIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '204': $ref: '#/components/responses/EmptyResponseWithWorkRequest' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'DELETE /20180115/steeringPolicies/ocid1.dnspolicy.oc1.. HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-client-retries-enabled: false get: description: 'Gets information about the specified steering policy. ' operationId: GetSteeringPolicy parameters: - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/IfModifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/PolicyIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A response containing a single steering policy object. headers: ETag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SteeringPolicy' '304': $ref: '#/components/responses/304' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'GET /20180115/steeringPolicies/ocid1.dnspolicy.oc1..HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SteeringPolicy' put: description: 'Updates the configuration of the specified steering policy. ' operationId: UpdateSteeringPolicy parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/PolicyIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A response containing a single steering policy object. headers: ETag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SteeringPolicy' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: "PUT /20180115/steeringPolicies/ocid1.dnspolicy.oc1.. HTTP/1.1\nHost: dns.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n \"displayName\": \"LA data center failover\",\n \"ttl\": 30,\n \"healthCheckMonitorId\": \"ocid1.httpmonitor.oc1..\",\n \"template\": \"FAILOVER\",\n \"answers\": [\n {\n \"name\": \"server-primary\",\n \"rtype\": \"A\",\n \"rdata\": \"192.0.2.0\",\n \"pool\": \"primary\"\n },\n {\n \"name\": \"server-secondary\",\n \"rtype\": \"A\",\n \"rdata\": \"192.0.4.1\",\n \"pool\": \"secondary\"\n }\n ],\n \"rules\": [\n {\n \"ruleType\": \"FILTER\",\n \"defaultAnswerData\": [\n {\n \"answerCondition\": \"answer.isDisabled != true\",\n \"shouldKeep\": true\n }\n ]\n },\n {\n \"ruleType\": \"HEALTH\"\n },\n {\n \"ruleType\": \"PRIORITY\",\n \"defaultAnswerData\": [\n {\n \"answerCondition\": \"answer.pool == 'primary'\",\n \"value\": 1\n },\n {\n \"answerCondition\": \"answer.pool == 'secondary'\",\n \"value\": 99\n }\n ]\n },\n {\n \"ruleType\": \"LIMIT\",\n \"defaultCount\": 1\n }\n ]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSteeringPolicyDetails' description: New data for the steering policy. required: true /steeringPolicies/{steeringPolicyId}/actions/changeCompartment: post: description: 'Moves a steering policy into a different compartment. ' operationId: ChangeSteeringPolicyCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/PolicyIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '204': $ref: '#/components/responses/EmptyResponseWithWorkRequest' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/SteeringPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSteeringPolicyCompartmentDetails' description: Details for moving a steering policy into a different compartment. required: true /steeringPolicyAttachments: get: description: 'Lists the steering policy attachments in the specified compartment. ' operationId: ListSteeringPolicyAttachments parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/IdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SteeringPolicyIdQueryParam' - $ref: '#/components/parameters/ZoneIdQueryParam' - $ref: '#/components/parameters/DomainNameQueryParam' - $ref: '#/components/parameters/DomainNameContainsQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/AttachmentLifecycleStateQueryParam' - $ref: '#/components/parameters/SteeringPolicyAttachmentsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A response containing a list of steering policy attachments. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: The total number of items that match the query. schema: type: integer content: application/json: schema: items: $ref: '#/components/schemas/SteeringPolicyAttachmentSummary' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/SteeringPolicyAttachment' post: description: 'Creates a new attachment between a steering policy and a domain, giving the policy permission to answer queries for the specified domain. A steering policy must be attached to a domain for the policy to answer DNS queries for that domain. For the purposes of access control, the attachment is automatically placed into the same compartment as the domain''s zone. Attachments cannot be created for private zones. ' operationId: CreateSteeringPolicyAttachment parameters: - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ScopeQueryParam' responses: '201': description: A response containing a single steering policy attachment object. headers: ETag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string Location: description: 'The full URI of the resource related to the request. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SteeringPolicyAttachment' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '409': $ref: '#/components/responses/409' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: "POST /20180115/steeringPolicyAttachments HTTP/1.1\nHost: dns.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"steeringPolicyId\": \"ocid1.dnspolicy.oc1..\",\n \"zoneId\": \"ocid1.dns-zone.oc1..\",\n \"domainName\": \"example.com\",\n \"displayName\": \"attached to example\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSteeringPolicyAttachmentDetails' description: Details for creating a new steering policy attachment. required: true /steeringPolicyAttachments/{steeringPolicyAttachmentId}: delete: description: 'Deletes the specified steering policy attachment. A `204` response indicates that the delete has been successful. ' operationId: DeleteSteeringPolicyAttachment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/SteeringPolicyAttachmentIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '204': $ref: '#/components/responses/EmptyResponseWithWorkRequest' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'DELETE /20180115/steeringPolicyAttachments/ocid1.dnsattachment.oc1.. HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-client-retries-enabled: false get: description: 'Gets information about the specified steering policy attachment. ' operationId: GetSteeringPolicyAttachment parameters: - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/IfModifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/SteeringPolicyAttachmentIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A response containing a single steering policy attachment object. headers: ETag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SteeringPolicyAttachment' '304': $ref: '#/components/responses/304' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'GET /20180115/steeringPolicyAttachments/ocid1.dnsattachment.oc1.. HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SteeringPolicyAttachment' put: description: 'Updates the specified steering policy attachment with your new information. ' operationId: UpdateSteeringPolicyAttachment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/SteeringPolicyAttachmentIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A response containing a single steering policy attachment object. headers: ETag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SteeringPolicyAttachment' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: "PUT /20180115/steeringPolicyAttachments/ocid1.dnsattachment.oc1.. HTTP/1.1\nHost: dns.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"IP prefix steering\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSteeringPolicyAttachmentDetails' description: New data for the steering policy attachment. required: true /tsigKeys: get: description: 'Gets a list of all TSIG keys in the specified compartment. ' operationId: ListTsigKeys parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/IdQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/TsigKeysLifecycleStateQueryParam' - $ref: '#/components/parameters/TsigKeysSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A response containing a list of TSIG keys. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/TsigKeySummary' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/TsigKey' post: description: 'Creates a new TSIG key in the specified compartment. There is no `opc-retry-token` header since TSIG key names must be globally unique. ' operationId: CreateTsigKey parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ScopeQueryParam' responses: '201': description: A response containing a single TSIG key object. headers: ETag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string Location: description: 'The full URI of the resource related to the request. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TsigKey' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '409': $ref: '#/components/responses/409' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTsigKeyDetails' description: Details for creating a new TSIG key. required: true /tsigKeys/{tsigKeyId}: delete: description: 'Deletes the specified TSIG key. ' operationId: DeleteTsigKey parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/TsigKeyIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '204': $ref: '#/components/responses/EmptyResponseWithWorkRequest' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-obmcs-client-retries-enabled: false get: description: 'Gets information about the specified TSIG key. ' operationId: GetTsigKey parameters: - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/IfModifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/TsigKeyIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A response containing a single TSIG key object. headers: ETag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TsigKey' '304': $ref: '#/components/responses/304' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/TsigKey' put: description: 'Updates the specified TSIG key. ' operationId: UpdateTsigKey parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/TsigKeyIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A response containing a single TSIG key object. headers: ETag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TsigKey' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTsigKeyDetails' description: New data for the TSIG key. required: true /tsigKeys/{tsigKeyId}/actions/changeCompartment: post: description: 'Moves a TSIG key into a different compartment. ' operationId: ChangeTsigKeyCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/TsigKeyIdPathParam' responses: '204': $ref: '#/components/responses/EmptyResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/TsigKey' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeTsigKeyCompartmentDetails' description: Details for moving a TSIG key into a different compartment. required: true /views: get: description: 'Gets a list of all views within a compartment. The collection can be filtered by display name, id, or lifecycle state. It can be sorted on creation time or displayName both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include views in the DELETED lifecycleState to be consistent with other operations of the API. ' operationId: ListViews parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/IdQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ViewsSortByQueryParam' - $ref: '#/components/parameters/ViewLifecycleStateQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A Response containing a list of view objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ViewSummary' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/View' post: description: 'Creates a new view in the specified compartment. ' operationId: CreateView parameters: - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ScopeQueryParam' responses: '201': description: A Response containing a single view object. headers: Location: description: 'The full URI of the resource related to the request. ' schema: type: string etag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/View' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '409': $ref: '#/components/responses/409' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateViewDetails' description: Details for creating a new view. required: true /views/{viewId}: delete: description: 'Deletes the specified view. Note that attempting to delete a view in the DELETED lifecycleState will result in a `404` response to be consistent with other operations of the API. Views cannot be deleted if they are referenced by non-deleted zones or resolvers. Protected views cannot be deleted. ' operationId: DeleteView parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ViewIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '202': $ref: '#/components/responses/EmptyResponseWithWorkRequest' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/View' get: description: 'Gets information about a specific view. Note that attempting to get a view in the DELETED lifecycleState will result in a `404` response to be consistent with other operations of the API. ' operationId: GetView parameters: - $ref: '#/components/parameters/IfModifiedSinceHeader' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ViewIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A Response containing a single view object. headers: etag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/View' '304': $ref: '#/components/responses/304' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/View' put: description: 'Updates the specified view with your new information. ' operationId: UpdateView parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ViewIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '200': description: A Response containing a single view object. headers: etag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/View' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateViewDetails' description: New data for the view. required: true /views/{viewId}/actions/changeCompartment: post: description: 'Moves a view into a different compartment. To change the compartment of a protected view, change the compartment of its corresponding resolver. ' operationId: ChangeViewCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ViewIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' responses: '202': $ref: '#/components/responses/EmptyResponseWithWorkRequest' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/View' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeViewCompartmentDetails' description: Details for moving a view into a different compartment. required: true /zoneTransferServers: get: description: 'Gets a list of IP addresses of OCI nameservers for inbound and outbound transfer of zones in the specified compartment (which must be the root compartment of a tenancy) that transfer zone data with external master or downstream nameservers. ' operationId: ListZoneTransferServers parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: '200': description: A response containing a list of zone transfer server objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ZoneTransferServer' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'GET /20180115/zoneTransferServers?compartmentId=ocid1.. HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ZoneTransferServer' /zones: get: description: 'Gets a list of all zones in the specified compartment. The collection can be filtered by name, time created, scope, associated view, and zone type. Filtering by view is only supported for private zones. ' operationId: ListZones parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ZoneNameQueryParam' - $ref: '#/components/parameters/ZoneNameContainsQueryParam' - $ref: '#/components/parameters/ZoneTypeQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/ZonesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ViewIdQueryParam' - $ref: '#/components/parameters/TsigKeyIdQueryParam' - $ref: '#/components/parameters/DnssecStateQueryParam' responses: '200': description: A response containing a list of zone objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: The total number of items that match the query. schema: type: integer content: application/json: schema: items: $ref: '#/components/schemas/ZoneSummary' type: array '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'GET /20180115/zones?compartmentId=ocid1.compartment.oc1.. HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Zone' post: description: 'Creates a new zone in the specified compartment. Private zones must have a zone type of `PRIMARY`. Creating a private zone at or under `oraclevcn.com` within the default protected view of a VCN-dedicated resolver is not permitted. ' operationId: CreateZone parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ViewIdQueryParam' responses: '201': description: A response containing a single zone object. headers: ETag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string Location: description: 'The full URI of the resource related to the request. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Zone' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '409': $ref: '#/components/responses/409' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: "POST /20180115/zones HTTP/1.1\nHost: dns.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" :\"ocid1.compartment.oc1..\",\n \"name\" :\"example.com\",\n \"zoneType\" : \"PRIMARY\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateZoneBaseDetails' description: Details for creating a new zone. required: true /zones/{zoneId}/actions/changeCompartment: post: description: 'Moves a zone into a different compartment. Protected zones cannot have their compartment changed. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. **Note:** All SteeringPolicyAttachment objects associated with this zone will also be moved into the provided compartment. ' operationId: ChangeZoneCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneIdPathParam' responses: '204': $ref: '#/components/responses/EmptyResponseWithWorkRequest' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: "POST /20180115/zones/ocid1.dns-zone.oc1../actions/changeCompartment HTTP/1.1\nHost: dns.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..\"\n}\n" x-related-resource: '#/definitions/Zone' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeZoneCompartmentDetails' description: Details for moving a zone into a different compartment. required: true /zones/{zoneId}/actions/promoteDnssecKeyVersion: post: description: 'Promotes a specified `DnssecKeyVersion` on the zone. If the `DnssecKeyVersion` identified in the request body is a key signing key (KSK) that is replacing another `DnssecKeyVersion`, then the old `DnssecKeyVersion` is scheduled for removal from the zone. For key signing keys (KSKs), you must create the DS record with the new key information **before** promoting the new key to establish a chain of trust. To avoid a service disruption, remove the old DS record as soon as its TTL (time to live) expires. For more information, see [DNSSEC](/iaas/Content/DNS/Concepts/dnssec.htm). ' operationId: PromoteZoneDnssecKeyVersion parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneIdPathParam' responses: '202': $ref: '#/components/responses/EmptyResponseWithWorkRequest' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: "POST /20180115/zones/ocid1.dns-zone.oc1../actions/promoteZoneDnssecKeyVersion HTTP/1.1\nHost: dns.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"dnssecKeyVersionUuid\": \"123e4567-e89b-12d3-a456-426614174009\",\n}\n" x-related-resource: '#/definitions/Zone' requestBody: content: application/json: schema: $ref: '#/components/schemas/PromoteZoneDnssecKeyVersionDetails' description: Details for promoting a `DnssecKeyVersion`. required: true /zones/{zoneId}/actions/stageDnssecKeyVersion: post: description: 'Stages a new `DnssecKeyVersion` on the zone. Staging is a process that generates a new "successor" key version that replaces an existing "predecessor" key version. **Note:** A new key-signing key (KSK) version is inert until you update the parent zone DS records. For more information, see the [DNSSEC](/iaas/Content/DNS/Concepts/dnssec.htm) documentation. ' operationId: StageZoneDnssecKeyVersion parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneIdPathParam' responses: '202': $ref: '#/components/responses/EmptyResponseWithWorkRequest' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: "POST /20180115/zones/ocid1.dns-zone.oc1../actions/stageDnssecKeyVersion HTTP/1.1\nHost: dns.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"predecessorDnssecKeyVersionUuid\": \"123e4567-e89b-12d3-a456-426614174009\"\n}\n" x-related-resource: '#/definitions/Zone' requestBody: content: application/json: schema: $ref: '#/components/schemas/StageZoneDnssecKeyVersionDetails' description: Details for staging a DnssecKeyVersion. required: true /zones/{zoneNameOrId}: delete: description: 'Deletes the specified zone and all its steering policy attachments. A `204` response indicates that the zone has been successfully deleted. Protected zones cannot be deleted. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. ' operationId: DeleteZone parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' responses: '204': $ref: '#/components/responses/EmptyResponseWithWorkRequest' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'DELETE /20180115/zones/ocid1.dns-zone.oc1.. HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-client-retries-enabled: false get: description: 'Gets information about the specified zone, including its creation date, zone type, and serial. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. ' operationId: GetZone parameters: - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/IfModifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' responses: '200': description: A response containing a single zone object. headers: ETag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Zone' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'GET /20180115/zones/ocid1.dns-zone.oc1.. HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Zone' put: description: 'Updates the zone with the specified information. Global secondary zones may have their external masters updated. For more information about secondary zones, see [Manage DNS Service Zone](/iaas/Content/DNS/Tasks/managingdnszones.htm). When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. ' operationId: UpdateZone parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' responses: '200': description: A response containing a single zone object. headers: ETag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Zone' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: "PUT /20180115/zones/ocid1.dns-zone.oc1.. HTTP/1.1\nHost: dns.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"freeformTags\": {\n \"Department\": \"Finance\"\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateZoneDetails' description: New data for the zone. required: true /zones/{zoneNameOrId}/content: get: description: 'Gets the requested zone''s zone file. ' operationId: GetZoneContent parameters: - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/IfModifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' responses: '200': description: A response containing a binary zone file. headers: etag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: text/dns: schema: format: binary type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'GET /20180115/zones/ocid1.dns-zone.oc1../content HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Zone' /zones/{zoneNameOrId}/records: get: description: 'Gets all records in the specified zone. The results are sorted by `domain` in alphabetical order by default. For more information about records, see [Resource Record (RR) TYPEs](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. ' operationId: GetZoneRecords parameters: - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/IfModifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ZoneVersionQueryParam' - $ref: '#/components/parameters/DomainNameQueryParam' - $ref: '#/components/parameters/DomainNameContainsQueryParam' - $ref: '#/components/parameters/RTypeQueryParam' - $ref: '#/components/parameters/ZoneRecordsSortByQueryParam' - $ref: '#/components/parameters/RecordSortOrderQueryParam' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' responses: '200': $ref: '#/components/responses/RecordsResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'GET /20180115/zones/ocid1.dns-zone.oc1../records HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Records' patch: description: 'Updates a collection of records in the specified zone. You can update one record or all records for the specified zone depending on the changes provided in the request body. You can also add or remove records using this function. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. ' operationId: PatchZoneRecords parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' responses: '200': $ref: '#/components/responses/RecordsResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: "PATCH /20180115/zones/ocid1.dns-zone.oc1../records HTTP/1.1\nHost: dns.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n {\n \"domain\": \"example.com\",\n \"recordHash\": \"8f356bd7e9c2007c5c898f441fb663e9\",\n \"isProtected\": false,\n \"rdata\": \"v=spf1 include:example.net -all\",\n \"rrsetVersion\": \"9\",\n \"rtype\": \"TXT\",\n \"ttl\": 30,\n \"operation\": \"ADD\"\n }\n ]\n }\n" x-related-resource: '#/definitions/Records' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchZoneRecordsDetails' description: 'The operations describing how to modify the collection of records. ' required: true put: description: 'Replaces records in the specified zone with the records specified in the request body. If a specified record does not exist, it will be created. If the record exists, then it will be updated to represent the record in the body of the request. If a record in the zone does not exist in the request body, the record will be removed from the zone. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. ' operationId: UpdateZoneRecords parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' responses: '200': $ref: '#/components/responses/RecordsResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: "PUT /20180115/zones/ocid1.dns-zone.oc1../records HTTP/1.1\nHost: dns.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n {\n \"domain\": \"example.com\",\n \"recordHash\": \"261c84e3c11c3f2808fc4f18528f236e\",\n \"isProtected\": true,\n \"rdata\": \"ns1.p68.dns.oraclecloud.net.\",\n \"rrsetVersion\": \"1\",\n \"rtype\": \"NS\",\n \"ttl\": 86400\n },\n {\n \"domain\": \"example.com\",\n \"recordHash\": \"90c6eaebe9f434417091ec5dbd547df4\",\n \"isProtected\": true,\n \"rdata\": \"ns3.p68.dns.oraclecloud.net.\",\n \"rrsetVersion\": \"1\",\n \"rtype\": \"NS\",\n \"ttl\": 86400\n },\n {\n \"domain\": \"example.com\",\n \"recordHash\": \"d896912a210edd8e9c7a25814c3546e5\",\n \"isProtected\": true,\n \"rdata\": \"ns2.p68.dns.oraclecloud.net.\",\n \"rrsetVersion\": \"1\",\n \"rtype\": \"NS\",\n \"ttl\": 86400\n },\n {\n \"domain\": \"example.com\",\n \"recordHash\": \"ef56ea8e43967513ea90250df1769b3a\",\n \"isProtected\": true,\n \"rdata\": \"ns4.p68.dns.oraclecloud.net.\",\n \"rrsetVersion\": \"1\",\n \"rtype\": \"NS\",\n \"ttl\": 86400\n },\n {\n \"domain\": \"www.example.com\",\n \"recordHash\": \"136d3f26e66156a0727dda2552ab306f\",\n \"isProtected\": false,\n \"rdata\": \"v=spf1 include:example.net -all\",\n \"rrsetVersion\": \"14\",\n \"rtype\": \"TXT\",\n \"ttl\": 300\n }\n ]\n }\n" x-related-resource: '#/definitions/Records' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateZoneRecordsDetails' description: A full list of records for the zone. required: true /zones/{zoneNameOrId}/records/{domain}: delete: description: 'Deletes all records at the specified zone and domain. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. ' operationId: DeleteDomainRecords parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/DomainNamePathParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' responses: '204': $ref: '#/components/responses/EmptyResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'DELETE /20180115/zones/ocid1.dns-zone.oc1../records/example.com HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Records' get: description: 'Gets a list of all records at the specified zone and domain. The results are sorted by `rtype` in alphabetical order by default. You can optionally filter and/or sort the results using the listed parameters. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. ' operationId: GetDomainRecords parameters: - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/IfModifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/DomainNamePathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ZoneVersionQueryParam' - $ref: '#/components/parameters/RTypeQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' - $ref: '#/components/parameters/DomainRecordsSortByQueryParam' - $ref: '#/components/parameters/RecordSortOrderQueryParam' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' responses: '200': $ref: '#/components/responses/RecordsResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'GET /20180115/zones/ocid1.dns-zone.oc1../records/example.com HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Records' patch: description: 'Updates records in the specified zone at a domain. You can update one record or all records for the specified zone depending on the changes provided in the request body. You can also add or remove records using this function. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. ' operationId: PatchDomainRecords parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/DomainNamePathParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' responses: '200': $ref: '#/components/responses/RecordsResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/Records' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchDomainRecordsDetails' description: Operations describing how to modify the collection of records. required: true put: description: 'Replaces records in the specified zone at a domain with the records specified in the request body. If a specified record does not exist, it will be created. If the record exists, then it will be updated to represent the record in the body of the request. If a record in the zone does not exist in the request body, the record will be removed from the zone. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. ' operationId: UpdateDomainRecords parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/DomainNamePathParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' responses: '200': $ref: '#/components/responses/RecordsResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: "PUT /20180115/zones/ocid1.dns-zone.oc1../records/www.example.com HTTP/1.1\nHost: dns.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n {\n \"domain\": \"www.example.com\",\n \"recordHash\": \"8f356bd7e9c2007c5c898f441fb663e9\",\n \"isProtected\": false,\n \"rdata\": \"v=spf1 include:example.net -all\",\n \"rrsetVersion\": \"9\",\n \"rtype\": \"TXT\",\n \"ttl\": 30\n }\n ]\n}\n" x-related-resource: '#/definitions/Records' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDomainRecordsDetails' description: A full list of records for the domain. required: true /zones/{zoneNameOrId}/records/{domain}/{rtype}: delete: description: 'Deletes all records in the specified RRSet. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. ' operationId: DeleteRRSet parameters: - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/DomainNamePathParam' - $ref: '#/components/parameters/RTypePathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' responses: '204': $ref: '#/components/responses/EmptyResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'DELETE /20180115/zones/ocid1.dns-zone.oc1../records/example.com/TXT HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' get: description: 'Gets a list of all records in the specified RRSet. The results are sorted by `recordHash` by default. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. ' operationId: GetRRSet parameters: - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/IfModifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/DomainNamePathParam' - $ref: '#/components/parameters/RTypePathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ZoneVersionQueryParam' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' responses: '200': description: A collection of DNS resource record objects in a single RRSet. headers: ETag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: The total number of items that match the query. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/RRSet' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '412': $ref: '#/components/responses/412' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: 'GET /20180115/zones/ocid1.dns-zone.oc1../records/www.example.com/TXT HTTP/1.1 Host: dns.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/RRSet' patch: description: 'Updates records in the specified RRSet. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. ' operationId: PatchRRSet parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/DomainNamePathParam' - $ref: '#/components/parameters/RTypePathParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' responses: '200': $ref: '#/components/responses/RecordsResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-related-resource: '#/definitions/RRSet' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchRRSetDetails' description: Operations describing how to modify the collection of records. required: true put: description: 'Replaces records in the specified RRSet. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. ' operationId: UpdateRRSet parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/IfUnmodifiedSinceHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/ZoneNameOrIdPathParam' - $ref: '#/components/parameters/DomainNamePathParam' - $ref: '#/components/parameters/RTypePathParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/ZoneViewIdQueryParam' - $ref: '#/components/parameters/CompartmentIdDeprecatedQueryParam' responses: '200': $ref: '#/components/responses/RecordsResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '412': $ref: '#/components/responses/412' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' tags: - dns x-example: "PUT /20180115/zones/ocid1.dns-zone.oc1../records/www.example.com/TXT HTTP/1.1\nHost: dns.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n {\n \"domain\": \"www.example.com\",\n \"recordHash\": \"e86155f805706f45b4820db76f0dd71f\",\n \"isProtected\": false,\n \"rdata\": \"v=spf1 include:example.net -all\",\n \"rrsetVersion\": \"10\",\n \"rtype\": \"TXT\",\n \"ttl\": 60\n }\n ]\n}\n" x-related-resource: '#/definitions/RRSet' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRRSetDetails' description: A full list of records for the RRSet. required: true components: parameters: ViewsSortByQueryParam: description: The field by which to sort views. in: query name: sortBy schema: type: string enum: - displayName - timeCreated default: timeCreated NameQueryParam: description: The name of a resource. in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 DomainNameContainsQueryParam: description: 'Search by domain. Will match any record whose domain (case-insensitive) contains the provided value. ' in: query name: domainContains x-default-description: 'null' schema: type: string ZoneIdQueryParam: description: 'Search by zone OCID. Will match any resource whose zone ID matches the provided value. ' in: query name: zoneId x-default-description: 'null' schema: type: string IfUnmodifiedSinceHeader: description: 'The `If-Unmodified-Since` header field makes the request method conditional on the selected representation''s last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. ' in: header name: If-Unmodified-Since x-default-description: 'null' schema: type: string IfNoneMatchHeader: description: 'The `If-None-Match` header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is `*`, or having a selected representation with an entity-tag that does not match any of those listed in the field-value. ' in: header name: If-None-Match x-default-description: 'null' schema: type: string TimeCreatedGreaterThanOrEqualToQueryParam: description: 'An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states all returned resources were created on or after the indicated time. ' in: query name: timeCreatedGreaterThanOrEqualTo x-default-description: 'null' schema: type: string format: date-time IfMatchHeader: description: 'The `If-Match` header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is `*`, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value. ' in: header name: If-Match x-default-description: 'null' schema: type: string SortOrderQueryParam: description: 'The order to sort the resources. ' in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC default: DESC ZoneNameOrIdPathParam: description: The name or OCID of the target zone. in: path name: zoneNameOrId required: true schema: type: string ZonesSortByQueryParam: description: The field by which to sort zones. in: query name: sortBy schema: type: string enum: - name - zoneType - timeCreated default: timeCreated TsigKeyIdPathParam: description: The OCID of the target TSIG key. in: path name: tsigKeyId required: true schema: type: string SteeringPolicyIdQueryParam: description: 'Search by steering policy OCID. Will match any resource whose steering policy ID matches the provided value. ' in: query name: steeringPolicyId x-default-description: 'null' schema: type: string ViewIdPathParam: description: The OCID of the target view. in: path name: viewId required: true schema: type: string CompartmentIdDeprecatedQueryParam: description: 'The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. ' in: query name: compartmentId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 LifecycleStateQueryParam: description: The state of a resource. in: query name: lifecycleState schema: type: string enum: - ACTIVE - CREATING - DELETED - DELETING - FAILED - UPDATING default: ACTIVE ResolverEndpointsSortByQueryParam: description: The field by which to sort resolver endpoints. in: query name: sortBy schema: type: string enum: - name - timeCreated default: timeCreated DomainNameQueryParam: description: 'Search by domain. Will match any record whose domain (case-insensitive) equals the provided value. ' in: query name: domain x-default-description: 'null' schema: type: string ResolverEndpointLifecycleStateQueryParam: description: The state of a resource. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/ResolverEndpointSummary/lifecycleState' schema: type: string ZoneIdPathParam: description: The OCID of the target zone. in: path name: zoneId required: true schema: type: string TemplateQueryParam: description: 'Search by steering template type. Will match any resource whose template type matches the provided value. ' in: query name: template x-default-description: 'null' schema: type: string ResolverLifecycleStateQueryParam: description: The state of a resource. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/ResolverSummary/lifecycleState' schema: type: string SteeringPolicyAttachmentsSortByQueryParam: description: The field by which to sort steering policy attachments. If unspecified, defaults to `timeCreated`. in: query name: sortBy schema: type: string enum: - displayName - timeCreated - domainName default: timeCreated DisplayNameContainsQueryParam: description: 'The partial displayName of a resource. Will match any resource whose name (case-insensitive) contains the provided value. ' in: query name: displayNameContains x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RTypePathParam: description: The type of the target RRSet within the target zone. in: path name: rtype required: true schema: type: string RTypeQueryParam: description: 'Search by record type. Will match any record whose [type](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4) (case-insensitive) equals the provided value. ' in: query name: rtype x-default-description: 'null' schema: type: string ZoneTypeQueryParam: description: 'Search by zone type, `PRIMARY` or `SECONDARY`. Will match any zone whose type equals the provided value. ' in: query name: zoneType x-default-description: 'null' schema: type: string enum: - PRIMARY - SECONDARY ViewLifecycleStateQueryParam: description: The state of a resource. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/ViewSummary/lifecycleState' schema: type: string TsigKeysLifecycleStateQueryParam: description: The state of a resource. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/TsigKeySummary/lifecycleState' schema: type: string SteeringPoliciesSortByQueryParam: description: The field by which to sort steering policies. If unspecified, defaults to `timeCreated`. in: query name: sortBy schema: type: string enum: - displayName - timeCreated - template default: timeCreated ZoneVersionQueryParam: description: 'The version of the zone for which data is requested. ' in: query name: zoneVersion x-default-description: 'null' schema: type: string TsigKeysSortByQueryParam: description: The field by which to sort TSIG keys. If unspecified, defaults to `timeCreated`. in: query name: sortBy schema: type: string enum: - name - timeCreated default: timeCreated SteeringPoliciesLifecycleStateQueryParam: description: The state of a resource. in: query name: lifecycleState x-obmcs-enumref: '#/definitions/SteeringPolicySummary/lifecycleState' schema: type: string default: ACTIVE ZoneNameContainsQueryParam: description: 'Search by zone name. Will match any zone whose name (case-insensitive) contains the provided value. ' in: query name: nameContains x-default-description: 'null' schema: type: string HealthCheckMonitorIdQueryParam: description: 'Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value. ' in: query name: healthCheckMonitorId x-default-description: 'null' schema: type: string SteeringPolicyAttachmentIdPathParam: description: The OCID of the target steering policy attachment. in: path name: steeringPolicyAttachmentId required: true schema: type: string DisplayNameQueryParam: description: The displayName of a resource. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 DnssecStateQueryParam: description: 'Search for zones that have the given `DnssecState`. ' in: query name: dnssecState x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ZoneDnssecState' schema: type: string enum: - ENABLED - DISABLED IdQueryParam: description: The OCID of a resource. in: query name: id x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ViewIdQueryParam: description: The OCID of the view the resource is associated with. in: query name: viewId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: 'The value of the `opc-next-page` response header from the previous "List" call. ' in: query name: page x-default-description: 'null' schema: type: string maxLength: 512 minLength: 1 IfModifiedSinceHeader: description: 'The `If-Modified-Since` header field makes a GET or HEAD request method conditional on the selected representation''s modification date being more recent than the date provided in the field-value. Transfer of the selected representation''s data is avoided if that data has not changed. ' in: header name: If-Modified-Since x-default-description: 'null' schema: type: string AttachmentLifecycleStateQueryParam: description: The state of a resource. in: query name: lifecycleState x-obmcs-enumref: '#/definitions/SteeringPolicyAttachmentSummary/lifecycleState' schema: type: string default: ACTIVE ResolversSortByQueryParam: description: The field by which to sort resolvers. in: query name: sortBy schema: type: string enum: - displayName - timeCreated default: timeCreated ResolverIdPathParam: description: The OCID of the target resolver. in: path name: resolverId required: true schema: type: string ResolverEndpointNamePathParam: description: The name of the target resolver endpoint. in: path name: resolverEndpointName required: true schema: type: string OpcRequestIdHeader: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id x-default-description: 'null' schema: type: string maxLength: 98 minLength: 1 TsigKeyIdQueryParam: description: 'Search for zones that are associated with a TSIG key. ' in: query name: tsigKeyId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 DomainNamePathParam: description: The target fully-qualified domain name (FQDN) within the target zone. in: path name: domain required: true schema: type: string RecordSortOrderQueryParam: description: 'The order to sort the resources. ' in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC default: ASC OpcRetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). ' in: header name: opc-retry-token x-default-description: 'null' schema: type: string maxLength: 64 minLength: 1 CompartmentIdQueryParam: description: The OCID of the compartment the resource belongs to. in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: 'The maximum number of items to return in a page of the collection. ' in: query name: limit schema: type: integer format: int64 default: 50 maximum: 100 minimum: 1 TimeCreatedLessThanQueryParam: description: 'An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states all returned resources were created before the indicated time. ' in: query name: timeCreatedLessThan x-default-description: 'null' schema: type: string format: date-time ScopeQueryParam: description: 'Specifies to operate only on resources that have a matching DNS scope. ' in: query name: scope x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/Scope' schema: type: string enum: - GLOBAL - PRIVATE PolicyIdPathParam: description: The OCID of the target steering policy. in: path name: steeringPolicyId required: true schema: type: string ZoneRecordsSortByQueryParam: description: The field by which to sort records. in: query name: sortBy schema: type: string enum: - domain - rtype - ttl default: domain ZoneNameQueryParam: description: 'A case-sensitive filter for zone names. Will match any zone with a name that equals the provided value. ' in: query name: name x-default-description: 'null' schema: type: string ZoneViewIdQueryParam: description: The OCID of the view the zone is associated with. Required when accessing a private zone by name. in: query name: viewId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 DomainRecordsSortByQueryParam: description: The field by which to sort records. in: query name: sortBy schema: type: string enum: - rtype - ttl default: rtype schemas: ChangeTsigKeyCompartmentDetails: properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the TSIG key should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object RecordOperation: description: 'An extension of the existing record resource, describing either a precondition, an add, or a remove. Preconditions check all fields, including read-only data like `recordHash` and `rrsetVersion`. ' properties: domain: description: 'The fully qualified domain name where the record can be located. ' maxLength: 254 minLength: 1 type: string isProtected: description: 'A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed. ' type: boolean operation: default: ADD description: "A description of how a record relates to a PATCH operation.\n\n\n- `REQUIRE` indicates a precondition that record data **must** already exist.\n- `PROHIBIT` indicates a precondition that record data **must not** already exist.\n- `ADD` indicates that record data **must** exist after successful application.\n- `REMOVE` indicates that record data **must not** exist after successful application.\n\n\n **Note:** `ADD` and `REMOVE` operations can succeed even if\n they require no changes when applied, such as when the described\n records are already present or absent.\n\n\n **Note:** `ADD` and `REMOVE` operations can describe changes for\n more than one record.\n\n\n **Example:** `{ \"domain\": \"www.example.com\", \"rtype\": \"AAAA\", \"ttl\": 60 }`\n specifies a new TTL for every record in the www.example.com AAAA RRSet.\n" enum: - REQUIRE - PROHIBIT - ADD - REMOVE type: string rdata: description: 'The record''s data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm) ' type: string recordHash: description: 'A unique identifier for the record within its zone. ' type: string rrsetVersion: description: 'The latest version of the record''s zone in which its RRSet differs from the preceding version. ' type: string rtype: description: 'The type of DNS record, such as A or CNAME. For more information, see [Resource Record (RR) TYPEs](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). ' type: string ttl: description: 'The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended. ' format: int32 maximum: 604800 minimum: 0 type: integer type: object UpdateRRSetDetails: properties: items: items: $ref: '#/components/schemas/RecordDetails' type: array type: object Error: properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. See [API Errors](/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error string. type: string required: - code - message type: object ChangeSteeringPolicyCompartmentDetails: properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the steering policy should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateTsigKeyDetails: description: 'The body for updating a TSIG key. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object type: object ResolverSummary: description: 'An OCI DNS resolver. If the resolver has an attached VCN, the VCN will attempt to answer queries based on the attached views in priority order. If the query does not match any of the attached views, the query will be evaluated against the default view. If the default view does not match, the rules will be evaluated in priority order. If no rules match the query, answers come from Internet DNS. A resolver may have a maximum of 10 resolver endpoints. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: attachedVcnId: description: 'The OCID of the attached VCN. ' maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the owning compartment. maxLength: 255 minLength: 1 type: string defaultViewId: description: 'The OCID of the default view. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'The display name of the resolver. ' maxLength: 255 minLength: 1 type: string x-default-description: 'This field will be set to a value in the format "dnsresolver" where currentTimestampUTC is in ISO 8601 basic format "yyyyMMddHHmmss". ' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object id: description: The OCID of the resolver. maxLength: 255 minLength: 1 type: string isProtected: description: 'A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. ' type: boolean lifecycleState: description: The current state of the resource. enum: - ACTIVE - CREATING - DELETED - DELETING - FAILED - UPDATING type: string self: description: The canonical absolute URL of the resource. format: url type: string timeCreated: description: 'The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string required: - compartmentId - displayName - freeformTags - definedTags - id - timeCreated - timeUpdated - lifecycleState - self - isProtected type: object ResolverRule: description: 'A rule for a resolver. Specifying both qnameCoverConditions and clientAddressConditions is not allowed. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' discriminator: propertyName: action properties: action: description: 'The action determines the behavior of the rule. If a query matches a supplied condition, the action will apply. If there are no conditions on the rule, all queries are subject to the specified action. * `FORWARD` - Matching requests will be forwarded from the source interface to the destination address. ' enum: - FORWARD type: string clientAddressConditions: description: 'A list of CIDR blocks. In order for the rule action to apply, the query must come from a client within one of the CIDR blocks. ' example: - 198.51.100.0/24 items: type: string maxItems: 10 type: array qnameCoverConditions: description: 'A list of domain names. In order for the rule action to apply, the query must either match or be a subdomain of one of the listed domains. ' example: - internal.example.com items: format: hostname type: string maxItems: 10 type: array required: - action - clientAddressConditions - qnameCoverConditions type: object SteeringPolicyAttachment: description: 'An attachment between a steering policy and a domain. An attachment constructs DNS responses using its steering policy instead of the records at its defined domain. Only records of the policy''s covered rtype are blocked at the domain. A domain can have a maximum of one attachment covering any given rtype. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The OCID of the compartment containing the steering policy attachment. maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name for the steering policy attachment. Does not have to be unique and can be changed. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string domainName: description: The attached domain within the attached zone. type: string id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the resource. enum: - CREATING - ACTIVE - DELETING type: string rtypes: description: 'The record types covered by the attachment at the domain. The set of record types is determined by aggregating the record types from the answers defined in the steering policy. ' items: type: string type: array self: description: The canonical absolute URL of the resource. format: url type: string steeringPolicyId: description: The OCID of the attached steering policy. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the resource was created, expressed in RFC 3339 timestamp format. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string zoneId: description: The OCID of the attached zone. Must be a public zone. maxLength: 255 minLength: 1 type: string required: - steeringPolicyId - zoneId - domainName - displayName - rtypes - compartmentId - self - id - timeCreated - lifecycleState type: object RecordDetails: description: A DNS resource record. For more information about records, see [RFC 1034](https://tools.ietf.org/html/rfc1034#section-3.6). properties: domain: description: 'The fully qualified domain name where the record can be located. ' maxLength: 254 minLength: 1 type: string isProtected: description: 'A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed. ' type: boolean rdata: description: 'The record''s data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm) ' type: string recordHash: description: 'A unique identifier for the record within its zone. ' type: string rrsetVersion: description: 'The latest version of the record''s zone in which its RRSet differs from the preceding version. ' type: string rtype: description: 'The type of DNS record, such as A or CNAME. For more information, see [Resource Record (RR) TYPEs](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). ' type: string ttl: description: 'The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended. ' format: int32 maximum: 604800 minimum: 0 type: integer required: - domain - ttl - rtype - rdata type: object ResolverEndpointSummary: description: 'An OCI DNS resolver endpoint. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' discriminator: propertyName: endpointType properties: compartmentId: description: 'The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver''s compartment is changed. ' maxLength: 255 minLength: 1 type: string endpointType: default: VNIC description: 'The type of resolver endpoint. VNIC is currently the only supported type. ' enum: - VNIC type: string forwardingAddress: description: 'An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true. ' type: string isForwarding: description: 'A Boolean flag indicating whether or not the resolver endpoint is for forwarding. ' type: boolean isListening: description: 'A Boolean flag indicating whether or not the resolver endpoint is for listening. ' type: boolean lifecycleState: description: The current state of the resource. enum: - ACTIVE - CREATING - DELETED - DELETING - FAILED - UPDATING type: string listeningAddress: description: 'An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true. ' type: string name: description: 'The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver. ' maxLength: 255 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string self: description: The canonical absolute URL of the resource. format: url type: string timeCreated: description: 'The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string required: - compartmentId - isForwarding - isListening - lifecycleState - name - self - timeCreated - timeUpdated type: object Nameserver: description: A server that has been set up to answer DNS queries for a zone. properties: hostname: description: The hostname of the nameserver. type: string required: - hostname type: object PromoteZoneDnssecKeyVersionDetails: description: 'Details for promoting a `DnssecKeyVersion` on a zone. ' properties: dnssecKeyVersionUuid: description: 'The UUID of the `DnssecKeyVersion` that is being promoted. ' maxLength: 36 minLength: 36 type: string required: - dnssecKeyVersionUuid type: object ChangeZoneCompartmentDetails: properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the zone should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ResolverEndpoint: description: 'An OCI DNS resolver endpoint. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' discriminator: propertyName: endpointType properties: compartmentId: description: 'The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver''s compartment is changed. ' maxLength: 255 minLength: 1 type: string endpointType: default: VNIC description: 'The type of resolver endpoint. VNIC is currently the only supported type. ' enum: - VNIC type: string forwardingAddress: description: 'An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true. ' type: string isForwarding: description: 'A Boolean flag indicating whether or not the resolver endpoint is for forwarding. ' type: boolean isListening: description: 'A Boolean flag indicating whether or not the resolver endpoint is for listening. ' type: boolean lifecycleState: description: The current state of the resource. enum: - ACTIVE - CREATING - DELETED - DELETING - FAILED - UPDATING type: string listeningAddress: description: 'An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true. ' type: string name: description: 'The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver. ' maxLength: 255 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string self: description: The canonical absolute URL of the resource. format: url type: string timeCreated: description: 'The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string required: - compartmentId - isForwarding - isListening - lifecycleState - name - self - timeCreated - timeUpdated type: object RRSet: description: 'A collection of DNS records of the same domain and type. For more information about record types, see [Resource Record (RR) TYPEs](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). ' properties: items: items: $ref: '#/components/schemas/Record' type: array required: - items type: object SteeringPolicyAnswer: description: 'DNS record data with metadata for processing in a steering policy. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' example: isDisabled: false name: Phoenix LB 1 pool: na-west rdata: 192.0.2.1 rtype: A properties: isDisabled: description: "Set this property to `true` to indicate that the answer is administratively disabled,\nsuch as when the corresponding server is down for maintenance. An answer's `isDisabled`\nproperty can be referenced in `answerCondition` properties in rules using `answer.isDisabled`.\n\n**Example:**\n \"rules\": [\n {\n \"ruleType\": \"FILTER\",\n \"defaultAnswerData\": [\n {\n \"answerCondition\": \"answer.isDisabled != true\",\n \"shouldKeep\": true\n }\n ]\n },\n" type: boolean name: description: "A user-friendly name for the answer, unique within the steering policy.\nAn answer's `name` property can be referenced in `answerCondition` properties\nof rules using `answer.name`.\n\n**Example:**\n\n \"rules\": [\n {\n \"ruleType\": \"FILTER\",\n \"defaultAnswerData\": [\n {\n \"answerCondition\": \"answer.name == 'server 1'\",\n \"shouldKeep\": true\n }\n ]\n }\n ]\n" maxLength: 255 minLength: 1 type: string pool: description: "The freeform name of a group of one or more records in which this record is included,\nsuch as \"LAX data center\". An answer's `pool` property can be referenced in `answerCondition`\nproperties of rules using `answer.pool`.\n\n**Example:**\n\n \"rules\": [\n {\n \"ruleType\": \"FILTER\",\n \"defaultAnswerData\": [\n {\n \"answerCondition\": \"answer.pool == 'US East Servers'\",\n \"shouldKeep\": true\n }\n ]\n }\n ]\n" maxLength: 255 minLength: 1 type: string rdata: description: 'The record''s data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm). ' type: string rtype: description: 'The type of DNS record, such as A or CNAME. Only A, AAAA, and CNAME are supported. For more information, see [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm). ' type: string required: - name - rtype - rdata type: object ExternalMaster: description: 'An external master name server used as the source of zone data. ' properties: address: description: The server's IP address (IPv4 or IPv6). type: string port: default: 53 description: 'The server''s port. Port value must be a value of 53, otherwise omit the port value. ' type: integer tsigKeyId: description: The OCID of the TSIG key. maxLength: 255 minLength: 1 type: string required: - address type: object UpdateViewDetails: description: 'The body for updating an existing view. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'The display name of the view. ' maxLength: 255 minLength: 1 type: string x-default-description: 'This field will be set to a value in the format "dnsview" where currentTimestampUTC is in ISO 8601 basic format "yyyyMMddHHmmss". ' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object type: object PatchDomainRecordsDetails: properties: items: items: $ref: '#/components/schemas/RecordOperation' type: array type: object DnssecKeyVersionDsData: description: 'Data for a parent zone DS record corresponding to this key-signing key (KSK). ' properties: digestType: description: 'The type of the digest associated with the rdata. ' enum: - SHA_256 type: string x-obmcs-top-level-enum: '#/definitions/DnssecDigestType' rdata: description: 'Presentation-format DS record data that must be added to the parent zone. For more information about RDATA, see [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm) ' example: 60485 5 1 2BB183AF5F22588179A53B0A98631FAD1A292118 type: string type: object CreateResolverEndpointDetails: description: 'The body for defining a new resolver endpoint. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' discriminator: propertyName: endpointType properties: endpointType: default: VNIC description: 'The type of resolver endpoint. VNIC is currently the only supported type. ' enum: - VNIC type: string forwardingAddress: description: 'An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true. ' type: string isForwarding: description: 'A Boolean flag indicating whether or not the resolver endpoint is for forwarding. ' type: boolean isListening: description: 'A Boolean flag indicating whether or not the resolver endpoint is for listening. ' type: boolean listeningAddress: description: 'An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true. ' type: string name: description: 'The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver. ' maxLength: 255 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string required: - name - isForwarding - isListening type: object KskDnssecKeyVersion: description: 'A key signing key (KSK) version. The version information contains timing and configuration data corresponding to the KSK that is used to apply DNSSEC on the zone. ' properties: algorithm: description: 'The signing algorithm used for the key. ' enum: - RSASHA256 type: string x-obmcs-top-level-enum: '#/definitions/DnssecSigningAlgorithm' dsData: description: 'An array of data for DS records corresponding with this key version. An entry will exist for each supported DS digest algorithm. ' items: $ref: '#/components/schemas/DnssecKeyVersionDsData' minLength: 1 type: array keyTag: description: 'The key tag associated with the `DnssecKeyVersion`. This key tag will be present in the RRSIG and DS records associated with the key material for this `DnssecKeyVersion`. For more information about key tags, see [RFC 4034](https://tools.ietf.org/html/rfc4034). ' maximum: 65535 minimum: 0 type: integer lengthInBytes: description: 'The length of the corresponding private key in bytes, expressed as an integer. ' format: int32 type: integer predecessorDnssecKeyVersionUuid: description: 'When populated, this is the UUID of the `DnssecKeyVersion` that this `DnssecKeyVersion` will replace or has replaced. ' maxLength: 36 minLength: 36 type: string successorDnssecKeyVersionUuid: description: 'When populated, this is the UUID of the `DnssecKeyVersion` that will replace, or has replaced, this `DnssecKeyVersion`. ' maxLength: 36 minLength: 36 type: string timeActivated: description: 'The date and time the key version went, or will go, active, expressed in RFC 3339 timestamp format. This is when the key material will be used to generate RRSIGs. **Example:** `2016-07-22T17:23:59:00Z` ' format: date-time type: string timeCreated: description: 'The date and time the key version was created, expressed in RFC 3339 timestamp format. **Example:** `2016-07-22T17:23:59:00Z` ' format: date-time type: string timeExpired: description: 'The date and time at which the recommended key version publication/activation lifetime ends, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY should no longer exist in zone contents and no longer be used to generate RRSIGs. For a key sigining key (KSK), if `PromoteZoneDnssecKeyVersion` has not been called on this `DnssecKeyVersion`''s successor then it will remain active for arbitrarily long past its recommended lifetime. This prevents service disruption at the potential increased risk of key compromise. **Example:** `2016-07-22T17:23:59:00Z` ' format: date-time type: string timeInactivated: description: 'The date and time the key version went, or will go, inactive, expressed in RFC 3339 timestamp format. This is when the key material will no longer be used to generate RRSIGs. For a key signing key (KSK) `DnssecKeyVersion`, this is populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. **Example:** `2016-07-22T17:23:59:00Z` ' format: date-time type: string timePromoted: description: 'The date and time the key version was promoted expressed in RFC 3339 timestamp format. **Example:** `2016-07-22T17:23:59:00Z` ' format: date-time type: string timePublished: description: 'The date and time the key version was, or will be, published, expressed in RFC 3339 timestamp format. This is when the zone contents will include a DNSKEY record corresponding to the key material. **Example:** `2016-07-22T17:23:59:00Z` ' format: date-time type: string timeUnpublished: description: 'The date and time the key version was, or will be, unpublished, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY will be removed from zone contents. For a key signing key (KSK) `DnssecKeyVersion`, this is populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. **Example:** `2016-07-22T17:23:59:00Z` ' format: date-time type: string uuid: description: 'The UUID of the `DnssecKeyVersion`. ' maxLength: 36 minLength: 36 type: string type: object ResolverRuleDetails: description: 'A rule for a resolver. Specifying both qnameCoverConditions and clientAddressConditions is not allowed. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' discriminator: propertyName: action properties: action: description: 'The action determines the behavior of the rule. If a query matches a supplied condition, the action will apply. If there are no conditions on the rule, all queries are subject to the specified action. * `FORWARD` - Matching requests will be forwarded from the source interface to the destination address. ' enum: - FORWARD type: string clientAddressConditions: description: 'A list of CIDR blocks. In order for the rule action to apply, the query must come from a client within one of the CIDR blocks. ' example: - 198.51.100.0/24 items: type: string maxItems: 10 type: array qnameCoverConditions: description: 'A list of domain names. In order for the rule action to apply, the query must either match or be a subdomain of one of the listed domains. ' example: - internal.example.com items: format: hostname type: string maxItems: 10 type: array required: - action type: object CreateSteeringPolicyDetails: description: 'The body for defining a new steering policy. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: answers: description: 'The set of all answers that can potentially issue from the steering policy. ' items: $ref: '#/components/schemas/SteeringPolicyAnswer' type: array compartmentId: description: The OCID of the compartment containing the steering policy. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object healthCheckMonitorId: description: 'The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with `rdata` matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with `rdata` not matching any monitored endpoint will be assumed healthy. **Note:** To use the Health Check monitoring feature in a steering policy, a monitor must be created using the Health Checks service first. For more information on how to create a monitor, please see [Managing Health Checks](/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm). ' maxLength: 255 minLength: 1 type: string rules: description: 'The series of rules that will be processed in sequence to reduce the pool of answers to a response for any given request. The first rule receives a shuffled list of all answers, and every other rule receives the list of answers emitted by the one preceding it. The last rule populates the response. ' items: $ref: '#/components/schemas/SteeringPolicyRule' maxItems: 10 type: array template: description: 'A set of predefined rules based on the desired purpose of the steering policy. Each template utilizes Traffic Management''s rules in a different order to produce the desired results when answering DNS queries. **Example:** The `FAILOVER` template determines answers by filtering the policy''s answers using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`, and `LIMIT`. This gives the domain dynamic failover capability. It is **strongly recommended** to use a template other than `CUSTOM` when creating a steering policy. All templates require the rule order to begin with an unconditional `FILTER` rule that keeps answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`. The last rule of a template must must be a `LIMIT` rule. For more information about templates and code examples, see [Traffic Management API Guide](/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). **Template Types** * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers to serve. If an endpoint fails a health check, the answer for that endpoint will be removed from the list of available answers until the endpoint is detected as healthy. * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights. * `ROUTE_BY_GEO` - Answers DNS queries based on the query''s geographic location. For a list of geographic locations to route by, see [Traffic Management Geographic Locations](/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm). * `ROUTE_BY_ASN` - Answers DNS queries based on the query''s originating ASN. * `ROUTE_BY_IP` - Answers DNS queries based on the query''s IP address. * `CUSTOM` - Allows a customized configuration of rules. ' enum: - FAILOVER - LOAD_BALANCE - ROUTE_BY_GEO - ROUTE_BY_ASN - ROUTE_BY_IP - CUSTOM type: string ttl: default: 30 description: 'The Time To Live (TTL) for responses from the steering policy, in seconds. If not specified during creation, a value of 30 seconds will be used. ' format: int32 maximum: 604800 minimum: 1 type: integer required: - compartmentId - displayName - template type: object UpdateResolverEndpointDetails: description: 'The body for updating an existing resolver endpoint. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' discriminator: propertyName: endpointType properties: endpointType: default: VNIC description: 'The type of resolver endpoint. VNIC is currently the only supported type. ' enum: - VNIC type: string type: object ZskDnssecKeyVersion: description: 'A zone signing key (ZSK) version. The version information contains timing and configuration data for the ZSK that is used to apply DNSSEC on the zone. ' properties: algorithm: description: 'The signing algorithm used for the key. ' enum: - RSASHA256 type: string x-obmcs-top-level-enum: '#/definitions/DnssecSigningAlgorithm' keyTag: description: 'The key tag associated with the `DnssecKeyVersion`. This key tag will be present in the RRSIG and DS records associated with the key material for this `DnssecKeyVersion`. For more information about key tags, see [RFC 4034](https://tools.ietf.org/html/rfc4034). ' maximum: 65535 minimum: 0 type: integer lengthInBytes: description: 'The length of the corresponding private key in bytes, expressed as an integer. ' format: int32 type: integer predecessorDnssecKeyVersionUuid: description: 'When populated, this is the UUID of the `DnssecKeyVersion` that this `DnssecKeyVersion` will replace or has replaced. ' maxLength: 36 minLength: 36 type: string successorDnssecKeyVersionUuid: description: 'When populated, this is the UUID of the `DnssecKeyVersion` that will replace, or has replaced, this `DnssecKeyVersion`. ' maxLength: 36 minLength: 36 type: string timeActivated: description: 'The date and time the key version went, or will go, active, expressed in RFC 3339 timestamp format. This is when the key material will be used to generate RRSIGs. **Example:** `2016-07-22T17:23:59:00Z` ' format: date-time type: string timeCreated: description: 'The date and time the key version was created, expressed in RFC 3339 timestamp format. **Example:** `2016-07-22T17:23:59:00Z` ' format: date-time type: string timeExpired: description: 'The date and time at which the recommended key version publication/activation lifetime ends, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY should no longer exist in zone contents and no longer be used to generate RRSIGs. For a key sigining key (KSK), if `PromoteZoneDnssecKeyVersion` has not been called on this `DnssecKeyVersion`''s successor then it will remain active for arbitrarily long past its recommended lifetime. This prevents service disruption at the potential increased risk of key compromise. **Example:** `2016-07-22T17:23:59:00Z` ' format: date-time type: string timeInactivated: description: 'The date and time the key version went, or will go, inactive, expressed in RFC 3339 timestamp format. This is when the key material will no longer be used to generate RRSIGs. For a key signing key (KSK) `DnssecKeyVersion`, this is populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. **Example:** `2016-07-22T17:23:59:00Z` ' format: date-time type: string timePromoted: description: 'The date and time the key version was promoted expressed in RFC 3339 timestamp format. **Example:** `2016-07-22T17:23:59:00Z` ' format: date-time type: string timePublished: description: 'The date and time the key version was, or will be, published, expressed in RFC 3339 timestamp format. This is when the zone contents will include a DNSKEY record corresponding to the key material. **Example:** `2016-07-22T17:23:59:00Z` ' format: date-time type: string timeUnpublished: description: 'The date and time the key version was, or will be, unpublished, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY will be removed from zone contents. For a key signing key (KSK) `DnssecKeyVersion`, this is populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. **Example:** `2016-07-22T17:23:59:00Z` ' format: date-time type: string uuid: description: 'The UUID of the `DnssecKeyVersion`. ' maxLength: 36 minLength: 36 type: string type: object SteeringPolicySummary: description: 'A DNS steering policy. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The OCID of the compartment containing the steering policy. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object healthCheckMonitorId: description: 'The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with `rdata` matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with `rdata` not matching any monitored endpoint will be assumed healthy. **Note:** To use the Health Check monitoring feature in a steering policy, a monitor must be created using the Health Checks service first. For more information on how to create a monitor, please see [Managing Health Checks](/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm). ' maxLength: 255 minLength: 1 type: string id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the resource. enum: - ACTIVE - CREATING - DELETED - DELETING type: string self: description: The canonical absolute URL of the resource. format: url type: string template: description: 'A set of predefined rules based on the desired purpose of the steering policy. Each template utilizes Traffic Management''s rules in a different order to produce the desired results when answering DNS queries. **Example:** The `FAILOVER` template determines answers by filtering the policy''s answers using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`, and `LIMIT`. This gives the domain dynamic failover capability. It is **strongly recommended** to use a template other than `CUSTOM` when creating a steering policy. All templates require the rule order to begin with an unconditional `FILTER` rule that keeps answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`. The last rule of a template must must be a `LIMIT` rule. For more information about templates and code examples, see [Traffic Management API Guide](/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). **Template Types** * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers to serve. If an endpoint fails a health check, the answer for that endpoint will be removed from the list of available answers until the endpoint is detected as healthy. * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights. * `ROUTE_BY_GEO` - Answers DNS queries based on the query''s geographic location. For a list of geographic locations to route by, see [Traffic Management Geographic Locations](/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm). * `ROUTE_BY_ASN` - Answers DNS queries based on the query''s originating ASN. * `ROUTE_BY_IP` - Answers DNS queries based on the query''s IP address. * `CUSTOM` - Allows a customized configuration of rules. ' enum: - FAILOVER - LOAD_BALANCE - ROUTE_BY_GEO - ROUTE_BY_ASN - ROUTE_BY_IP - CUSTOM type: string timeCreated: description: 'The date and time the resource was created, expressed in RFC 3339 timestamp format. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string ttl: description: 'The Time To Live (TTL) for responses from the steering policy, in seconds. If not specified during creation, a value of 30 seconds will be used. ' format: int32 maximum: 604800 minimum: 1 type: integer required: - compartmentId - displayName - ttl - template - freeformTags - definedTags - self - id - timeCreated - lifecycleState type: object Zone: description: 'A DNS zone. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The OCID of the compartment containing the zone. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object dnssecConfig: $ref: '#/components/schemas/DnssecConfig' dnssecState: default: DISABLED description: 'The state of DNSSEC on the zone. For DNSSEC to function, every parent zone in the DNS tree up to the top-level domain (or an independent trust anchor) must also have DNSSEC correctly set up. After enabling DNSSEC, you must add a DS record to the zone''s parent zone containing the `KskDnssecKeyVersion` data. You can find the DS data in the `dsData` attribute of the `KskDnssecKeyVersion`. Then, use the `PromoteZoneDnssecKeyVersion` operation to promote the `KskDnssecKeyVersion`. New `KskDnssecKeyVersion`s are generated annually, a week before the existing `KskDnssecKeyVersion`''s expiration. To rollover a `KskDnssecKeyVersion`, you must replace the parent zone''s DS record containing the old `KskDnssecKeyVersion` data with the data from the new `KskDnssecKeyVersion`. To remove the old DS record without causing service disruption, wait until the old DS record''s TTL has expired, and the new DS record has propagated. After the DS replacement has been completed, then the `PromoteZoneDnssecKeyVersion` operation must be called. Metrics are emitted in the `oci_dns` namespace daily for each `KskDnssecKeyVersion` indicating how many days are left until expiration. We recommend that you set up alarms and notifications for KskDnssecKeyVersion expiration so that the necessary parent zone updates can be made and the `PromoteZoneDnssecKeyVersion` operation can be called. Enabling DNSSEC results in additional records in DNS responses which increases their size and can cause higher response latency. For more information, see [DNSSEC](/iaas/Content/DNS/Concepts/dnssec.htm). ' enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/ZoneDnssecState' externalDownstreams: description: 'External secondary servers for the zone. This field is currently not supported when `zoneType` is `SECONDARY` or `scope` is `PRIVATE`. ' items: $ref: '#/components/schemas/ExternalDownstream' type: array externalMasters: description: 'External master servers for the zone. `externalMasters` becomes a required parameter when the `zoneType` value is `SECONDARY`. ' items: $ref: '#/components/schemas/ExternalMaster' type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object id: description: The OCID of the zone. maxLength: 255 minLength: 1 type: string isProtected: description: 'A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. ' type: boolean lifecycleState: description: The current state of the zone resource. enum: - ACTIVE - CREATING - DELETED - DELETING - FAILED - UPDATING type: string name: description: The name of the zone. maxLength: 254 minLength: 1 type: string nameservers: description: The authoritative nameservers for the zone. items: $ref: '#/components/schemas/Nameserver' type: array resolutionMode: default: STATIC description: 'The resolution mode of a zone defines behavior related to how query responses can be handled. See [Private DNS Zone Transparency](/Content/DNS/Tasks/privatedns.htm#use-cases__resolution) for more information. ' enum: - STATIC - TRANSPARENT - RTYPE_TRANSPARENT type: string x-obmcs-top-level-enum: '#/definitions/ZoneResolutionMode' scope: description: The scope of the zone. enum: - GLOBAL - PRIVATE type: string x-obmcs-top-level-enum: '#/definitions/Scope' self: description: The canonical absolute URL of the resource. format: url type: string serial: description: 'The current serial of the zone. As seen in the zone''s SOA record. ' format: int64 type: integer timeCreated: description: 'The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string version: description: 'Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone''s SOA record is derived. ' type: string viewId: description: 'The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view. ' maxLength: 255 minLength: 1 type: string zoneTransferServers: description: 'The OCI nameservers that transfer the zone data with external nameservers. ' items: $ref: '#/components/schemas/ZoneTransferServer' type: array zoneType: description: 'The type of the zone. Must be either `PRIMARY` or `SECONDARY`. `SECONDARY` is only supported for GLOBAL zones. ' enum: - PRIMARY - SECONDARY type: string required: - name - zoneType - compartmentId - freeformTags - definedTags - externalMasters - externalDownstreams - id - version - serial - lifecycleState - self - scope - isProtected - timeCreated - nameservers - dnssecState - resolutionMode type: object Resolver: description: 'An OCI DNS resolver. If the resolver has an attached VCN, the VCN will attempt to answer queries based on the attached views in priority order. If the query does not match any of the attached views, the query will be evaluated against the default view. If the default view does not match, the rules will be evaluated in priority order. If no rules match the query, answers come from Internet DNS. A resolver may have a maximum of 10 resolver endpoints. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: attachedVcnId: description: 'The OCID of the attached VCN. ' maxLength: 255 minLength: 1 type: string attachedViews: description: The attached views. Views are evaluated in order. items: $ref: '#/components/schemas/AttachedView' maxItems: 50 type: array compartmentId: description: The OCID of the owning compartment. maxLength: 255 minLength: 1 type: string defaultViewId: description: 'The OCID of the default view. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'The display name of the resolver. ' maxLength: 255 minLength: 1 type: string x-default-description: 'This field will be set to a value in the format "dnsresolver" where currentTimestampUTC is in ISO 8601 basic format "yyyyMMddHHmmss". ' endpoints: description: 'Read-only array of endpoints for the resolver. ' items: $ref: '#/components/schemas/ResolverEndpointSummary' type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object id: description: The OCID of the resolver. maxLength: 255 minLength: 1 type: string isProtected: description: 'A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. ' type: boolean lifecycleState: description: The current state of the resource. enum: - ACTIVE - CREATING - DELETED - DELETING - FAILED - UPDATING type: string rules: description: 'Rules for the resolver. Rules are evaluated in order, and only the first matching rule will have its action applied. ' items: $ref: '#/components/schemas/ResolverRule' maxItems: 50 type: array self: description: The canonical absolute URL of the resource. format: url type: string timeCreated: description: 'The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string required: - compartmentId - displayName - freeformTags - definedTags - attachedViews - id - timeCreated - timeUpdated - lifecycleState - endpoints - self - isProtected type: object TsigKeySummary: description: A TSIG key. properties: algorithm: description: 'TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see [RFC 4635](https://tools.ietf.org/html/rfc4635#section-2). ' maxLength: 63 minLength: 1 pattern: ^\.$|^(?=([^\\]|\\([^0-9]|[0-9]{3})){1,253}\.?$)(?=.*[^\\0-9.])(([a-zA-Z0-9_-]|\\([\x21-\x2F\x3A-\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\.|$))+$ type: string compartmentId: description: The OCID of the compartment containing the TSIG key. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the resource. enum: - ACTIVE - CREATING - DELETED - DELETING - FAILED - UPDATING type: string name: description: A globally unique domain name identifying the key for a given pair of hosts. maxLength: 63 minLength: 1 pattern: ^\.$|^(?=([^\\]|\\([^0-9]|[0-9]{3})){1,253}\.?$)(?=.*[^\\0-9.])(?=.*\.)(([a-zA-Z0-9_-]|\\([\x21-\x2F\x3A-\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\.|$))+$ type: string self: description: The canonical absolute URL of the resource. format: url type: string timeCreated: description: 'The date and time the resource was created, expressed in RFC 3339 timestamp format. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string required: - algorithm - name - compartmentId - freeformTags - definedTags - id - self - timeCreated - lifecycleState type: object ViewSummary: description: 'An OCI DNS view. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The OCID of the owning compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'The display name of the view. ' maxLength: 255 minLength: 1 type: string x-default-description: 'This field will be set to a value in the format "dnsview" where currentTimestampUTC is in ISO 8601 basic format "yyyyMMddHHmmss". ' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object id: description: The OCID of the view. maxLength: 255 minLength: 1 type: string isProtected: description: 'A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. ' type: boolean lifecycleState: description: The current state of the resource. enum: - ACTIVE - DELETED - DELETING - UPDATING type: string self: description: The canonical absolute URL of the resource. format: url type: string timeCreated: description: 'The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string required: - compartmentId - displayName - freeformTags - definedTags - id - self - timeCreated - timeUpdated - lifecycleState - isProtected type: object PatchZoneRecordsDetails: properties: items: items: $ref: '#/components/schemas/RecordOperation' type: array type: object AttachedViewDetails: description: 'Properties for defining an attached view. ' properties: viewId: description: The OCID of the view. maxLength: 255 minLength: 1 type: string required: - viewId Record: description: 'A DNS resource record. For more information, see [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm). ' properties: domain: description: 'The fully qualified domain name where the record can be located. ' maxLength: 254 minLength: 1 type: string isProtected: description: 'A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed. ' type: boolean rdata: description: 'The record''s data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm) ' type: string recordHash: description: 'A unique identifier for the record within its zone. ' type: string rrsetVersion: description: 'The latest version of the record''s zone in which its RRSet differs from the preceding version. ' type: string rtype: description: 'The type of DNS record, such as A or CNAME. For more information, see [Resource Record (RR) TYPEs](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). ' type: string ttl: description: 'The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended. ' format: int32 maximum: 604800 minimum: 0 type: integer type: object CreateSteeringPolicyAttachmentDetails: description: 'The body for defining an attachment between a steering policy and a domain. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: displayName: description: 'A user-friendly name for the steering policy attachment. Does not have to be unique and can be changed. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string domainName: description: The attached domain within the attached zone. type: string steeringPolicyId: description: The OCID of the attached steering policy. maxLength: 255 minLength: 1 type: string zoneId: description: The OCID of the attached zone. Must be a public zone. maxLength: 255 minLength: 1 type: string required: - steeringPolicyId - zoneId - domainName type: object ZoneTransferServer: description: 'An OCI nameserver that transfers zone data with external nameservers. ' properties: address: description: The server's IP address (IPv4 or IPv6). type: string isTransferDestination: description: 'A Boolean flag indicating whether or not the server is a zone data transfer destination. ' type: boolean isTransferSource: description: 'A Boolean flag indicating whether or not the server is a zone data transfer source. ' type: boolean port: default: 53 description: 'The server''s port. ' type: integer required: - address type: object TsigKey: description: 'A TSIG key. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: algorithm: description: 'TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see [RFC 4635](https://tools.ietf.org/html/rfc4635#section-2). ' maxLength: 63 minLength: 1 pattern: ^\.$|^(?=([^\\]|\\([^0-9]|[0-9]{3})){1,253}\.?$)(?=.*[^\\0-9.])(([a-zA-Z0-9_-]|\\([\x21-\x2F\x3A-\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\.|$))+$ type: string compartmentId: description: The OCID of the compartment containing the TSIG key. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the resource. enum: - ACTIVE - CREATING - DELETED - DELETING - FAILED - UPDATING type: string name: description: A globally unique domain name identifying the key for a given pair of hosts. maxLength: 63 minLength: 1 pattern: ^\.$|^(?=([^\\]|\\([^0-9]|[0-9]{3})){1,253}\.?$)(?=.*[^\\0-9.])(?=.*\.)(([a-zA-Z0-9_-]|\\([\x21-\x2F\x3A-\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\.|$))+$ type: string secret: description: A base64 string encoding the binary shared secret. maxLength: 255 minLength: 1 pattern: ^(([\x20\t\r\n\f]*[A-Za-z0-9+/]){4})*(([\x20\t\r\n\f]*[A-Za-z0-9+/])([\x20\t\r\n\f]*[AQgw])==|([\x20\t\r\n\f]*[A-Za-z0-9+/]){2}([\x20\t\r\n\f]*[AEIMQUYcgkosw048])=)?[\x20\t\r\n\f]*$ type: string self: description: The canonical absolute URL of the resource. format: url type: string timeCreated: description: 'The date and time the resource was created, expressed in RFC 3339 timestamp format. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was last updated, expressed in RFC 3339 timestamp format. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string required: - algorithm - name - compartmentId - secret - freeformTags - definedTags - id - self - timeCreated - lifecycleState type: object UpdateResolverDetails: description: 'The body for updating an existing resolver. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: attachedViews: description: The attached views. Views are evaluated in order. items: $ref: '#/components/schemas/AttachedViewDetails' maxItems: 50 type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'The display name of the resolver. ' maxLength: 255 minLength: 1 type: string x-default-description: 'This field will be set to a value in the format "dnsresolver" where currentTimestampUTC is in ISO 8601 basic format "yyyyMMddHHmmss". ' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object rules: description: 'Rules for the resolver. Rules are evaluated in order, and only the first matching rule will have its action applied. ' items: $ref: '#/components/schemas/ResolverRuleDetails' maxItems: 50 type: array type: object CreateViewDetails: description: 'The body for defining a new view. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The OCID of the owning compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'The display name of the view. ' maxLength: 255 minLength: 1 type: string x-default-description: 'This field will be set to a value in the format "dnsview" where currentTimestampUTC is in ISO 8601 basic format "yyyyMMddHHmmss". ' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object required: - compartmentId type: object PatchRRSetDetails: properties: items: items: $ref: '#/components/schemas/RecordOperation' type: array type: object View: description: 'An OCI DNS view. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The OCID of the owning compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'The display name of the view. ' maxLength: 255 minLength: 1 type: string x-default-description: 'This field will be set to a value in the format "dnsview" where currentTimestampUTC is in ISO 8601 basic format "yyyyMMddHHmmss". ' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object id: description: The OCID of the view. maxLength: 255 minLength: 1 type: string isProtected: description: 'A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. ' type: boolean lifecycleState: description: The current state of the resource. enum: - ACTIVE - DELETED - DELETING - UPDATING type: string self: description: The canonical absolute URL of the resource. format: url type: string timeCreated: description: 'The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string required: - compartmentId - displayName - freeformTags - definedTags - id - self - timeCreated - timeUpdated - lifecycleState - isProtected type: object AttachedView: description: 'Properties of an attached view. ' properties: viewId: description: The OCID of the view. maxLength: 255 minLength: 1 type: string required: - viewId ChangeViewCompartmentDetails: properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the view should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ZoneSummary: description: 'A DNS zone. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The OCID of the compartment containing the zone. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object dnssecConfig: $ref: '#/components/schemas/DnssecConfig' dnssecState: default: DISABLED description: 'The state of DNSSEC on the zone. For DNSSEC to function, every parent zone in the DNS tree up to the top-level domain (or an independent trust anchor) must also have DNSSEC correctly set up. After enabling DNSSEC, you must add a DS record to the zone''s parent zone containing the `KskDnssecKeyVersion` data. You can find the DS data in the `dsData` attribute of the `KskDnssecKeyVersion`. Then, use the `PromoteZoneDnssecKeyVersion` operation to promote the `KskDnssecKeyVersion`. New `KskDnssecKeyVersion`s are generated annually, a week before the existing `KskDnssecKeyVersion`''s expiration. To rollover a `KskDnssecKeyVersion`, you must replace the parent zone''s DS record containing the old `KskDnssecKeyVersion` data with the data from the new `KskDnssecKeyVersion`. To remove the old DS record without causing service disruption, wait until the old DS record''s TTL has expired, and the new DS record has propagated. After the DS replacement has been completed, then the `PromoteZoneDnssecKeyVersion` operation must be called. Metrics are emitted in the `oci_dns` namespace daily for each `KskDnssecKeyVersion` indicating how many days are left until expiration. We recommend that you set up alarms and notifications for KskDnssecKeyVersion expiration so that the necessary parent zone updates can be made and the `PromoteZoneDnssecKeyVersion` operation can be called. Enabling DNSSEC results in additional records in DNS responses which increases their size and can cause higher response latency. For more information, see [DNSSEC](/iaas/Content/DNS/Concepts/dnssec.htm). ' enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/ZoneDnssecState' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object id: description: The OCID of the zone. maxLength: 255 minLength: 1 type: string isProtected: description: 'A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. ' type: boolean lifecycleState: description: The current state of the zone resource. enum: - ACTIVE - CREATING - DELETED - DELETING - FAILED - UPDATING type: string name: description: The name of the zone. maxLength: 254 minLength: 1 type: string resolutionMode: default: STATIC description: 'The resolution mode of a zone defines behavior related to how query responses can be handled. See [Private DNS Zone Transparency](/Content/DNS/Tasks/privatedns.htm#use-cases__resolution) for more information. ' enum: - STATIC - TRANSPARENT - RTYPE_TRANSPARENT type: string x-obmcs-top-level-enum: '#/definitions/ZoneResolutionMode' scope: description: The scope of the zone. enum: - GLOBAL - PRIVATE type: string x-obmcs-top-level-enum: '#/definitions/Scope' self: description: The canonical absolute URL of the resource. format: url type: string serial: description: 'The current serial of the zone. As seen in the zone''s SOA record. ' format: int64 type: integer timeCreated: description: 'The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string version: description: 'Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone''s SOA record is derived. ' type: string viewId: description: 'The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view. ' maxLength: 255 minLength: 1 type: string zoneType: description: 'The type of the zone. Must be either `PRIMARY` or `SECONDARY`. `SECONDARY` is only supported for GLOBAL zones. ' enum: - PRIMARY - SECONDARY type: string required: - name - zoneType - compartmentId - freeformTags - definedTags - id - version - serial - lifecycleState - self - scope - isProtected - timeCreated - dnssecState - resolutionMode type: object SteeringPolicyRule: description: 'The configuration of the sorting and filtering behaviors in a steering policy. Rules can filter and sort answers based on weight, priority, endpoint health, and other data. A rule may optionally include a sequence of cases, each with an optional `caseCondition` expression. Cases allow a sequence of conditions to be defined that will apply different parameters to the rule when the conditions are met. For more information about cases, see [Traffic Management API Guide](/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' discriminator: propertyName: ruleType properties: description: description: A user-defined description of the rule's purpose or behavior. maxLength: 400 type: string ruleType: description: "The type of a rule determines its sorting/filtering behavior.\n* `FILTER` - Filters the list of answers based on their defined boolean data. Answers remain\n only if their `shouldKeep` value is `true`.\n\n\n* `HEALTH` - Removes answers from the list if their `rdata` matches a target in the\n health check monitor referenced by the steering policy and the target is reported down.\n\n\n* `WEIGHTED` - Uses a number between 0 and 255 to determine how often an answer will be served\n in relation to other answers. Anwers with a higher weight will be served more frequently.\n\n\n* `PRIORITY` - Uses a defined rank value of answers to determine which answer to serve,\n moving those with the lowest values to the beginning of the list without changing the\n relative order of those with the same value. Answers can be given a value between `0` and `255`.\n\n\n* `LIMIT` - Filters answers that are too far down the list. Parameter `defaultCount`\n specifies how many answers to keep. **Example:** If `defaultCount` has a value of `2` and\n there are five answers left, when the `LIMIT` rule is processed, only the first two answers\n will remain in the list.\n" enum: - FILTER - HEALTH - WEIGHTED - PRIORITY - LIMIT type: string required: - ruleType type: object UpdateZoneDetails: description: 'The body for updating a zone. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object dnssecState: default: DISABLED description: 'The state of DNSSEC on the zone. For DNSSEC to function, every parent zone in the DNS tree up to the top-level domain (or an independent trust anchor) must also have DNSSEC correctly set up. After enabling DNSSEC, you must add a DS record to the zone''s parent zone containing the `KskDnssecKeyVersion` data. You can find the DS data in the `dsData` attribute of the `KskDnssecKeyVersion`. Then, use the `PromoteZoneDnssecKeyVersion` operation to promote the `KskDnssecKeyVersion`. New `KskDnssecKeyVersion`s are generated annually, a week before the existing `KskDnssecKeyVersion`''s expiration. To rollover a `KskDnssecKeyVersion`, you must replace the parent zone''s DS record containing the old `KskDnssecKeyVersion` data with the data from the new `KskDnssecKeyVersion`. To remove the old DS record without causing service disruption, wait until the old DS record''s TTL has expired, and the new DS record has propagated. After the DS replacement has been completed, then the `PromoteZoneDnssecKeyVersion` operation must be called. Metrics are emitted in the `oci_dns` namespace daily for each `KskDnssecKeyVersion` indicating how many days are left until expiration. We recommend that you set up alarms and notifications for KskDnssecKeyVersion expiration so that the necessary parent zone updates can be made and the `PromoteZoneDnssecKeyVersion` operation can be called. Enabling DNSSEC results in additional records in DNS responses which increases their size and can cause higher response latency. For more information, see [DNSSEC](/iaas/Content/DNS/Concepts/dnssec.htm). ' enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/ZoneDnssecState' externalDownstreams: description: 'External secondary servers for the zone. This field is currently not supported when `zoneType` is `SECONDARY` or `scope` is `PRIVATE`. ' items: $ref: '#/components/schemas/ExternalDownstream' type: array externalMasters: description: 'External master servers for the zone. `externalMasters` becomes a required parameter when the `zoneType` value is `SECONDARY`. ' items: $ref: '#/components/schemas/ExternalMaster' type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object resolutionMode: default: STATIC description: 'The resolution mode of a zone defines behavior related to how query responses can be handled. See [Private DNS Zone Transparency](/Content/DNS/Tasks/privatedns.htm#use-cases__resolution) for more information. ' enum: - STATIC - TRANSPARENT - RTYPE_TRANSPARENT type: string x-obmcs-top-level-enum: '#/definitions/ZoneResolutionMode' type: object UpdateDomainRecordsDetails: properties: items: items: $ref: '#/components/schemas/RecordDetails' type: array type: object CreateZoneBaseDetails: description: 'The body for either defining a new zone or migrating a zone from migrationSource. This is determined by the migrationSource discriminator. NONE indicates creation of a new zone (default). DYNECT indicates migration from a DynECT zone. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' discriminator: propertyName: migrationSource properties: compartmentId: description: The OCID of the compartment containing the zone. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object migrationSource: default: NONE description: 'Discriminator that is used to determine whether to create a new zone (NONE) or to migrate an existing DynECT zone (DYNECT). ' enum: - NONE - DYNECT type: string name: description: 'The name of the zone. Global zone names must be unique across all other zones within the realm. Private zone names must be unique within their view. Unicode characters will be converted into punycode, see [RFC 3492](https://tools.ietf.org/html/rfc3492). ' maxLength: 254 minLength: 1 type: string required: - name - compartmentId type: object ChangeResolverCompartmentDetails: properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resolver, along with its protected default view and resolver endpoints, should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object SteeringPolicy: description: 'A DNS steering policy. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: answers: description: 'The set of all answers that can potentially issue from the steering policy. ' items: $ref: '#/components/schemas/SteeringPolicyAnswer' type: array compartmentId: description: The OCID of the compartment containing the steering policy. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object healthCheckMonitorId: description: 'The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with `rdata` matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with `rdata` not matching any monitored endpoint will be assumed healthy. **Note:** To use the Health Check monitoring feature in a steering policy, a monitor must be created using the Health Checks service first. For more information on how to create a monitor, please see [Managing Health Checks](/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm). ' maxLength: 255 minLength: 1 type: string id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the resource. enum: - ACTIVE - CREATING - DELETED - DELETING type: string rules: description: 'The series of rules that will be processed in sequence to reduce the pool of answers to a response for any given request. The first rule receives a shuffled list of all answers, and every other rule receives the list of answers emitted by the one preceding it. The last rule populates the response. ' items: $ref: '#/components/schemas/SteeringPolicyRule' maxItems: 10 type: array self: description: The canonical absolute URL of the resource. format: url type: string template: description: 'A set of predefined rules based on the desired purpose of the steering policy. Each template utilizes Traffic Management''s rules in a different order to produce the desired results when answering DNS queries. **Example:** The `FAILOVER` template determines answers by filtering the policy''s answers using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`, and `LIMIT`. This gives the domain dynamic failover capability. It is **strongly recommended** to use a template other than `CUSTOM` when creating a steering policy. All templates require the rule order to begin with an unconditional `FILTER` rule that keeps answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`. The last rule of a template must must be a `LIMIT` rule. For more information about templates and code examples, see [Traffic Management API Guide](/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). **Template Types** * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers to serve. If an endpoint fails a health check, the answer for that endpoint will be removed from the list of available answers until the endpoint is detected as healthy. * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights. * `ROUTE_BY_GEO` - Answers DNS queries based on the query''s geographic location. For a list of geographic locations to route by, see [Traffic Management Geographic Locations](/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm). * `ROUTE_BY_ASN` - Answers DNS queries based on the query''s originating ASN. * `ROUTE_BY_IP` - Answers DNS queries based on the query''s IP address. * `CUSTOM` - Allows a customized configuration of rules. ' enum: - FAILOVER - LOAD_BALANCE - ROUTE_BY_GEO - ROUTE_BY_ASN - ROUTE_BY_IP - CUSTOM type: string timeCreated: description: 'The date and time the resource was created, expressed in RFC 3339 timestamp format. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string ttl: description: 'The Time To Live (TTL) for responses from the steering policy, in seconds. If not specified during creation, a value of 30 seconds will be used. ' format: int32 maximum: 604800 minimum: 1 type: integer required: - compartmentId - displayName - ttl - template - freeformTags - definedTags - answers - rules - self - id - timeCreated - lifecycleState type: object CreateTsigKeyDetails: description: 'The body for defining a TSIG key. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: algorithm: description: 'TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see [RFC 4635](https://tools.ietf.org/html/rfc4635#section-2). ' maxLength: 63 minLength: 1 pattern: ^\.$|^(?=([^\\]|\\([^0-9]|[0-9]{3})){1,253}\.?$)(?=.*[^\\0-9.])(([a-zA-Z0-9_-]|\\([\x21-\x2F\x3A-\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\.|$))+$ type: string compartmentId: description: The OCID of the compartment containing the TSIG key. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object name: description: A globally unique domain name identifying the key for a given pair of hosts. maxLength: 63 minLength: 1 pattern: ^\.$|^(?=([^\\]|\\([^0-9]|[0-9]{3})){1,253}\.?$)(?=.*[^\\0-9.])(?=.*\.)(([a-zA-Z0-9_-]|\\([\x21-\x2F\x3A-\x7E]|[01][0-9][0-9]|2[0-4][0-9]|25[0-5])){1,63}(\.|$))+$ type: string secret: description: A base64 string encoding the binary shared secret. maxLength: 255 minLength: 1 pattern: ^(([\x20\t\r\n\f]*[A-Za-z0-9+/]){4})*(([\x20\t\r\n\f]*[A-Za-z0-9+/])([\x20\t\r\n\f]*[AQgw])==|([\x20\t\r\n\f]*[A-Za-z0-9+/]){2}([\x20\t\r\n\f]*[AEIMQUYcgkosw048])=)?[\x20\t\r\n\f]*$ type: string required: - algorithm - compartmentId - name - secret type: object RecordCollection: description: A collection of DNS resource records. properties: items: items: $ref: '#/components/schemas/Record' type: array required: - items type: object DnssecConfig: description: 'DNSSEC configuration data. A zone may have a maximum of 10 `DnssecKeyVersions`, regardless of signing key type. ' properties: kskDnssecKeyVersions: description: 'A read-only array of key signing key (KSK) versions. ' items: $ref: '#/components/schemas/KskDnssecKeyVersion' type: array zskDnssecKeyVersions: description: 'A read-only array of zone signing key (ZSK) versions. ' items: $ref: '#/components/schemas/ZskDnssecKeyVersion' type: array type: object ExternalDownstream: description: 'External downstream nameserver for the zone. This field is currently not supported when `zoneType` is `SECONDARY` or `scope` is `PRIVATE`. ' properties: address: description: The server's IP address (IPv4 or IPv6). type: string port: default: 53 description: 'The server''s port. Port value must be a value of 53, otherwise omit the port value. ' type: integer tsigKeyId: description: 'The OCID of the TSIG key. A TSIG key is used to secure DNS messages (in this case, zone transfers) between two systems that both have the (shared) secret. ' maxLength: 255 minLength: 1 type: string required: - address type: object StageZoneDnssecKeyVersionDetails: description: 'Details for staging a `DnssecKeyVersion` on a zone. ' properties: predecessorDnssecKeyVersionUuid: description: 'The UUID of the `DnssecKeyVersion` for which a new successor should be generated. ' maxLength: 36 minLength: 36 type: string required: - predecessorDnssecKeyVersionUuid type: object UpdateZoneRecordsDetails: properties: items: items: $ref: '#/components/schemas/RecordDetails' type: array type: object UpdateSteeringPolicyAttachmentDetails: description: 'The body for updating a steering policy attachment. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: displayName: description: 'A user-friendly name for the steering policy attachment. Does not have to be unique and can be changed. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string type: object SteeringPolicyAttachmentSummary: description: An attachment between a steering policy and a domain. properties: compartmentId: description: The OCID of the compartment containing the steering policy attachment. maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name for the steering policy attachment. Does not have to be unique and can be changed. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string domainName: description: The attached domain within the attached zone. type: string id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the resource. enum: - CREATING - ACTIVE - DELETING type: string rtypes: description: 'The record types covered by the attachment at the domain. The set of record types is determined by aggregating the record types from the answers defined in the steering policy. ' items: type: string type: array self: description: The canonical absolute URL of the resource. format: url type: string steeringPolicyId: description: The OCID of the attached steering policy. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the resource was created, expressed in RFC 3339 timestamp format. **Example:** `2016-07-22T17:23:59:60Z` ' format: date-time type: string zoneId: description: The OCID of the attached zone. Must be a public zone. maxLength: 255 minLength: 1 type: string required: - steeringPolicyId - zoneId - domainName - displayName - rtypes - compartmentId - self - id - timeCreated - lifecycleState type: object UpdateSteeringPolicyDetails: description: 'The body for updating a steering policy. New rules and answers provided in the request will replace the existing rules and answers in the policy. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: answers: description: 'The set of all answers that can potentially issue from the steering policy. ' items: $ref: '#/components/schemas/SteeringPolicyAnswer' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. **Example:** `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). **Example:** `{"Department": "Finance"}` ' type: object healthCheckMonitorId: description: 'The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with `rdata` matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with `rdata` not matching any monitored endpoint will be assumed healthy. **Note:** To use the Health Check monitoring feature in a steering policy, a monitor must be created using the Health Checks service first. For more information on how to create a monitor, please see [Managing Health Checks](/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm). ' maxLength: 255 minLength: 1 type: string rules: description: 'The series of rules that will be processed in sequence to reduce the pool of answers to a response for any given request. The first rule receives a shuffled list of all answers, and every other rule receives the list of answers emitted by the one preceding it. The last rule populates the response. ' items: $ref: '#/components/schemas/SteeringPolicyRule' maxItems: 10 type: array template: description: 'A set of predefined rules based on the desired purpose of the steering policy. Each template utilizes Traffic Management''s rules in a different order to produce the desired results when answering DNS queries. **Example:** The `FAILOVER` template determines answers by filtering the policy''s answers using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`, and `LIMIT`. This gives the domain dynamic failover capability. It is **strongly recommended** to use a template other than `CUSTOM` when creating a steering policy. All templates require the rule order to begin with an unconditional `FILTER` rule that keeps answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`. The last rule of a template must must be a `LIMIT` rule. For more information about templates and code examples, see [Traffic Management API Guide](/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm). **Template Types** * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers to serve. If an endpoint fails a health check, the answer for that endpoint will be removed from the list of available answers until the endpoint is detected as healthy. * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights. * `ROUTE_BY_GEO` - Answers DNS queries based on the query''s geographic location. For a list of geographic locations to route by, see [Traffic Management Geographic Locations](/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm). * `ROUTE_BY_ASN` - Answers DNS queries based on the query''s originating ASN. * `ROUTE_BY_IP` - Answers DNS queries based on the query''s IP address. * `CUSTOM` - Allows a customized configuration of rules. ' enum: - FAILOVER - LOAD_BALANCE - ROUTE_BY_GEO - ROUTE_BY_ASN - ROUTE_BY_IP - CUSTOM type: string ttl: description: 'The Time To Live (TTL) for responses from the steering policy, in seconds. If not specified during creation, a value of 30 seconds will be used. ' format: int32 maximum: 604800 minimum: 1 type: integer type: object responses: '422': description: Unprocessable Entity headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' RecordsResponse: description: A collection of DNS resource record objects. headers: ETag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' schema: type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: The total number of items that match the query. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/RecordCollection' '429': description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' EmptyResponseWithWorkRequest: description: An empty HTTP response. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string '400': description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '304': description: Not Modified headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string DefaultError: description: 'An error has occurred. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '412': description: Precondition Failed headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Forbidden or Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' EmptyResponse: description: An empty HTTP response. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string '500': description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-headers: etag: description: 'The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource. ' type: string location: description: 'The full URI of the resource related to the request. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-total-items: description: The total number of items that match the query. type: integer opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string x-obmcs-client-retries-enabled: true