Designate API

This is a reference for the OpenStack DNS API which is provided by the Designate project.

Current API version

Supported API version

None

Designate API minor releases are additive to the API major revision and share the same URL path. Minor revision changes to the API are called out in the API reference in the section the change occurred in. Subsequent minor versions are a superset of the previous versions of the same major revision.

The API status reflects the state of the endpoint on the service.

  • Current indicates a stable version that is up-to-date, recent, and might receive future versions. This endpoint should be prioritized over all others.

  • Supported is a stable version that is available on the server. However, it is not likely the most recent available and might not be updated or might be deprecated at some time in the future.

  • Deprecated is a stable version that is still available but is being deprecated and might be removed in the future.

  • Experimental is not a stable version. This version is under development or contains features that are otherwise subject to change.

For more information about API status values and version information, see Version Discovery.

API Versions

Show all enabled API versions

GET
/

List all API versions

Success

Code

Reason
200 - OK

Request was successful.

Error

Code

Reason
400 - Bad Request

Some content in the request was invalid.
405 - Method Not Allowed

Method is not valid for this endpoint and resource.
500 - Internal Server Error

Something went wrong with the service which prevents it from fulfilling the request.
503 - Service Unavailable

The service cannot handle the request right now.

Request

No parameters needed

Response Parameters

Name

In

Type

Description

id

body

string

A common name for the version.

links

body

object

Links to the resource, and other related resources. When a response has been broken into pages, we will include a next link that should be followed to retrieve all results

status

body

string

The status of this API version. This can be one of:

  • CURRENT: This is the preferred version of the API to use.

  • SUPPORTED: This is an older, but still supported version of the API.

  • DEPRECATED: A deprecated version of the API that is slated for removal.

  • EXPERIMENTAL: This version is under development or contains features that are otherwise subject to change or removal.

updated_at

body

datestamp

Date / Time when resource last updated.

Response Example

{
  "versions": [{
    "id": "v2",
    "links": [{
      "href": "http://198.51.100.88/dns/v2",
      "rel": "self"
    }, {
      "href": "https://docs.openstack.org/api-ref/dns",
      "rel": "help"
    }],
    "status": "SUPPORTED",
    "updated": "2022-06-29T00:00:00Z"
  }, {
    "id": "v2.0",
    "links": [{
      "href": "http://198.51.100.88/dns/v2",
      "rel": "self"
    }, {
      "href": "https://docs.openstack.org/api-ref/dns",
      "rel": "help"
    }],
    "status": "CURRENT",
    "updated": "2022-06-29T00:00:00Z"
  }]
}

Note

This is just an example output and does not represent the current API versions available.