Versions Compared

Key

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

...

Section

Delete custom application

Delete the custom application, this endpoint need the OPERATOR role to be executed.

Panel
borderColorblack
bgColor#fafafb

DELETE /aspire/_api/resources/:type/:cmpName/deleteCustom


Path Parameters

NameTypeRequiredDescription
typestringRequired

The type of resource

  • "connector"
  • "application"
  • "publisher"
  • "service"
  • "framework"
  • "other"
cmpNamestringRequireda component to be deleted


Request example

Code Block
languagejs
DELETE /aspire/_api/resources/connector/customFileSystem/deleteCustom

Status: 200, 404

Section

Dashboards enabled

Determine if there are dashboards properties enabled

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/resources/dashboard

Status: 200

Response example

Code Block
languagejs
{
  "enabled" : true
}
Section

Get Main Dashboard

Get the URL to the Main Dashboard

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/resources/dashboard/main

Status: 200

Response example

Code Block
languagejs
{
  "url" : "https://kibana_host:5601/...."
}
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
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
{
  "e11dac6b-0083-4d9a-ac3b-0e1bca4f0872" : {
     "url" : "https://kibana_host:5601/....."
  },
  "98d65d8b-a7eb-4349-9f51-4139cf8a6404" : {
     "url" : "https://kibana_host:5601/....."
  }
}