designate/doc/source/rest/v1/sync.rst

Synchronize

Overview

Note: Synchronize is an extension and needs to be enabled before it can be used. If Designate returns a 404 error, ensure that the following line has been added to the designate.conf file:

enabled_extensions_v1 = sync, ...

Trigger a synchronization of one or more resource(s) in the system.

Synchronize all domains

Synchronize all domains

Example request:

POST /domains/sync HTTP/1.1
Host: example.com
Content-Type: application/json

Example response:

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

statuscode 200

Success

statuscode 401

Access Denied

Synchronize one domain

Synchronize one domain

Example request:

POST /domains/1dd7851a-74e7-4ddb-b6e8-38a610956bd5/sync HTTP/1.1
Host: example.com
Content-Type: application/json

Example response:

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

statuscode 200

Success

statuscode 401

Access Denied

Synchronize one record

Synchronize one record

Example request:

POST /domains/1dd7851a-74e7-4ddb-b6e8-38a610956bd5/records/1dd7851a-74e7-4ddb-b6e8-38a610956bd5/sync HTTP/1.1
Host: example.com
Content-Type: application/json

Example response:

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

statuscode 200

Success

statuscode 401

Access Denied