{ "opencollection": "1.0.0", "info": { "name": "Dns API", "version": "20180115" }, "items": [ { "info": { "name": "dns", "type": "folder" }, "items": [ { "info": { "name": "CreateZoneFromZoneFile", "type": "http" }, "http": { "method": "POST", "url": "/20180115/actions/createZoneFromZoneFile", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the resource belongs to." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the resource is associated with." } ] }, "docs": "Creates a new zone from a zone file in the specified compartment. Not supported for private zones.\n" }, { "info": { "name": "ListResolvers", "type": "http" }, "http": { "method": "GET", "url": "/20180115/resolvers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the resource belongs to." }, { "name": "displayName", "value": "", "type": "query", "description": "The displayName of a resource." }, { "name": "id", "value": "", "type": "query", "description": "The OCID of a resource." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page of the collection.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The order to sort the resources.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field by which to sort resolvers." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of a resource." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Gets a list of all resolvers within a compartment.\n\nThe collection can be filtered by display name, id, or lifecycle state. It can be sorted\non creation time or displayName both in ASC or DESC order. Note that when no lifecycleState\nquery parameter is provided, the collection does not include resolvers in the DELETED\nlifecycleState to be consistent with other operations of the API.\n" }, { "info": { "name": "GetResolver", "type": "http" }, "http": { "method": "GET", "url": "/20180115/resolvers/:resolverId", "headers": [ { "name": "If-Modified-Since", "value": "" }, { "name": "If-None-Match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "resolverId", "value": "", "type": "path", "description": "The OCID of the target resolver." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Gets information about a specific resolver.\n\nNote that attempting to get a resolver in the DELETED lifecycleState will result in a `404`\nresponse to be consistent with other operations of the API.\n" }, { "info": { "name": "UpdateResolver", "type": "http" }, "http": { "method": "PUT", "url": "/20180115/resolvers/:resolverId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "resolverId", "value": "", "type": "path", "description": "The OCID of the target resolver." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified resolver with your new information.\n" }, { "info": { "name": "ChangeResolverCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20180115/resolvers/:resolverId/actions/changeCompartment", "headers": [ { "name": "If-Match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "resolverId", "value": "", "type": "path", "description": "The OCID of the target resolver." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a resolver into a different compartment along with its protected default view and any endpoints.\n\nZones in the default view are not moved. VCN-dedicated resolvers are initially created in the same compartment\nas their corresponding VCN, but can then be moved to a different compartment.\n" }, { "info": { "name": "ListResolverEndpoints", "type": "http" }, "http": { "method": "GET", "url": "/20180115/resolvers/:resolverId/endpoints", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "resolverId", "value": "", "type": "path", "description": "The OCID of the target resolver." }, { "name": "name", "value": "", "type": "query", "description": "The name of a resource." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page of the collection.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The order to sort the resources.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field by which to sort resolver endpoints." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of a resource." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Gets a list of all endpoints within a resolver. The collection can be filtered by name or lifecycle state.\nIt can be sorted on creation time or name both in ASC or DESC order. Note that when no lifecycleState\nquery parameter is provided, the collection does not include resolver endpoints in the DELETED\nlifecycle state to be consistent with other operations of the API.\n" }, { "info": { "name": "CreateResolverEndpoint", "type": "http" }, "http": { "method": "POST", "url": "/20180115/resolvers/:resolverId/endpoints", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "resolverId", "value": "", "type": "path", "description": "The OCID of the target resolver." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new resolver endpoint in the same compartment as the resolver.\n" }, { "info": { "name": "GetResolverEndpoint", "type": "http" }, "http": { "method": "GET", "url": "/20180115/resolvers/:resolverId/endpoints/:resolverEndpointName", "headers": [ { "name": "If-Modified-Since", "value": "" }, { "name": "If-None-Match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "resolverId", "value": "", "type": "path", "description": "The OCID of the target resolver." }, { "name": "resolverEndpointName", "value": "", "type": "path", "description": "The name of the target resolver endpoint." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Gets information about a specific resolver endpoint.\n\nNote that attempting to get a resolver endpoint in the DELETED lifecycle state will result\nin a `404` response to be consistent with other operations of the API.\n" }, { "info": { "name": "UpdateResolverEndpoint", "type": "http" }, "http": { "method": "PUT", "url": "/20180115/resolvers/:resolverId/endpoints/:resolverEndpointName", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "resolverId", "value": "", "type": "path", "description": "The OCID of the target resolver." }, { "name": "resolverEndpointName", "value": "", "type": "path", "description": "The name of the target resolver endpoint." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified resolver endpoint with your new information.\n" }, { "info": { "name": "DeleteResolverEndpoint", "type": "http" }, "http": { "method": "DELETE", "url": "/20180115/resolvers/:resolverId/endpoints/:resolverEndpointName", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "resolverId", "value": "", "type": "path", "description": "The OCID of the target resolver." }, { "name": "resolverEndpointName", "value": "", "type": "path", "description": "The name of the target resolver endpoint." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Deletes the specified resolver endpoint.\n\nNote that attempting to delete a resolver endpoint in the DELETED lifecycle state will result in\na `404` response to be consistent with other operations of the API. Resolver endpoints may not\nbe deleted if they are referenced by a resolver rule.\n" }, { "info": { "name": "ListSteeringPolicies", "type": "http" }, "http": { "method": "GET", "url": "/20180115/steeringPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page of the collection.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the resource belongs to." }, { "name": "id", "value": "", "type": "query", "description": "The OCID of a resource." }, { "name": "displayName", "value": "", "type": "query", "description": "The displayName of a resource." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "The partial displayName of a resource. Will match any resource whose name\n(case-insensitive) contains the provided value.\n" }, { "name": "healthCheckMonitorId", "value": "", "type": "query", "description": "Search by health check monitor OCID.\nWill match any resource whose health check monitor ID matches the provided value.\n" }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states\nall returned resources were created on or after the indicated time.\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states\nall returned resources were created before the indicated time.\n" }, { "name": "template", "value": "", "type": "query", "description": "Search by steering template type.\nWill match any resource whose template type matches the provided value.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of a resource." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field by which to sort steering policies. If unspecified, defaults to `timeCreated`." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The order to sort the resources.\n" }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Gets a list of all steering policies in the specified compartment.\n" }, { "info": { "name": "CreateSteeringPolicy", "type": "http" }, "http": { "method": "POST", "url": "/20180115/steeringPolicies", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new steering policy in the specified compartment. For more information on\ncreating policies with templates, see [Traffic Management API Guide](/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm).\n" }, { "info": { "name": "GetSteeringPolicy", "type": "http" }, "http": { "method": "GET", "url": "/20180115/steeringPolicies/:steeringPolicyId", "headers": [ { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "steeringPolicyId", "value": "", "type": "path", "description": "The OCID of the target steering policy." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Gets information about the specified steering policy.\n" }, { "info": { "name": "UpdateSteeringPolicy", "type": "http" }, "http": { "method": "PUT", "url": "/20180115/steeringPolicies/:steeringPolicyId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "steeringPolicyId", "value": "", "type": "path", "description": "The OCID of the target steering policy." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of the specified steering policy.\n" }, { "info": { "name": "DeleteSteeringPolicy", "type": "http" }, "http": { "method": "DELETE", "url": "/20180115/steeringPolicies/:steeringPolicyId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "steeringPolicyId", "value": "", "type": "path", "description": "The OCID of the target steering policy." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Deletes the specified steering policy.\n\nA `204` response indicates that the delete has been successful.\nDeletion will fail if the policy is attached to any zones. To detach a\npolicy from a zone, see `DeleteSteeringPolicyAttachment`.\n" }, { "info": { "name": "ChangeSteeringPolicyCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20180115/steeringPolicies/:steeringPolicyId/actions/changeCompartment", "headers": [ { "name": "If-Match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "steeringPolicyId", "value": "", "type": "path", "description": "The OCID of the target steering policy." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a steering policy into a different compartment.\n" }, { "info": { "name": "ListSteeringPolicyAttachments", "type": "http" }, "http": { "method": "GET", "url": "/20180115/steeringPolicyAttachments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page of the collection.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the resource belongs to." }, { "name": "id", "value": "", "type": "query", "description": "The OCID of a resource." }, { "name": "displayName", "value": "", "type": "query", "description": "The displayName of a resource." }, { "name": "steeringPolicyId", "value": "", "type": "query", "description": "Search by steering policy OCID.\nWill match any resource whose steering policy ID matches the provided value.\n" }, { "name": "zoneId", "value": "", "type": "query", "description": "Search by zone OCID.\nWill match any resource whose zone ID matches the provided value.\n" }, { "name": "domain", "value": "", "type": "query", "description": "Search by domain.\nWill match any record whose domain (case-insensitive) equals the provided value.\n" }, { "name": "domainContains", "value": "", "type": "query", "description": "Search by domain.\nWill match any record whose domain (case-insensitive) contains the provided value.\n" }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states\nall returned resources were created on or after the indicated time.\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states\nall returned resources were created before the indicated time.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of a resource." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field by which to sort steering policy attachments. If unspecified, defaults to `timeCreated`." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The order to sort the resources.\n" }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Lists the steering policy attachments in the specified compartment.\n" }, { "info": { "name": "CreateSteeringPolicyAttachment", "type": "http" }, "http": { "method": "POST", "url": "/20180115/steeringPolicyAttachments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new attachment between a steering policy and a domain, giving the\npolicy permission to answer queries for the specified domain. A steering policy must\nbe attached to a domain for the policy to answer DNS queries for that domain.\n\nFor the purposes of access control, the attachment is automatically placed\ninto the same compartment as the domain's zone.\n\nAttachments cannot be created for private zones.\n" }, { "info": { "name": "GetSteeringPolicyAttachment", "type": "http" }, "http": { "method": "GET", "url": "/20180115/steeringPolicyAttachments/:steeringPolicyAttachmentId", "headers": [ { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "steeringPolicyAttachmentId", "value": "", "type": "path", "description": "The OCID of the target steering policy attachment." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Gets information about the specified steering policy attachment.\n" }, { "info": { "name": "UpdateSteeringPolicyAttachment", "type": "http" }, "http": { "method": "PUT", "url": "/20180115/steeringPolicyAttachments/:steeringPolicyAttachmentId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "steeringPolicyAttachmentId", "value": "", "type": "path", "description": "The OCID of the target steering policy attachment." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified steering policy attachment with your new information.\n" }, { "info": { "name": "DeleteSteeringPolicyAttachment", "type": "http" }, "http": { "method": "DELETE", "url": "/20180115/steeringPolicyAttachments/:steeringPolicyAttachmentId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "steeringPolicyAttachmentId", "value": "", "type": "path", "description": "The OCID of the target steering policy attachment." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Deletes the specified steering policy attachment.\nA `204` response indicates that the delete has been successful.\n" }, { "info": { "name": "ListTsigKeys", "type": "http" }, "http": { "method": "GET", "url": "/20180115/tsigKeys", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page of the collection.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the resource belongs to." }, { "name": "id", "value": "", "type": "query", "description": "The OCID of a resource." }, { "name": "name", "value": "", "type": "query", "description": "The name of a resource." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of a resource." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field by which to sort TSIG keys. If unspecified, defaults to `timeCreated`." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The order to sort the resources.\n" }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Gets a list of all TSIG keys in the specified compartment.\n" }, { "info": { "name": "CreateTsigKey", "type": "http" }, "http": { "method": "POST", "url": "/20180115/tsigKeys", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new TSIG key in the specified compartment. There is no\n`opc-retry-token` header since TSIG key names must be globally unique.\n" }, { "info": { "name": "GetTsigKey", "type": "http" }, "http": { "method": "GET", "url": "/20180115/tsigKeys/:tsigKeyId", "headers": [ { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tsigKeyId", "value": "", "type": "path", "description": "The OCID of the target TSIG key." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Gets information about the specified TSIG key.\n" }, { "info": { "name": "UpdateTsigKey", "type": "http" }, "http": { "method": "PUT", "url": "/20180115/tsigKeys/:tsigKeyId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tsigKeyId", "value": "", "type": "path", "description": "The OCID of the target TSIG key." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified TSIG key.\n" }, { "info": { "name": "DeleteTsigKey", "type": "http" }, "http": { "method": "DELETE", "url": "/20180115/tsigKeys/:tsigKeyId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tsigKeyId", "value": "", "type": "path", "description": "The OCID of the target TSIG key." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Deletes the specified TSIG key.\n" }, { "info": { "name": "ChangeTsigKeyCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20180115/tsigKeys/:tsigKeyId/actions/changeCompartment", "headers": [ { "name": "If-Match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "tsigKeyId", "value": "", "type": "path", "description": "The OCID of the target TSIG key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a TSIG key into a different compartment.\n" }, { "info": { "name": "ListViews", "type": "http" }, "http": { "method": "GET", "url": "/20180115/views", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the resource belongs to." }, { "name": "displayName", "value": "", "type": "query", "description": "The displayName of a resource." }, { "name": "id", "value": "", "type": "query", "description": "The OCID of a resource." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page of the collection.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The order to sort the resources.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field by which to sort views." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of a resource." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Gets a list of all views within a compartment.\n\nThe collection can be filtered by display name, id, or lifecycle state. It can be sorted\non creation time or displayName both in ASC or DESC order. Note that when no lifecycleState\nquery parameter is provided, the collection does not include views in the DELETED\nlifecycleState to be consistent with other operations of the API.\n" }, { "info": { "name": "CreateView", "type": "http" }, "http": { "method": "POST", "url": "/20180115/views", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new view in the specified compartment.\n" }, { "info": { "name": "GetView", "type": "http" }, "http": { "method": "GET", "url": "/20180115/views/:viewId", "headers": [ { "name": "If-Modified-Since", "value": "" }, { "name": "If-None-Match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "viewId", "value": "", "type": "path", "description": "The OCID of the target view." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Gets information about a specific view.\n\nNote that attempting to get a\nview in the DELETED lifecycleState will result in a `404` response to be\nconsistent with other operations of the API.\n" }, { "info": { "name": "UpdateView", "type": "http" }, "http": { "method": "PUT", "url": "/20180115/views/:viewId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "viewId", "value": "", "type": "path", "description": "The OCID of the target view." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified view with your new information.\n" }, { "info": { "name": "DeleteView", "type": "http" }, "http": { "method": "DELETE", "url": "/20180115/views/:viewId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "viewId", "value": "", "type": "path", "description": "The OCID of the target view." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ] }, "docs": "Deletes the specified view.\n\nNote that attempting to delete a view in the DELETED lifecycleState will result in a `404`\nresponse to be consistent with other operations of the API. Views cannot be\ndeleted if they are referenced by non-deleted zones or resolvers.\nProtected views cannot be deleted.\n" }, { "info": { "name": "ChangeViewCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20180115/views/:viewId/actions/changeCompartment", "headers": [ { "name": "If-Match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "viewId", "value": "", "type": "path", "description": "The OCID of the target view." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a view into a different compartment.\n\nTo change the compartment of a protected view, change the compartment of its corresponding resolver.\n" }, { "info": { "name": "ListZoneTransferServers", "type": "http" }, "http": { "method": "GET", "url": "/20180115/zoneTransferServers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the resource belongs to." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" } ] }, "docs": "Gets a list of IP addresses of OCI nameservers for inbound and outbound transfer of zones in the specified\ncompartment (which must be the root compartment of a tenancy) that transfer zone data with external master or\ndownstream nameservers.\n" }, { "info": { "name": "ListZones", "type": "http" }, "http": { "method": "GET", "url": "/20180115/zones", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page of the collection.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the resource belongs to." }, { "name": "name", "value": "", "type": "query", "description": "A case-sensitive filter for zone names.\nWill match any zone with a name that equals the provided value.\n" }, { "name": "nameContains", "value": "", "type": "query", "description": "Search by zone name.\nWill match any zone whose name (case-insensitive) contains the provided value.\n" }, { "name": "zoneType", "value": "", "type": "query", "description": "Search by zone type, `PRIMARY` or `SECONDARY`.\nWill match any zone whose type equals the provided value.\n" }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states\nall returned resources were created on or after the indicated time.\n" }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states\nall returned resources were created before the indicated time.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of a resource." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field by which to sort zones." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The order to sort the resources.\n" }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the resource is associated with." }, { "name": "tsigKeyId", "value": "", "type": "query", "description": "Search for zones that are associated with a TSIG key.\n" }, { "name": "dnssecState", "value": "", "type": "query", "description": "Search for zones that have the given `DnssecState`.\n" } ] }, "docs": "Gets a list of all zones in the specified compartment.\n\nThe collection can be filtered by name, time created, scope, associated view, and zone type.\nFiltering by view is only supported for private zones.\n" }, { "info": { "name": "CreateZone", "type": "http" }, "http": { "method": "POST", "url": "/20180115/zones", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the resource is associated with." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new zone in the specified compartment.\n\nPrivate zones must have a zone type of `PRIMARY`. Creating a private zone at or under `oraclevcn.com`\nwithin the default protected view of a VCN-dedicated resolver is not permitted.\n" }, { "info": { "name": "ChangeZoneCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20180115/zones/:zoneId/actions/changeCompartment", "headers": [ { "name": "If-Match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "zoneId", "value": "", "type": "path", "description": "The OCID of the target zone." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a zone into a different compartment.\n\nProtected zones cannot have their compartment changed. When the zone name is provided as a path\nparameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is\nrequired.\n\n**Note:** All SteeringPolicyAttachment objects associated with this zone will also be moved into\nthe provided compartment.\n" }, { "info": { "name": "PromoteZoneDnssecKeyVersion", "type": "http" }, "http": { "method": "POST", "url": "/20180115/zones/:zoneId/actions/promoteDnssecKeyVersion", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "zoneId", "value": "", "type": "path", "description": "The OCID of the target zone." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Promotes a specified `DnssecKeyVersion` on the zone.\n\nIf the `DnssecKeyVersion` identified in the request body is a key signing key (KSK) that is replacing\nanother `DnssecKeyVersion`, then the old `DnssecKeyVersion` is scheduled for removal from the zone.\n\nFor key signing keys (KSKs), you must create the DS record with the new key information **before** promoting\nthe new key to establish a chain of trust. To avoid a service disruption, remove the old DS record as soon\nas its TTL (time to live) e" }, { "info": { "name": "StageZoneDnssecKeyVersion", "type": "http" }, "http": { "method": "POST", "url": "/20180115/zones/:zoneId/actions/stageDnssecKeyVersion", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "zoneId", "value": "", "type": "path", "description": "The OCID of the target zone." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stages a new `DnssecKeyVersion` on the zone. Staging is a process that generates a new \"successor\" key version\nthat replaces an existing \"predecessor\" key version.\n**Note:** A new key-signing key (KSK) version is inert until you update the parent zone DS records.\n\nFor more information, see the [DNSSEC](/iaas/Content/DNS/Concepts/dnssec.htm) documentation.\n" }, { "info": { "name": "GetZone", "type": "http" }, "http": { "method": "GET", "url": "/20180115/zones/:zoneNameOrId", "headers": [ { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" } ] }, "docs": "Gets information about the specified zone, including its creation date, zone type, and serial.\n\nWhen the zone name is provided as a path parameter and `PRIVATE` is used for the scope query\nparameter then the viewId query parameter is required.\n" }, { "info": { "name": "UpdateZone", "type": "http" }, "http": { "method": "PUT", "url": "/20180115/zones/:zoneNameOrId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the zone with the specified information.\n\nGlobal secondary zones may have their external masters updated. For more information about secondary\nzones, see [Manage DNS Service Zone](/iaas/Content/DNS/Tasks/managingdnszones.htm). When the zone name\nis provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId\nquery parameter is required.\n" }, { "info": { "name": "DeleteZone", "type": "http" }, "http": { "method": "DELETE", "url": "/20180115/zones/:zoneNameOrId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" } ] }, "docs": "Deletes the specified zone and all its steering policy attachments.\n\nA `204` response indicates that the zone has been successfully deleted. Protected zones cannot be deleted.\nWhen the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter\nthen the viewId query parameter is required.\n" }, { "info": { "name": "GetZoneContent", "type": "http" }, "http": { "method": "GET", "url": "/20180115/zones/:zoneNameOrId/content", "headers": [ { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." } ] }, "docs": "Gets the requested zone's zone file.\n" }, { "info": { "name": "GetZoneRecords", "type": "http" }, "http": { "method": "GET", "url": "/20180115/zones/:zoneNameOrId/records", "headers": [ { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page of the collection.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "zoneVersion", "value": "", "type": "query", "description": "The version of the zone for which data is requested.\n" }, { "name": "domain", "value": "", "type": "query", "description": "Search by domain.\nWill match any record whose domain (case-insensitive) equals the provided value.\n" }, { "name": "domainContains", "value": "", "type": "query", "description": "Search by domain.\nWill match any record whose domain (case-insensitive) contains the provided value.\n" }, { "name": "rtype", "value": "", "type": "query", "description": "Search by record type.\nWill match any record whose [type](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4) (case-insensitive) equals the provided value.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field by which to sort records." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The order to sort the resources.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." } ] }, "docs": "Gets all records in the specified zone.\n\nThe results are sorted by `domain` in alphabetical order by default. For more information about records,\nsee [Resource Record (RR) TYPEs](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4).\nWhen the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter\nthen the viewId query parameter is required.\n" }, { "info": { "name": "UpdateZoneRecords", "type": "http" }, "http": { "method": "PUT", "url": "/20180115/zones/:zoneNameOrId/records", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces records in the specified zone with the records specified in the request body.\n\nIf a specified record does not exist, it will be created. If the record exists, then it will be updated\nto represent the record in the body of the request. If a record in the zone does not exist in the\nrequest body, the record will be removed from the zone. When the zone name is provided as a path\nparameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is\nrequired.\n" }, { "info": { "name": "PatchZoneRecords", "type": "http" }, "http": { "method": "PATCH", "url": "/20180115/zones/:zoneNameOrId/records", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a collection of records in the specified zone.\n\nYou can update one record or all records for the specified zone depending on the changes provided in the\nrequest body. You can also add or remove records using this function. When the zone name is provided as\na path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is\nrequired.\n" }, { "info": { "name": "GetDomainRecords", "type": "http" }, "http": { "method": "GET", "url": "/20180115/zones/:zoneNameOrId/records/:domain", "headers": [ { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "domain", "value": "", "type": "path", "description": "The target fully-qualified domain name (FQDN) within the target zone." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page of the collection.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "zoneVersion", "value": "", "type": "query", "description": "The version of the zone for which data is requested.\n" }, { "name": "rtype", "value": "", "type": "query", "description": "Search by record type.\nWill match any record whose [type](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4) (case-insensitive) equals the provided value.\n" }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field by which to sort records." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The order to sort the resources.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" } ] }, "docs": "Gets a list of all records at the specified zone and domain.\n\nThe results are sorted by `rtype` in alphabetical order by default. You can optionally filter and/or sort\nthe results using the listed parameters. When the zone name is provided as a path parameter and `PRIVATE`\nis used for the scope query parameter then the viewId query parameter is required.\n" }, { "info": { "name": "UpdateDomainRecords", "type": "http" }, "http": { "method": "PUT", "url": "/20180115/zones/:zoneNameOrId/records/:domain", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "domain", "value": "", "type": "path", "description": "The target fully-qualified domain name (FQDN) within the target zone." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces records in the specified zone at a domain with the records specified in the request body.\n\nIf a specified record does not exist, it will be created. If the record exists, then it will be updated to\nrepresent the record in the body of the request. If a record in the zone does not exist in the request body,\nthe record will be removed from the zone. When the zone name is provided as a path parameter and `PRIVATE`\nis used for the scope query parameter then the viewId query parameter is requ" }, { "info": { "name": "PatchDomainRecords", "type": "http" }, "http": { "method": "PATCH", "url": "/20180115/zones/:zoneNameOrId/records/:domain", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "domain", "value": "", "type": "path", "description": "The target fully-qualified domain name (FQDN) within the target zone." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates records in the specified zone at a domain.\n\nYou can update one record or all records for the specified zone depending on the changes provided in the\nrequest body. You can also add or remove records using this function. When the zone name is provided as\na path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is\nrequired.\n" }, { "info": { "name": "DeleteDomainRecords", "type": "http" }, "http": { "method": "DELETE", "url": "/20180115/zones/:zoneNameOrId/records/:domain", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "domain", "value": "", "type": "path", "description": "The target fully-qualified domain name (FQDN) within the target zone." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" } ] }, "docs": "Deletes all records at the specified zone and domain.\n\nWhen the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter\nthen the viewId query parameter is required.\n" }, { "info": { "name": "GetRRSet", "type": "http" }, "http": { "method": "GET", "url": "/20180115/zones/:zoneNameOrId/records/:domain/:rtype", "headers": [ { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "domain", "value": "", "type": "path", "description": "The target fully-qualified domain name (FQDN) within the target zone." }, { "name": "rtype", "value": "", "type": "path", "description": "The type of the target RRSet within the target zone." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a page of the collection.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "zoneVersion", "value": "", "type": "query", "description": "The version of the zone for which data is requested.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." } ] }, "docs": "Gets a list of all records in the specified RRSet.\n\nThe results are sorted by `recordHash` by default. When the zone name is provided as a path parameter\nand `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.\n" }, { "info": { "name": "UpdateRRSet", "type": "http" }, "http": { "method": "PUT", "url": "/20180115/zones/:zoneNameOrId/records/:domain/:rtype", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "domain", "value": "", "type": "path", "description": "The target fully-qualified domain name (FQDN) within the target zone." }, { "name": "rtype", "value": "", "type": "path", "description": "The type of the target RRSet within the target zone." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces records in the specified RRSet.\n\nWhen the zone name is provided as a path parameter and `PRIVATE` is used for the scope\nquery parameter then the viewId query parameter is required.\n" }, { "info": { "name": "PatchRRSet", "type": "http" }, "http": { "method": "PATCH", "url": "/20180115/zones/:zoneNameOrId/records/:domain/:rtype", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "domain", "value": "", "type": "path", "description": "The target fully-qualified domain name (FQDN) within the target zone." }, { "name": "rtype", "value": "", "type": "path", "description": "The type of the target RRSet within the target zone." }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates records in the specified RRSet.\n\nWhen the zone name is provided as a path parameter and `PRIVATE` is used for the scope query\nparameter then the viewId query parameter is required.\n" }, { "info": { "name": "DeleteRRSet", "type": "http" }, "http": { "method": "DELETE", "url": "/20180115/zones/:zoneNameOrId/records/:domain/:rtype", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "zoneNameOrId", "value": "", "type": "path", "description": "The name or OCID of the target zone." }, { "name": "domain", "value": "", "type": "path", "description": "The target fully-qualified domain name (FQDN) within the target zone." }, { "name": "rtype", "value": "", "type": "path", "description": "The type of the target RRSet within the target zone." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment the zone belongs to.\n\nThis parameter is deprecated and should be omitted.\n" }, { "name": "scope", "value": "", "type": "query", "description": "Specifies to operate only on resources that have a matching DNS scope.\n" }, { "name": "viewId", "value": "", "type": "query", "description": "The OCID of the view the zone is associated with. Required when accessing a private zone by name." } ] }, "docs": "Deletes all records in the specified RRSet.\n\nWhen the zone name is provided as a path parameter and `PRIVATE` is used for the scope\nquery parameter then the viewId query parameter is required.\n" } ] } ], "bundled": true }