How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Dns API

The dns API from Oracle — 27 operation(s) for dns.

Oracle Dns API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DNS. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 54 operations across 27 paths, and defines 60 schemas. It is described by OpenAPI 3.2.0, at version 20180115.

Requests are made against a single base URL, /20180115.

54 operations 27 paths 60 schemas 8 DELETE19 GET3 PATCH14 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20180115
Base URL
https://{host}:{port}/ords/
License
Oracle Corporation
Resource Areas
1

Paths & Operations 54

Across 27 paths, the API surfaces 54 operations — 8 DELETE, 19 GET, 3 PATCH, 14 POST, 10 PUT. Each is listed below with its method, path, parameters, and response codes.

dns 54
POST
/actions/createZoneFromZoneFile
Creates a new zone from a zone file in the specified compartment. Not supported for private zones.
CreateZoneFromZoneFile 5 params body → 201400401409422429500default
GET
/resolvers
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.…
ListResolvers 10 params → 200400401404429500default
GET
/resolvers/{resolverId}
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.
GetResolver 5 params → 200304400401404429500default
PUT
/resolvers/{resolverId}
Updates the specified resolver with your new information.
UpdateResolver 5 params body → 200400401404409412422429
POST
/resolvers/{resolverId}/actions/changeCompartment
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 sa…
ChangeResolverCompartment 5 params body → 202400401404409412422429
GET
/resolvers/{resolverId}/endpoints
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 lifec…
ListResolverEndpoints 9 params → 200400401404429500default
POST
/resolvers/{resolverId}/endpoints
Creates a new resolver endpoint in the same compartment as the resolver.
CreateResolverEndpoint 4 params body → 201400401409422429500default
DELETE
/resolvers/{resolverId}/endpoints/{resolverEndpointName}
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…
DeleteResolverEndpoint 6 params → 202400401404409412429500
GET
/resolvers/{resolverId}/endpoints/{resolverEndpointName}
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 operation…
GetResolverEndpoint 6 params → 200304400401404429500default
PUT
/resolvers/{resolverId}/endpoints/{resolverEndpointName}
Updates the specified resolver endpoint with your new information.
UpdateResolverEndpoint 6 params body → 200400401404409412422429
GET
/steeringPolicies
Gets a list of all steering policies in the specified compartment.
ListSteeringPolicies 15 params → 200400401404429500default
POST
/steeringPolicies
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/traff…
CreateSteeringPolicy 3 params body → 201400401409422429500default
DELETE
/steeringPolicies/{steeringPolicyId}
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 Del…
DeleteSteeringPolicy 5 params → 204401404409412429500default
GET
/steeringPolicies/{steeringPolicyId}
Gets information about the specified steering policy.
GetSteeringPolicy 5 params → 200304400401404429500default
PUT
/steeringPolicies/{steeringPolicyId}
Updates the configuration of the specified steering policy.
UpdateSteeringPolicy 5 params body → 200400401404409412422429
POST
/steeringPolicies/{steeringPolicyId}/actions/changeCompartment
Moves a steering policy into a different compartment.
ChangeSteeringPolicyCompartment 5 params body → 204400401404409412422429
GET
/steeringPolicyAttachments
Lists the steering policy attachments in the specified compartment.
ListSteeringPolicyAttachments 16 params → 200400401404429500default
POST
/steeringPolicyAttachments
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…
CreateSteeringPolicyAttachment 3 params body → 201400401409422429500default
DELETE
/steeringPolicyAttachments/{steeringPolicyAttachmentId}
Deletes the specified steering policy attachment. A 204 response indicates that the delete has been successful.
DeleteSteeringPolicyAttachment 5 params → 204401404409412429500default
GET
/steeringPolicyAttachments/{steeringPolicyAttachmentId}
Gets information about the specified steering policy attachment.
GetSteeringPolicyAttachment 5 params → 200304400401404429500default
PUT
/steeringPolicyAttachments/{steeringPolicyAttachmentId}
Updates the specified steering policy attachment with your new information.
UpdateSteeringPolicyAttachment 5 params body → 200400401404412422429500
GET
/tsigKeys
Gets a list of all TSIG keys in the specified compartment.
ListTsigKeys 10 params → 200400401404429500default
POST
/tsigKeys
Creates a new TSIG key in the specified compartment. There is no opc-retry-token header since TSIG key names must be globally unique.
CreateTsigKey 2 params body → 201400401409422429500default
DELETE
/tsigKeys/{tsigKeyId}
Deletes the specified TSIG key.
DeleteTsigKey 5 params → 204401404409412429500default
GET
/tsigKeys/{tsigKeyId}
Gets information about the specified TSIG key.
GetTsigKey 5 params → 200304400401404429500default
PUT
/tsigKeys/{tsigKeyId}
Updates the specified TSIG key.
UpdateTsigKey 5 params body → 200400401404409412422429
POST
/tsigKeys/{tsigKeyId}/actions/changeCompartment
Moves a TSIG key into a different compartment.
ChangeTsigKeyCompartment 5 params body → 204400401404409412422429
GET
/views
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…
ListViews 10 params → 200400401404429500default
POST
/views
Creates a new view in the specified compartment.
CreateView 3 params body → 201400401409422429500default
DELETE
/views/{viewId}
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 delete…
DeleteView 5 params → 202400401404409412429500
GET
/views/{viewId}
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.
GetView 5 params → 200304400401404429500default
PUT
/views/{viewId}
Updates the specified view with your new information.
UpdateView 5 params body → 200400401404409412422429
POST
/views/{viewId}/actions/changeCompartment
Moves a view into a different compartment. To change the compartment of a protected view, change the compartment of its corresponding resolver.
ChangeViewCompartment 5 params body → 202400401404409412422429
GET
/zoneTransferServers
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 e…
ListZoneTransferServers 4 params → 200400401404429500default
GET
/zones
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 zon…
ListZones 16 params → 200400401404429500default
POST
/zones
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…
CreateZone 5 params body → 201400401409422429500default
POST
/zones/{zoneId}/actions/changeCompartment
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…
ChangeZoneCompartment 5 params body → 204400401404409412422429
POST
/zones/{zoneId}/actions/promoteDnssecKeyVersion
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 DnssecKey…
PromoteZoneDnssecKeyVersion 6 params body → 202400401404409412422429
POST
/zones/{zoneId}/actions/stageDnssecKeyVersion
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) ver…
StageZoneDnssecKeyVersion 6 params body → 202400401404409412422429
DELETE
/zones/{zoneNameOrId}
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 prov…
DeleteZone 7 params → 204400401404409412429500
GET
/zones/{zoneNameOrId}
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 the…
GetZone 7 params → 200400401404412429500default
PUT
/zones/{zoneNameOrId}
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/Conten…
UpdateZone 7 params body → 200400401404409412422429
GET
/zones/{zoneNameOrId}/content
Gets the requested zone's zone file.
GetZoneContent 6 params → 200400401404412429500default
GET
/zones/{zoneNameOrId}/records
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/as…
GetZoneRecords 15 params → 200400401404412429500default
PATCH
/zones/{zoneNameOrId}/records
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 remov…
PatchZoneRecords 7 params body → 200400401404409412422429
PUT
/zones/{zoneNameOrId}/records
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 repre…
UpdateZoneRecords 7 params body → 200400401404409412422429
DELETE
/zones/{zoneNameOrId}/records/{domain}
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.
DeleteDomainRecords 8 params → 204400401404412429500default
GET
/zones/{zoneNameOrId}/records/{domain}
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 param…
GetDomainRecords 14 params → 200400401404412429500default
PATCH
/zones/{zoneNameOrId}/records/{domain}
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 re…
PatchDomainRecords 8 params body → 200400401404409412422429
PUT
/zones/{zoneNameOrId}/records/{domain}
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 upda…
UpdateDomainRecords 8 params body → 200400401404409412422429
DELETE
/zones/{zoneNameOrId}/records/{domain}/{rtype}
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.
DeleteRRSet 9 params → 204400401404412429500default
GET
/zones/{zoneNameOrId}/records/{domain}/{rtype}
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 paramete…
GetRRSet 12 params → 200400401404412429500default
PATCH
/zones/{zoneNameOrId}/records/{domain}/{rtype}
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.
PatchRRSet 9 params body → 200400401404409412422429
PUT
/zones/{zoneNameOrId}/records/{domain}/{rtype}
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.
UpdateRRSet 9 params body → 200400401404409412422429

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are Zone (21 properties), ZoneSummary (17 properties), Resolver (15 properties), KskDnssecKeyVersion (14 properties). Each schema is shown below with its type and property counts.

