API / Media¶
Method | Endpoint | Description |
---|---|---|
GET | /api/media | Get uploaded media file |
GET | /api/media/{media_id} | Get specific uploaded media file |
POST | /api/media | Upload media file |
DELETE | /api/media/{media_id} | Delete uploaded media file |
GET /api/media¶
Get an uploaded media file.
Example Request¶
curl -u "username:password" -X GET 'http://localhost:9000/api/media' \
--header 'Content-Type: multipart/form-data; boundary=--------------------------093715978792575906250298'
Example Response¶
{
"data": [
{
"id": 1,
"uuid": "ec7b45ce-1408-4e5c-924e-965326a20287",
"filename": "Media file",
"created_at": "2020-04-08T22:43:45.080058+01:00",
"thumb_url": "/uploads/image_thumb.jpg",
"uri": "/uploads/image.jpg"
}
]
}
GET /api/media/{media_id}¶
Retrieve a specific media.
Parameters¶
Name | Type | Required | Description |
---|---|---|---|
media_id | Number | Yes | Media ID. |
Example Request¶
curl -u 'username:password' 'http://localhost:9000/api/media/7'
Example Response¶
{
"data":
{
"id": 7,
"uuid": "62e32e97-d6ca-4441-923f-b62607000dd1",
"filename": "ResumeB.pdf",
"content_type": "application/pdf",
"created_at": "2024-08-06T11:28:53.888257+05:30",
"thumb_url": null,
"provider": "filesystem",
"meta": {},
"url": "http://localhost:9000/uploads/ResumeB.pdf"
}
}
POST /api/media¶
Upload a media file.
Parameters¶
Field | Type | Required | Description |
---|---|---|---|
file | File | Yes | Media file to upload |
Example Request¶
curl -u "username:password" -X POST 'http://localhost:9000/api/media' \
--header 'Content-Type: multipart/form-data; boundary=--------------------------183679989870526937212428' \
--form 'file=@/path/to/image.jpg'
Example Response¶
{
"data": {
"id": 1,
"uuid": "ec7b45ce-1408-4e5c-924e-965326a20287",
"filename": "Media file",
"created_at": "2020-04-08T22:43:45.080058+01:00",
"thumb_uri": "/uploads/image_thumb.jpg",
"uri": "/uploads/image.jpg"
}
}
DELETE /api/media/{media_id}¶
Delete an uploaded media file.
Parameters¶
Field | Type | Required | Description |
---|---|---|---|
media_id | number | Yes | ID of media file to delete |
Example Request¶
curl -u "username:password" -X DELETE 'http://localhost:9000/api/media/1'
Example Response¶
{
"data": true
}