Embedded DNS Configuration



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/config/embedded-dns

Summary


Resources Methods
https://localhost:8443/api/rest/config/embedded-dns

GET  Retrieves configuration for embedded DNS service.

PUT  Updates embedded DNS configuration.

Resources


https://localhost:8443/api/rest/config/embedded-dns


Methods

GET


Retrieves configuration for embedded DNS service.
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-embedded-dns-config+xml
Embedded DNS service configuration retrieved successfully.
304
Embedded DNS configuration has not changed since the last search.

Note: The API client must provide the "plcm-embedded-dns-config" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-embedded-dns-config" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
Embedded DNS configuration on the server.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. User roles required: administrator.

PUT


Updates embedded DNS configuration.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-embedded-dns-config+xml

Response

Status Representation Description
204
Embedded DNS configuration updated successfully.
Note: The response will contain an ETag value of the updated resource.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. User roles required: administrator.
409 application/vnd.plcm.plcm-error+xml
Invalid domain name.
409 application/vnd.plcm.plcm-error+xml
Domain is a local name or address.
409 application/vnd.plcm.plcm-error+xml
The embedded DNS feature restricts site names to at most 52 characters.
409 application/vnd.plcm.plcm-error+xml
The request contained ETags in both the header and the body and they do not match.
412 application/vnd.plcm.plcm-error+xml

The resource has changed on the server.

Note: The response will contain the ETag value that reflects the server's resource in the HTTP response header.

The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag.
Refer to the "plcm-embedded-dns-config.xsd" for details.
If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.
428 application/vnd.plcm.plcm-error+xml

The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag.
Refer to the "plcm-embedded-dns-config.xsd" for details.
If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.