Feedback

Reports with screenshots and logs sent to ProAnimaStudio through this server.

Operations of this group with their access rule, retry rule, parameters and answers. Every request carries a key: Authorization: Bearer <key> (see Authentication).

Operations

Send feedback to ProAnimaStudio

POST /api/v1/feedback

Access: Any valid key or session · Retry: Do not repeat automatically

Forwards a message through this server to the ProAnimaStudio hub and answers 202 with the hub's id. Send message (up to 20 000 characters), lang (ru or en), serverLog (true attaches this server's log and a system summary, administrators only), and optionally email for a reply, screen, up to 6 base64 screenshots (PNG, JPEG, WebP or GIF, 8 MiB each) and the console's clientLog; the total is limited to 15 MiB. Nothing is retried, so a second call is a second message. 503 feedback_disabled when the operator turned it off, 503 hub_unreachable when the hub does not answer, 429 feedback_attempts when this server sent too much.

Request body (application/json)

Field	Type	Required	Rules
message	string	yes	1–20000 characters
email	string	no	up to 254 characters; may be null
lang	string	yes	one of ru, en
screen	string	no	up to 11 characters; may be null
screenshots	array of object	yes	up to 6 items
screenshots[].name	string	yes	1–120 characters
screenshots[].type	string	yes	one of image/png, image/jpeg, image/webp, image/gif
screenshots[].data	string (byte)	yes	—
clientLog	string	no	up to 2097152 characters; may be null
serverLog	boolean	yes	—

Response 202

Field	Type	Required	Rules
id	string	yes	—

Responses: 202, 400, 401, 403, 404, 405, 409, 413, 415, 422, 503, 507

Example

curl -X POST "$ARKVORY_URL/api/v1/feedback" \
  -H "Authorization: Bearer $ARKVORY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"message":"<message>","lang":"ru","screenshots":[],"serverLog":false}'

Preview the feedback attachments

GET HEAD /api/v1/feedback/attachments

Access: Administrator · Retry: Safe to repeat (read)

Returns the two texts that sendFeedback attaches when serverLog is true: the recent records of this server's log and a system summary (versions, operating system, update and mirror states) without addresses, names or secrets. Show them to the administrator before sending.

Response 200

Field	Type	Required	Rules
serverLog	string	yes	—
system	string	yes	—

Responses: 200, 400, 401, 403, 404, 409, 422, 503, 507

Example

curl -X GET "$ARKVORY_URL/api/v1/feedback/attachments" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"