Update Exception Domain

Exception Domain APIs

OVERVIEW

Overview

Update an existing exception domain in Publisher. This API call is used to update an existing exception domain in the system, by replacing the exception domain with the provided exception domain object.

Since v5.0

HTTP Request

PUT /api/2/exceptiondomains/<ID>

PUT /api/2/exceptiondomains/<DOMAIN>

HTTP Request Object

Exception Domain Object, either in JSON or XML format.

URL Parameters

Parameter	Description
ID	The ID of the exception domain to update
DOMAIN	The exception domain to update

HTTP Headers

HTTP Request Header	Description	Example
Authorization	The API Authorisation token.	"Bearer XXXXXXXXXXXXX"
Accept	The format of the expected response. "application/json" "application/xml" If no parameter is set, JSON is the default response given.	"application/xml"
Content-Type	The format of the provided content. "application/json" "application/xml" If no parameter is set, JSON is the expected content by default.	"application/json"

HTTP Request Header

Description

Example

Authorization

The API Authorisation token.

"Bearer XXXXXXXXXXXXX"

Accept

The format of the expected response.

"application/json"
"application/xml"

If no parameter is set, JSON is the default response given.

"application/xml"

Content-Type

The format of the provided content.

"application/json"
"application/xml"

If no parameter is set, JSON is the expected content by default.

"application/json"

HTTP Response

Success

HTTP response 200 with Exception Domain Object

(Example below)

Error

See API Error messages

Example HTTP Request & Response

PUT http://example.com/context/api/2/exceptiondomains/3

PUT http://example.com/context/api/2/exceptiondomains/unknown.com

JSON Request

{

"domain": {

"url": "unknown1.com",

"status": "Active"

}

JSON Response

{