openstack/designate
Code Issues Proposed changes
161c6d5a5d
designate/doc/source/user/rest.rst
Andreas Jaeger ad32f7a15d Update api-ref location 
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: Ibd4ed1a1e282f0088467a6fcafe44b1dad46ed5f
2019-07-22 18:36:31 +02:00

1.8 KiB
Raw Blame History

Deprecated REST API Documentation

Intro

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

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

{
     "name": "example.org.",
     "email": "hostmaster@example.org"
}

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": "example.org.", "email": "hostmaster@example.org"}' \
     http://localhost:9001/v2/zones

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

API Versions

V2 API

The V2 API is documented on the OpenStack Developer api site

Admin API

rest/admin/quotas