Download an attachment

GET /api/v1/attachments/{attachment_uuid}/download operationId: attachment.download

Base: https://portal.watcheye.com.au/api/v1/attachments/{attachment_uuid}/download

Returns the contents of an attachment as raw bytes, with the file's type in Content-Type and its name in Content-Disposition. The sha256 in the attachment's details can be used to check the download.

Path parameters

Field	Description
`attachment_uuid`required	string (uuid) The attachment UUID

Responses

200

The file contents, returned as raw bytes

application/octet-stream application/pdf image/jpeg

Binary PDF file

Standard error responses: 401 403 404 429 5XX See common error responses

Previous Delete an attachment Next List audit entries

Response

200 The file contents, returned as raw bytes

No response body.

401 Unauthorized - the API key or account is inactive, expired, or not permitted from this IP address shared error response

{
    "message": "API Key Inactive",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}

403 No access - No permission to process this request shared error response

{
    "message": "No access",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}

404 Not Found - The requested resource does not exist or is not accessible by this account shared error response

{
    "message": "Entity not found",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}

429 Rate limited - The request rate limit has been reached shared error response

{
    "message": "Rate limited",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}

5XX Internal error - Internal system error shared error response

{
    "message": "Internal error",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}