Media
About 270 wordsLess than 1 minute
Generated from
docs/.vuepress/openapi.json. Refresh withnpm run gen:api. Back to overview.
GET /api/v1/media — Index MediaArchive
Tags: Media
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
principal_id | array | no | Repeatable principal id to scope the listing by. Intersected with the caller’s visible principals server-side; out-of-scope ids are silently dropped. Used by the Media Archive plugin’s ALL / My Media / Group X chip row. Use the principal_id[]=… array-bracket form so repeated keys are preserved through PHP parse_str. |
Responses
| Status | Description |
|---|---|
default | JSON envelope: {data: ...} on success, {error: {code, message}} on error. |
POST /api/v1/media — Store MediaUpload
Tags: Media
Responses
| Status | Description |
|---|---|
default | JSON envelope: {data: ...} on success, {error: {code, message}} on error. |
GET /api/v1/media/allowed-types — Index MediaAllowedTypes
Tags: Media
Responses
| Status | Description |
|---|---|
default | JSON envelope: {data: ...} on success, {error: {code, message}} on error. |
GET /api/v1/media/{id} — Show MediaArchive
Tags: Media
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes |
Responses
| Status | Description |
|---|---|
default | JSON envelope: {data: ...} on success, {error: {code, message}} on error. |
PATCH /api/v1/media/{id} — Update MediaArchive
Tags: Media
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes |
Responses
| Status | Description |
|---|---|
default | JSON envelope: {data: ...} on success, {error: {code, message}} on error. |
DELETE /api/v1/media/{id} — Destroy MediaArchive
Tags: Media
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes |
Responses
| Status | Description |
|---|---|
default | JSON envelope: {data: ...} on success, {error: {code, message}} on error. |
POST /api/v1/media/{id}/public-token/refresh — RefreshPublicToken MediaArchive
Tags: Media
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes |
Responses
| Status | Description |
|---|---|
default | JSON envelope: {data: ...} on success, {error: {code, message}} on error. |