Exception Domain APIs

Archive Exception Domain

OVERVIEW

Overview

Archive an exception domain within Publisher

Since v5.0

 

HTTP Request

POST  /api/2/exceptiondomains/<ID>/archive

OR

POST  /api/2/exceptiondomains/<DOMAIN>/archive

 

URL Parameters
Parameter Description
ID The ID of the exception domain to archive
DOMAIN The exception domain to archive

 

HTTP Request Object

No data is passed in the HTTP Request

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"

 

HTTP Response

Success

HTTP response 200 with Exception Domain Object 

(Example below)

 

Error

See  API Error messages 

Example HTTP Request & Response

POST http://example.com/context/api/2/exceptiondomain/3/archive

OR

POST http://example.com/context/api/2/exceptiondomain/unknown.com/archive

JSON Response

{

    "domain": {

        "id": 3,

        "url": "unknown.com",

        "status": "Archive"

    }

}

 

 

Comments


0 Comments

Last Updated: Nov 08,2024