GET /media

Returns a paginated list of media items available in the system. This endpoint is primarily used by administrative tools to browse and manage uploaded media assets.

Authentication

This endpoint requires authentication via a refresh token stored in cookies and the appropriate permission.

Cookie Name Required Description
refreshToken Yes Refresh token used to authenticate

Required Permission: view-media

Query Parameters
Parameter Type Required Default Description
order string No added-desc Sorting order
limit number No Number.MAX_SAFE_INTEGER Maximum number of results returned
offset number No 0 Pagination offset
search string No undefined Search term used to filter media entries
Enum Values

order

  • added-asc
  • added-desc
Responses
200 OK

Returned when media items are successfully retrieved.

{
  "media": [
    {
      "id": "number",
      "name": "string",
      "path": "string",
      "timestamp": "string",
      "tags": []
    }
  ],
  "max": 5,
  "from": 1,
  "to": 20
}

Models used
Media Model

POST /media/edit/:id

Updates the metadata of an existing media item, including its display name and tags.

Authentication

This endpoint requires authentication via a refresh token stored in cookies and the appropriate permission.

Cookie Name Required Description
refreshToken Yes Refresh token used to authenticate

Required Permission: edit-media

Path Parameters
Parameter Type Required Description
id number Yes ID of the media item to update
Request Body
Field Type Required Default Description
name string Yes — Updated media name
tags string / array Yes — Tags associated with the media item
Responses
200 OK

Returned when the media item is successfully updated.

{
  "data": "Media updated successfully",
  "code": 200
}

Models used
Response Model

400 Bad Request

Returned when required parameters are missing.

{
  "data": "Required parameters missing",
  "code": 400
}

Models used
Response Model

500 Internal Server Error

Returned if the update operation fails.

{
  "data": "Error updating media",
  "code": 500
}

Models used
Response Model

POST /media/add

Uploads a new media image and creates a media entry with a name and tags. This endpoint is only available when the service is configured to handle file uploads.

Authentication

This endpoint requires authentication via a refresh token stored in cookies and the appropriate permission.

Cookie Name Required Description
refreshToken Yes Refresh token used to authenticate

Required Permission: add-media

Request Body
Field Type Required Description
name string Yes Name of the media item
tags string / array Yes Tags assigned to the media item
image string (base64) Yes Base64-encoded image data
Responses
200 OK

Returned when the media item is successfully created.

{
  "data": "Media added successfully",
  "code": 200
}

Models used
Response Model

400 Bad Request

Returned when required parameters are missing.

{
  "data": "Required parameters missing",
  "code": 400
}

Models used
Response Model

500 Internal Server Error

Returned if media creation or image processing fails.

{
  "data": "Error adding media",
  "code": 500
}

Models used
Response Model

503 Service Unavailable

Returned when the current service instance is not configured to handle file uploads.

{
  "data": "This service is not handling file uploads.",
  "code": 503
}

Models used
Response Model

DELETE /media/delete/:id

Deletes a media entry and its associated image files. This endpoint is only available when the service is configured to handle file uploads.

Authentication

This endpoint requires authentication via a refresh token stored in cookies and the appropriate permission.

Cookie Name Required Description
refreshToken Yes Refresh token used to authenticate

Required Permission: delete-media

Path Parameters
Parameter Type Required Description
id number Yes ID of the media entry to delete
Responses
200 OK

Returned when the media entry and associated files are successfully deleted.

{
  "data": "Media deleted successfully",
  "code": 200
}

Models used
Response Model

400 Bad Request

Returned when required parameters are missing.

{
  "data": "Required parameters missing",
  "code": 400
}

Models used
Response Model

404 Not Found

Returned when the specified media entry does not exist.

{
  "data": "Media not found",
  "code": 404
}

Models used
Response Model

500 Internal Server Error

Returned if deletion fails due to an internal error.

{
  "data": "Error deleting media",
  "code": 500
}

Models used
Response Model

503 Service Unavailable

Returned when the current service instance is not configured to handle file uploads.

{
  "data": "This service is not handling file uploads.",
  "code": 503
}

Models used
Response Model

Previous Contributors