ZoneTransferServer
object
An OCI nameserver that transfers zone data with external nameservers.
4 properties 1 required
ZskDnssecKeyVersion
object
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.
13 properties
UpdateViewDetails
object
The body for updating an existing view. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the AP…
3 properties
ChangeZoneCompartmentDetails
object
1 property 1 required
RecordDetails
object
A DNS resource record. For more information about records, see [RFC 1034](https://tools.ietf.org/html/rfc1034section-3.6).
7 properties 4 required
ChangeTsigKeyCompartmentDetails
object
1 property 1 required
CreateZoneBaseDetails
object
The body for either defining a new zone or migrating a zone from migrationSource. This is determined by the migrationSource discriminator. NONE indicates creat…
5 properties 2 required
CreateViewDetails
object
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.
4 properties 1 required
UpdateResolverEndpointDetails
object
The body for updating an existing resolver endpoint. Warning: Oracle recommends that you avoid using any confidential information when you supply string values…
1 property
Nameserver
object
A server that has been set up to answer DNS queries for a zone.
1 property 1 required
Resolver
object
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 do…
15 properties 12 required
Record
object
A DNS resource record. For more information, see [Supported DNS Resource Record Types](/iaas/Content/DNS/Reference/supporteddnsresource.htm).
7 properties
ChangeSteeringPolicyCompartmentDetails
object
1 property 1 required
TsigKey
object
A TSIG key. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
11 properties 10 required
CreateResolverEndpointDetails
object
The body for defining a new resolver endpoint. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using…
6 properties 3 required
AttachedViewDetails
object
Properties for defining an attached view.
1 property 1 required
ResolverEndpointSummary
object
An OCI DNS resolver endpoint. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
11 properties 8 required
UpdateZoneDetails
object
The body for updating a zone. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
6 properties
SteeringPolicyAnswer
object
DNS record data with metadata for processing in a steering policy. Warning: Oracle recommends that you avoid using any confidential information when you supply…
5 properties 3 required
SteeringPolicySummary
object
A DNS steering policy. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
11 properties 10 required
SteeringPolicyAttachment
object
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 do…
10 properties 10 required
ResolverSummary
object
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 do…
12 properties 10 required
UpdateTsigKeyDetails
object
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.
2 properties
DnssecConfig
object
DNSSEC configuration data. A zone may have a maximum of 10 DnssecKeyVersions, regardless of signing key type.
2 properties
CreateSteeringPolicyDetails
object
The body for defining a new steering policy. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using t…
9 properties 3 required
UpdateSteeringPolicyDetails
object
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: Orac…
8 properties
ZoneSummary
object
A DNS zone. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
17 properties 15 required
ExternalDownstream
object
External downstream nameserver for the zone. This field is currently not supported when zoneType is SECONDARY or scope is PRIVATE.
3 properties 1 required
ExternalMaster
object
An external master name server used as the source of zone data.
3 properties 1 required
CreateTsigKeyDetails
object
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.
6 properties 4 required
SteeringPolicyRule
object
The configuration of the sorting and filtering behaviors in a steering policy. Rules can filter and sort answers based on weight, priority, endpoint health, an…
2 properties 1 required
TsigKeySummary
object
A TSIG key.
9 properties 9 required
StageZoneDnssecKeyVersionDetails
object
Details for staging a DnssecKeyVersion on a zone.
1 property 1 required
AttachedView
object
Properties of an attached view.
1 property 1 required
DnssecKeyVersionDsData
object
Data for a parent zone DS record corresponding to this key-signing key (KSK).
2 properties
UpdateResolverDetails
object
The body for updating an existing resolver. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using th…
5 properties
Zone
object
A DNS zone. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
21 properties 18 required
ViewSummary
object
An OCI DNS view. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
10 properties 10 required
ChangeResolverCompartmentDetails
object
1 property 1 required
PatchRRSetDetails
object
1 property
PromoteZoneDnssecKeyVersionDetails
object
Details for promoting a DnssecKeyVersion on a zone.
1 property 1 required
ChangeViewCompartmentDetails
object
1 property 1 required
ResolverRuleDetails
object
A rule for a resolver. Specifying both qnameCoverConditions and clientAddressConditions is not allowed. Warning: Oracle recommends that you avoid using any con…
3 properties 1 required
ResolverRule
object
A rule for a resolver. Specifying both qnameCoverConditions and clientAddressConditions is not allowed. Warning: Oracle recommends that you avoid using any con…
3 properties 3 required
SteeringPolicy
object
A DNS steering policy. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
13 properties 12 required
KskDnssecKeyVersion
object
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 zo…
14 properties
PatchDomainRecordsDetails
object
1 property
UpdateRRSetDetails
object
1 property
RecordCollection
object
A collection of DNS resource records.
1 property 1 required
PatchZoneRecordsDetails
object
1 property
UpdateSteeringPolicyAttachmentDetails
object
The body for updating a steering policy attachment. Warning: Oracle recommends that you avoid using any confidential information when you supply string values…
1 property
UpdateDomainRecordsDetails
object
1 property
Error
object
2 properties 2 required
View
object
An OCI DNS view. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
10 properties 10 required
RecordOperation
object
An extension of the existing record resource, describing either a precondition, an add, or a remove. Preconditions check all fields, including read-only data l…
8 properties
ResolverEndpoint
object
An OCI DNS resolver endpoint. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
11 properties 8 required
UpdateZoneRecordsDetails
object
1 property
SteeringPolicyAttachmentSummary
object
An attachment between a steering policy and a domain.
10 properties 10 required
CreateSteeringPolicyAttachmentDetails
object
The body for defining an attachment between a steering policy and a domain. Warning: Oracle recommends that you avoid using any confidential information when y…
4 properties 3 required
RRSet
object
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/assignm…
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-dns-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from

This is an independent, third-party profile of Oracle Dns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.