Media

About 261 wordsLess than 1 minute

Generated from docs/.vuepress/openapi.json. Refresh with npm 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.

`POST /api/v1/media/{id}/derivatives` — Create MediaDerivative

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.

`GET /api/v1/media/{id}/derivatives/options` — Index MediaDerivativeOptions

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}/keep` — Keep KeepMedia

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.

`GET /api/v1/media/allowed-types` — Index MediaAllowedTypes

Tags: Media

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`POST /api/v1/media/resolve` — Resolve MediaResolve

Tags: Media

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.