Versions Compared

Key

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

...

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"
}
Section

Get File List

Gets the list of files in the Aspire resources repository, this endpoint needs the at least the OPERATOR role to be executed.

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/resources/file?from=:from&size=:size

Query Parameters

NameTypeRequiredDescription
fromintegerOptionalThe offset for the results page


sizeintegerOptionalThe page size

Request example

Code Block
languagejs
themeRDark
GET /aspire/_api/resources/file

Status: 200

Response example

Code Block
languagejs
themeRDark
{
    "count": {
        "totalItems": 1
    },
    "resource": [
        {
            "id" : "517f161623ea3f43cc567a33914b96c31cbaa2c63d2594174d2b6230b1912ae1"
            "name" : "file.groovy",
            "description" : "groovy",
            "checksum" : "12565092083235"
        }
    ]
}