v61

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB
Private DNS

List Private DNS

Returns a paginated collection of private DNS attachments for a given network.

get/v2/cloud-gateways/networks/{networkId}/private-dns

Path parameters

networkIdstring uuid required

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 network to operate on.

Query parameters

Filters supported for Private DNS.

page[size]integer
Example:10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]integer
Example:1

Determines which page of the entities to retrieve.

Response

A paginated list for a collection of Private DNS for a network.

Example response

{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  },
  "data": [
    {
      "id": "1850820b-c69f-4a2a-b9be-bbcdbc5cd618",
      "state_metadata": {
        "reported_status": "ERROR",
        "reason": "Failed to create Private Dns due to invalid Cloud Provider configuration.\n"
      },
      "entity_version": 1,
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z",
      "name": "us-east-2-private-dns"
    }
  ]
}