Versions Compared

Old Version 26

changes.mady.by.user Johan Montealegre

Saved on

compared with

New Version 27

changes.mady.by.user Johan Montealegre

Saved on

Key

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

...

Section

Get Metrics Dashboard

Get the URL to the Metrics Dashboard for a list of given crawls

Panel
borderColorblack
bgColor#fafafb

POST /aspire/_api/resources/dashboard/metrics

Request example

Code Block
languagejs
themeRDark
POST /aspire/_api/resources/dashboard/metrics
[
   {
      "seed" : "e11dac6b-0083-4d9a-ac3b-0e1bca4f0872",
      "crawlId" : "1623652817"
   },
   {
      "seed" : "98d65d8b-a7eb-4349-9f51-4139cf8a6404",
      "crawlId" : "1623642813"
   }
]

Status: 200

Response example

Code Block
languagejs
themeRDark
{
  "e11dac6b-0083-4d9a-ac3b-0e1bca4f0872" : {
     "url" : "https://kibana_host:5601/....."
  },
  "98d65d8b-a7eb-4349-9f51-4139cf8a6404" : {
     "url" : "https://kibana_host:5601/....."
  }
}
Section

Upload

file

File

Uploads 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?description=:description

Body Form

NameTypeRequiredDescription
filefileRequired

The file to be uploaded

Query Parameters

NameTypeRequiredDescription
descriptionstringRequired

The file description

Request example

Code Block
languagejs
themeRDark
POST /aspire/_api/resources/file?description=groovy --form 'file=@"/C:/Directory/file.groovy"'

Status: 200

Response example

Code Block
languagejs
themeRDark
{
	"id" : "517f161623ea3f43cc567a33914b96c31cbaa2c63d2594174d2b6230b1912ae1"
	"name" : "file.groovy",
	"description" : "groovy",
	"checksum" : "12565092083235"
}
Section

Download

file

File

Uploads Downloads a file to from 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/:id

Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the file to download

Request example

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

Status: 200

Response example

Code Block
languagejs
themeRDark
[the file]
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 download

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