Home

>>>

GET /api
Show available API links

Examples

GET /api
200
{
  "links": {
    "base": {},
    "config_reports": {
      "List all reports": "/api/config_reports",
      "Show a report": "/api/config_reports/:id",
      "Create a report": "/api/config_reports",
      "Delete a report": "/api/config_reports/:id",
      "Show the last report for a host": "/api/hosts/:host_id/config_reports/last"
    },
    "plugins": {
      "List installed plugins": "/api/plugins"
    },
    "report_templates": {
      "List all report templates": "/api/report_templates",
      "Show a report template": "/api/report_templates/:id",
      "Create a report template": "/api/report_templates",
      "Import a report template": "/api/report_templates/import",
      "Update a report template": "/api/report_templates/:id",
      "Delete a report template": "/api/report_templates/:id",
      "Clone a template": "/api/report_templates/:id/clone",
      "Export a report template to ERB": "/api/report_templates/:id/export",
      "Generate report from a template": "/api/report_templates/:id/generate",
      "Schedule generating of a report": "/api/report_templates/:id/schedule_report",
      "Downloads a generated report": "/api/report_templates/:id/report_data/:job_id"
    },
    "home": {
      "Show available API links": "/api",
      "Show status": "/api/status"
    }
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
>>>

GET /api/status
Show status

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer