Category API
7 endpoints.
Get all Categories
Section titled “Get all Categories”Get all the categories saved on the server.
Responses
200Categories
[
{
"archives": [
"0d50858d727723d856d2ab78564bb8e906e65f14",
"7f03b8b1f337e1e42b2c2890533c0de7479d41ca"
],
"id": "SET_1613080290",
"name": "My great category",
"pinned": 0,
"search": null
}
]Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Create a Category
Section titled “Create a Category”Create a new Category.
Request body
application/x-www-form-urlencoded, multipart/form-data
Responses
200Success response
{
"category_id": "SET_1613080290",
"operation": "create_category",
"success": 0
}400Error response
{
"error": "",
"operation": "",
"success": 0,
"successMessage": ""
}This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Delete Category
Section titled “Delete Category”Responses
200Success response
{
"error": "",
"operation": "",
"success": 0,
"successMessage": ""
}423The category ID is currently locked for modification
{
"error": "",
"operation": "",
"success": 0,
"successMessage": ""
}This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Get a single Category
Section titled “Get a single Category”Get the details of the specified category ID.
Responses
200Category
{
"archives": [
"0d50858d727723d856d2ab78564bb8e906e65f14",
"7f03b8b1f337e1e42b2c2890533c0de7479d41ca"
],
"id": "SET_1613080290",
"name": "My great category",
"pinned": 0,
"search": null
}Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Update Category
Section titled “Update Category”Modify a Category.
Request body
application/x-www-form-urlencoded, multipart/form-data
Responses
200Success response
{
"category_id": "SET_1613080290",
"operation": "update_category",
"success": 0
}400Error response
{
"error": "",
"operation": "",
"success": 0,
"successMessage": ""
}423The Category is currently locked for modification
{
"error": "",
"operation": "",
"success": 0,
"successMessage": ""
}This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Remove an Archive from a Category
Section titled “Remove an Archive from a Category”Remove an Archive ID from a Category.
Path parameters
- idstring · min: 14 · max: 14 · patternrequired
- Category ID to remove from.
- archivestring · min: 40 · max: 40 · patternrequired
- Archive ID to remove.
Responses
200Result
{
"error": "",
"operation": "",
"success": 0,
"successMessage": ""
}423The category ID is currently locked for modification
{
"error": "",
"operation": "",
"success": 0,
"successMessage": ""
}This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Add an Archive to a Category
Section titled “Add an Archive to a Category”Adds the specified Archive ID (see Archive API) to the given Category.
Path parameters
- idstring · min: 14 · max: 14 · patternrequired
- Category ID to add to.
- archivestring · min: 40 · max: 40 · patternrequired
Responses
200Result
{
"error": "",
"operation": "",
"success": 0,
"successMessage": ""
}423The category ID is currently locked for modification
{
"error": "",
"operation": "",
"success": 0,
"successMessage": ""
}This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.