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"
    }
  ]
}

Changes

Changed in 9 of the 75 revisions of this API.40124

    • for the query request parameter filter, the type of property name was specialized from no type to object

      request-parameter-property-type-specialized

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added to the / response property oneOf list for the response status

      response-property-one-of-added

    • added the new type enum value to the /////// response property for the response status

      response-property-enum-value-added

    • added the required property ////// to the response with the status

      response-required-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property /////// became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6333a0d3b095318See the full diff
    • added to the / response property oneOf list for the response status

      response-property-one-of-added

    • the ///// response's property type changed from no type to object for status

      response-property-type-changed

    • the ///// response's property type changed from no type to object for status

      response-property-type-changed

    • removed subschema #2 from the ///// response property allOf list for the response status

      response-property-all-of-removed

    • removed subschema #2 from the ///// response property allOf list for the response status

      response-property-all-of-removed

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    • added the required property ////// to the response with the status

      response-required-property-added

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 76b0fefddb0d182See the full diff
    • the ///// response's property type changed from object to no type for status

      response-property-type-changed

    • the ///// response's property type changed from object to no type for status

      response-property-type-changed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • removed the required property ////// from the response with the status

      response-required-property-removed

    • added subschema #2 to the ///// response property allOf list for the response status

      response-property-all-of-added

    • added subschema #2 to the ///// response property allOf list for the response status

      response-property-all-of-added

    • endpoint added

      endpoint-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog