openstack/designate
Code Issues Proposed changes
6b161e41a1
designate/doc/source/rest/records.rst
Kiall Mac Innes 9a9a32e942 Update Docs with GetRecord call 
Change-Id: I1299537deccece151889d90cf44cf09edcf3b67d
2013-01-18 12:11:12 +00:00

8.4 KiB
Raw Blame History

Records

Resource record entries are used to generate records within a zone

TODO: More detail.

Create Record

Create an A record for a domain

Example request:

POST /domains/89acac79-38e7-497d-807c-a011e1310438/records HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json

{
  "name": "www.example.com.",
  "type": "A",
  "data": "15.185.172.152"
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 399
Location: http://localhost:9001/v1/domains/89acac79-38e7-497d-807c-a011e1310438/records/2e32e609-3a4f-45ba-bdef-e50eacd345ad
Date: Fri, 02 Nov 2012 19:56:26 GMT

{
  "id": "2e32e609-3a4f-45ba-bdef-e50eacd345ad",
  "name": "www.example.com.",
  "type": "A",
  "created_at": "2012-11-02T19:56:26.366792",
  "updated_at": null,
  "domain_id": "89acac79-38e7-497d-807c-a011e1310438",
  "ttl": 3600,
  "data": "15.185.172.152",
}
param domain_id

domain ID

form id

record id

form name

name of record FQDN

form type

type of record

form created_at

timestamp

form ttl

time-to-live numeric value in seconds

form data

value of record

form domain_id

domain ID

form priority

priority of MX record

statuscode 200

Success

statuscode 401

Access Denied

statuscode 400

Invalid Object

statuscode 409

Duplicate Domain

Create an MX record for a domain

Example request:

POST /domains/89acac79-38e7-497d-807c-a011e1310438/records HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json

{
  "name": "example.com.",
  "type": "MX",
  "data": "mail.example.com.",
  "priority": 10
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 420
Location: http://localhost:9001/v1/domains/89acac79-38e7-497d-807c-a011e1310438/records/11112222-3333-4444-5555-666677778888
Date: Fri, 02 Nov 2012 19:56:26 GMT

{
  "id": "11112222-3333-4444-5555-666677778888",
  "name": "www.example.com.",
  "type": "MX",
  "created_at": "2013-01-07T00:00:00.000000",
  "updated_at": null,
  "domain_id": "89acac79-38e7-497d-807c-a011e1310438",
  "priority": 10,
  "ttl": 3600,
  "data": "mail.example.com."
}
param domain_id

domain ID

form id

record id

form name

name of record FQDN

form type

type of record

form created_at

timestamp

form ttl

time-to-live numeric value in seconds

form data

value of record

form domain_id

domain ID

form priority

priority of MX record

statuscode 200

Success

statuscode 401

Access Denied

statuscode 400

Invalid Object

statuscode 409

Duplicate Domain

Get a Record

Get a particular record

Example request:

GET /domains/09494b72b65b42979efb187f65a0553e/records/2e32e609-3a4f-45ba-bdef-e50eacd345ad HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "id": "2e32e609-3a4f-45ba-bdef-e50eacd345ad",
  "name": "www.example.com.",
  "type": "A",
  "created_at": "2012-11-02T19:56:26.366792",
  "updated_at": "2012-11-04T13:22:36.859786",
  "priority": null,
  "ttl": 3600,
  "data": "15.185.172.153",
  "domain_id": "89acac79-38e7-497d-807c-a011e1310438"
}
param domain_id

Domain ID

param id

Record ID

form id

record id

form name

name of record FQDN

form type

type of record

form created_at

timestamp

form updated_at

timestamp

form priority

priority of record

form ttl

time-to-live numeric value in seconds

form data

value of record

form domain_id

domain ID

statuscode 200

Success

statuscode 401

Access Denied

Update a record

Updates a record

Example request:

PUT /domains/89acac79-38e7-497d-807c-a011e1310438/records/2e32e609-3a4f-45ba-bdef-e50eacd345ad
Host: example.com
Accept: application/json
Content-Type: application/json
{
  "name": "www.example.com.",
  "type": "A",
  "data": "15.185.172.153"
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 446
Date: Sun, 04 Nov 2012 13:22:36 GMT

{
  "id": "2e32e609-3a4f-45ba-bdef-e50eacd345ad",
  "name": "www.example.com.",
  "type": "A",
  "created_at": "2012-11-02T19:56:26.366792",
  "updated_at": "2012-11-04T13:22:36.859786",
  "priority": null,
  "ttl": 3600,
  "data": "15.185.172.153",
  "domain_id": "89acac79-38e7-497d-807c-a011e1310438"
}
param domain_id

domain ID

param id

record ID

form id

record id

form name

name of record FQDN

form type

type of record

form created_at

timestamp

form updated_at

timestamp

form priority

priority of record

form ttl

time-to-live numeric value in seconds

form data

value of record

form domain_id

domain ID

statuscode 200

Success

statuscode 401

Access Denied

statuscode 400

Invalid Object

statuscode 409

Duplicate Domain

Delete a record

Delete a DNS resource record

Example request:

DELETE /domains/89acac79-38e7-497d-807c-a011e1310438/records/4ad19089-3e62-40f8-9482-17cc8ccb92cb HTTP/1.1
param domain_id

domain ID

param id

record ID

Example response:

Content-Type: text/html; charset=utf-8 Content-Length: 0 Date: Sun, 04 Nov 2012 14:35:57 GMT

List Records in a Domain

Lists records of a domain

Example request:

GET /domains/89acac79-38e7-497d-807c-a011e1310438/records HTTP/1.1
Host: example.com
Accept: application/json

Example response:

Content-Type: application/json
Content-Length: 1209
Date: Sun, 04 Nov 2012 13:58:21 GMT

{
  "records": [
    {
      "id": "2e32e609-3a4f-45ba-bdef-e50eacd345ad"
      "name": "www.example.com.",
      "type": "A",
      "ttl": 3600,
      "created_at": "2012-11-02T19:56:26.000000",
      "updated_at": "2012-11-04T13:22:36.000000",
      "data": "15.185.172.153",
      "domain_id": "89acac79-38e7-497d-807c-a011e1310438",
      "tenant_id": null,
      "priority": null,
      "version": 1,
    },
    {
      "id": "8e9ecf3e-fb92-4a3a-a8ae-7596f167bea3"
      "name": "host1.example.com.",
      "type": "A",
      "ttl": 3600,
      "created_at": "2012-11-04T13:57:50.000000",
      "updated_at": null,
      "data": "15.185.172.154",
      "domain_id": "89acac79-38e7-497d-807c-a011e1310438",
      "tenant_id": null,
      "priority": null,
      "version": 1,
    },
    {
      "id": "4ad19089-3e62-40f8-9482-17cc8ccb92cb"
      "name": "web.example.com.",
      "type": "CNAME",
      "ttl": 3600,
      "created_at": "2012-11-04T13:58:16.393735",
      "updated_at": null,
      "data": "www.example.com.",
      "domain_id": "89acac79-38e7-497d-807c-a011e1310438",
      "tenant_id": null,
      "priority": null,
      "version": 1,
    }
  ]
}
param domain_id

domain ID

form id

record id

form name

name of record FQDN

form type

type of record

form created_at

timestamp

form updated_at

timestamp

form priority

priority of record

form ttl

time-to-live numeric value in seconds

form data

value of record

form domain_id

domain ID

statuscode 200

Success

statuscode 401

Access Denied