Undelete a web audit

Request

PATCH /v3/web-audits/undelete

Restore a single archived audit into a chosen destination Folder and Sub-folder. The original parents are not reinstated. Historical run data is not restored. Per-item outcomes (including destination_gone and already_restored) are returned in the 200 response body; only authentication and authorization failures use 401/403.

Security

API_Key

Bodyapplication/jsonrequired

Audit id and restore destination

idinteger, (int32)required

folderIdinteger, (int32)required

subFolderIdinteger, (int32)required

PATCH

/v3/web-audits/undelete

curl -i -X PATCH \
  https://api.observepoint.com/v3/web-audits/undelete \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "folderId": 0,
    "subFolderId": 0
  }'

Responses

Restore outcome for the requested audit

Bodyapplication/json

idinteger, (int32)required

statusstringrequired

Enum:"restored""failed"

folderIdinteger, (int32)

subFolderIdinteger, (int32)

codestring

Enum:"destination_gone""already_restored""error"

reasonstring

Response

{
  "id": 0,
  "status": "restored",
  "folderId": 0,
  "subFolderId": 0,
  "code": "destination_gone",
  "reason": "string"
}