Accounts-accountNumber-web-domainName-error404:GET

GET /accounts/{accountNumber}/web/{domainName}/error404

Gets error page content and status

Request

GET /accounts/{accountNumber}/web/{domainName}/error404

URI Parameters

accountNumber - string

The user account to which the domain name and the error page belong

domainName - string

The target domain name (domain name under which the site is actually hosted)

Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

Response

Response Body

{
"status": "{status}",
"links": [{"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/error404/", "rel": "self"}]
}
 

Parameters

status - string

Status of the page.

links - list

Hypermedia for this resource

Status Code

200 OK

Success

401 Unauthorized

The supplied credentials are invalid or do not provide permissions for this operation.

403 Forbidden

The authenticated user is not allowed to access this resource

404 Not Found

The domain name does not exist.

Examples

Check if error page is set for a domain

Request

GET /accounts/{account}/email/test.com/error404
 

Response

200 OK

{
"status": "open",
"links": links": [{"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/error404/", "rel": "self"}]
}

 

Try to get error page for a not existing domain

Request

GET /accounts/{account}/email/test.com/error404
 

Response

404 Not Found

{"itemNotFound": {"guid": "", "message": "Resource not found", "code": 404, "details": ""}}

 

blog comments powered by Disqus