/v2/api/spImage/{siteId}/status (GET) - BlueCat DNS Edge

DNS Edge User Guide

prodname
BlueCat DNS Edge

Retrieves the status of image generation.

GET https://api-<DNS.Edge.URL>/v2/api/spImage/{siteId}/status
Authorization: Bearer authorization token
Content-type: application/JSON

Successful response

200 OK
Content-type: application/JSON
{ 
status:< COMPLETE/IN_PROGRESS/FAILED >
revision:< Revision of the site that was generated >
link:< If there is a generated image for the site, the link appears here >
timeOfExpiry:< Long UTC timestamp of when the image expires in milliseconds >,
timeToExpiry:< Time until the link, if it exists, expires, in seconds >
},

Response on unsuccessful authorization

401 Unauthorized
Content-Type: application/JSON
{"code": "UNAUTHORIZED", "brief": "You are not authorized to perform this action"}
Possible error codes
  • UNEXPECTED_ERROR