List Private DNS
Returns a paginated collection of Private DNS for a given network.
Query Parameters
Filters supported for Private DNS.
Show Child Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Path Parameters
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695
Response
application/json
Response
A paginated list for a collection of Private DNS for a network.
ListPrivateDnsResponse
returns the pagination information
Show Child Parameters
One OfShow Child Parameters
Authentication
Path Parameters
Query Parameters
Create Private DNS
Creates a new Private DNS for a given network.
Path Parameters
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695
Body
application/json
Body
CreatePrivateDnsRequest
Request schema for creating a Private DNS.
Human-readable name of the Private DNS.
Example:us-east-2 private dns
One OfShow Child Parameters
Response
application/json
Response
Response format for creating a Private DNS.
PrivateDnsResponse
One OfExample:1850820b-c69f-4a2a-b9be-bbcdbc5cd618
The current state of the Private DNS attachment. Possible values:
created- The attachment has been created but is not attached to Private DNS.initializing- The attachment is in the process of being initialized and is setting up necessary resources.pending-associationThe attachment request is awaiting association to the cloud provider infrastructure in order for provisioning to proceed.ready- The attachment is fully operational and can route traffic as configured.error- The attachment is in an error state, and is not operational.terminating- The attachment is in the process of being deleted.terminated- The attachment has been fully deleted and is no longer available.
Allowed values:createdinitializingpending-associationreadyerrorterminatingterminated
Metadata describing the backing state of the Private Dns and why it may be in an erroneous state.
Show Child Parameters
Monotonically-increasing version count of the Private DNS, to indicate the order of updates to the
Private DNS.
Example:1
An RFC-3339 timestamp representation of Private DNS creation date.
Example:2022-11-04T20:10:06.927Z
An RFC-3339 timestamp representation of Private DNS update date.
Example:2022-11-04T20:10:06.927Z
Human-readable name of the Private DNS.
Example:us-east-2 private dns
Show Child Parameters
Authentication
Path Parameters
Body
Get Private DNS
Retrieves a Private DNS by ID for a given network.
Path Parameters
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695
The ID of the Private DNS to operate on.
Example:1850820b-c69f-4a2a-b9be-bbcdbc5cd618
Response
application/json
Response
Response format for retrieving a Private DNS.
PrivateDnsResponse
One OfExample:1850820b-c69f-4a2a-b9be-bbcdbc5cd618
The current state of the Private DNS attachment. Possible values:
created- The attachment has been created but is not attached to Private DNS.initializing- The attachment is in the process of being initialized and is setting up necessary resources.pending-associationThe attachment request is awaiting association to the cloud provider infrastructure in order for provisioning to proceed.ready- The attachment is fully operational and can route traffic as configured.error- The attachment is in an error state, and is not operational.terminating- The attachment is in the process of being deleted.terminated- The attachment has been fully deleted and is no longer available.
Allowed values:createdinitializingpending-associationreadyerrorterminatingterminated
Metadata describing the backing state of the Private Dns and why it may be in an erroneous state.
Show Child Parameters
Monotonically-increasing version count of the Private DNS, to indicate the order of updates to the
Private DNS.
Example:1
An RFC-3339 timestamp representation of Private DNS creation date.
Example:2022-11-04T20:10:06.927Z
An RFC-3339 timestamp representation of Private DNS update date.
Example:2022-11-04T20:10:06.927Z
Human-readable name of the Private DNS.
Example:us-east-2 private dns
Show Child Parameters
Authentication
Path Parameters
Update Private DNS
Updates a Private DNS by ID for a given network.
Path Parameters
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695
The ID of the Private DNS to operate on.
Example:1850820b-c69f-4a2a-b9be-bbcdbc5cd618
Body
application/json
Body
PatchPrivateDnsRequest
Request schema for updating a Private DNS.
One OfHuman-readable name of the Private DNS.
Example:us-east-2 private dns
Show Child Parameters
Response
application/json
Response
Response format for updating a Private DNS.
PrivateDnsResponse
One OfExample:1850820b-c69f-4a2a-b9be-bbcdbc5cd618
The current state of the Private DNS attachment. Possible values:
created- The attachment has been created but is not attached to Private DNS.initializing- The attachment is in the process of being initialized and is setting up necessary resources.pending-associationThe attachment request is awaiting association to the cloud provider infrastructure in order for provisioning to proceed.ready- The attachment is fully operational and can route traffic as configured.error- The attachment is in an error state, and is not operational.terminating- The attachment is in the process of being deleted.terminated- The attachment has been fully deleted and is no longer available.
Allowed values:createdinitializingpending-associationreadyerrorterminatingterminated
Metadata describing the backing state of the Private Dns and why it may be in an erroneous state.
Show Child Parameters
Monotonically-increasing version count of the Private DNS, to indicate the order of updates to the
Private DNS.
Example:1
An RFC-3339 timestamp representation of Private DNS creation date.
Example:2022-11-04T20:10:06.927Z
An RFC-3339 timestamp representation of Private DNS update date.
Example:2022-11-04T20:10:06.927Z
Human-readable name of the Private DNS.
Example:us-east-2 private dns
Show Child Parameters
Authentication
Path Parameters
Body
Delete Private DNS
Deletes a Private DNS by ID for a given network.
Path Parameters
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695
The ID of the Private DNS to operate on.
Example:1850820b-c69f-4a2a-b9be-bbcdbc5cd618
Response
Response
No Content