media

Update media status

Updates a media item's status and returns the media in JSON format

post/media/{mediaId}/{status}

Request

  • Base URL: http://localhost:5055/api/v1
  • URL: http://localhost:5055/api/v1/media/{mediaId}/{status}
  • Auth: one of:
    • API key in cookie connect.sid
    • API key in header X-Api-Key

Path parameters

mediaIdstring required

Media ID

status'available' | 'partial' | 'processing' | 'pending' | 'unknown' | 'deleted' required

New status

Request body

is4kboolean

When true, updates the 4K status field (status4k). When false or not provided, updates the regular status field (status). This applies to all status values (available, partial, processing, pending, unknown).

Response

Returned media

idnumber
tmdbIdnumber
tvdbIdnumber nullable
statusnumber

Availability of the media. 1 = UNKNOWN, 2 = PENDING, 3 = PROCESSING, 4 = PARTIALLY_AVAILABLE, 5 = AVAILABLE, 6 = DELETED

createdAtstring
updatedAtstring

Example response

{
  "requests": [
    {
      "id": 123,
      "createdAt": "2020-09-12T10:00:27.000Z",
      "updatedAt": "2020-09-12T10:00:27.000Z",
      "requestedBy": {
        "id": 1,
        "email": "hey@itsme.com",
        "userType": 1,
        "createdAt": "2020-09-02T05:02:23.000Z",
        "updatedAt": "2020-09-02T05:02:23.000Z",
        "requestCount": 5
      },
      "modifiedBy": {
        "id": 1,
        "email": "hey@itsme.com",
        "userType": 1,
        "createdAt": "2020-09-02T05:02:23.000Z",
        "updatedAt": "2020-09-02T05:02:23.000Z",
        "requestCount": 5
      }
    }
  ],
  "createdAt": "2020-09-12T10:00:27.000Z",
  "updatedAt": "2020-09-12T10:00:27.000Z"
}

Changes

No recorded changes to this operation across all 21 revisions of this API.