Deprecated REST API Documentation

Deprecated REST API Documentation


In the REST API examples, HTTP requests are defined as raw HTTP. For example:

POST /v2/pools HTTP/1.1
Accept: application/json
Content-Type: application/json

     "name": "Example Pool",
     "ns_records": [
           "hostname": "",
           "priority": 1

With this info we can make this request using the cURL tool. We’ll assume we are running Designate on localhost.

curl -X POST -i \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '{"name": ""}' \

The -i flag is used to dump the response headers as well as the response body.

The cURL tool is extremely robust. Please take a look at the cURL tutorial for more info.

HTTP Headers

These headers work for all APIs

  • X-Designate-Edit-Managed-Records
    • Allows admins (or users with the right role) to modify managed records (records created by designate-sink / reverse floating ip API)
  • X-Auth-All-Projects
    • Allows admins (or users with the right role) to view and edit zones / recordsets for all tenants
  • X-Auth-Sudo-Tenant-ID / X-Auth-Sudo-Project-ID
    • Allows admins (or users with the right role) to impersonate another tenant specified by this header
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.