Status API › Page appearance
Upload a group's logo
Uploads one group's logo as multipart form field file (PNG, JPEG or WebP, at
most 2 MB). The group must have a component on the page.
Permission (API-key scope): status:page:write.
Authorization
bearerAuth(status:page:write)apiKeyHeader(status:page:write)
Parameters
Path parameters
pageIDstring (uuid) requiredThe status page's id (a UUID).
Query parameters
groupstring requiredThe group's name, as on its components.
Request body required
filestring (binary) required
Responses
200
The group's logo.
dataobject requiredgroupstringlogo_urlstring
successboolean required
400
group is missing (VALIDATION_ERROR), or the form or file is not valid (INVALID_UPLOAD, MISSING_FILE, INVALID_CONTENT_TYPE).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
404
No such page, or no such group on it (NOT_FOUND).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
413
Larger than 2 MB (FILE_TOO_LARGE).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
502
Storing the file failed (UPLOAD_FAILED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
503
Uploads are not configured (UPLOAD_DISABLED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
Example request
curl -X POST 'https://evohub.io/api/v1/pages/3f6c2a1e-8b4d-4f7a-9c21-5d0e7a9b1c42/groups/logo?group=Platform' \
-H 'Content-Type: multipart/form-data' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"file": "string"
}'