/api/v1/link/{uuid}/check
Initiate checking a link document. The call can optionally wait for the result of the check.
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| uuid | String | yes, in path | - | The UUID of the link document to check. |
| wait | boolean | no | false | Whether to wait for the result of the check. If false, the link check will be performed asynchronously. |
Response
If wait is true, the response contains a JSON object in the following format:
{
"result": "<check result>",
"httpStatusCode": <HTTP status code>
}
| Field | Type | Description |
|---|---|---|
| result | String | The result of the check. Can be any one of WORKING, BROKEN, INVALID, or ERROR. |
| httpStatusCode | int | The HTTP status code that was returned when requesting the link's URL, if any. |
If the specified link document does not exist, the endpoint returns a 404 Not Found status code with an empty response instead.
If wait is false, the endpoint always returns a 202 Accepted status code with an empty response.
