Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section

Update File Description

Updates the description from a file to the Aspire resources repository, this endpoint needs the at least the OPERATOR role to be executed.

Panel
borderColorblack
bgColor#fafafb

POST /aspire/_api/resources/file/:id?description=:description

Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the file to downloadupdate

Query Parameters

NameTypeRequiredDescription
descriptionstringRequired

The file description

Request example

Code Block
languagejs
themeRDark
POST/aspire/_api/resources/file/517f161623ea3f43cc567a33914b96c31cbaa2c63d2594174d2b6230b1912ae1?description=new_description

Status: 200

Response example

Code Block
languagejs
themeRDark
{
	"id" : "517f161623ea3f43cc567a33914b96c31cbaa2c63d2594174d2b6230b1912ae1"
}
Section

Delete File

Deletes a file from the Aspire resources repository, this endpoint needs the at least the OPERATOR role to be executed.

Panel
borderColorblack
bgColor#fafafb

DELETE /aspire/_api/resources/file/:id

Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the file to delete

Request example

Code Block
languagejs
themeRDark
DELETE /aspire/_api/resources/file/517f161623ea3f43cc567a33914b96c31cbaa2c63d2594174d2b6230b1912ae1

Status: 200

Response example

Code Block
languagejs
themeRDark
{
	"id" : "517f161623ea3f43cc567a33914b96c31cbaa2c63d2594174d2b6230b1912ae1"
}