GET /api/config_reports
Alle Berichte auflisten

Beispiele

GET /api/config_reports
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": "",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "metrics": {
        "time": {
          "schedule": 0.00083,
          "service": 0.149739,
          "mailalias": 0.000283,
          "cron": 0.000419,
          "config_retrieval": 16.3637869358063,
          "package": 0.003989,
          "filebucket": 0.000171,
          "file": 0.007025,
          "exec": 0.000299
        },
        "resources": {
          "total": 33
        },
        "changes": {},
        "events": {
          "total": 0
        }
      },
      "created_at": "2019-09-11 14:37:45 UTC",
      "updated_at": "2019-09-11 14:37:45 UTC",
      "id": 17,
      "host_id": 77,
      "host_name": "host574",
      "reported_at": "2019-09-11 14:37:45 UTC",
      "status": {
        "applied": 0,
        "restarted": 0,
        "failed": 0,
        "failed_restarts": 0,
        "skipped": 0,
        "pending": 0
      }
    }
  ]
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Feld und Reihenfolge sortieren, z.B. ‘id DESC’

Validations:

  • Must be a String

page
optional

Seitennummer, beginnend bei 1

Validations:

  • Must be a number.

per_page
optional

Anzahl der angezeigten Ergebnisse pro Seite

Validations:

  • Must be a number.

Suchfelder

Feld Name Typ Mögliche Werte
applied integer
environment string
eventful true, false
failed integer
failed_restarts integer
host string
host_id integer
hostgroup string
hostgroup_fullname string
hostgroup_title string
last_report datetime
location string
log text
organization string
origin string
pending integer
reported datetime
resource text
restarted integer
skipped integer

GET /api/config_reports/:id
Bericht anzeigen

Beispiele

GET /api/config_reports/2
404
{
  "error": {
    "message": "Resource config_report not found by id '2'"
  }
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/config_reports
Bericht erstellen

Beispiele

POST /api/config_reports
{
  "config_report": {}
}
403
{
  "error": {
    "message": "Access denied",
    "details": "Missing one of the required permissions: upload_config_reports"
  }
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

config_report
verpflichtend

Validations:

  • Must be a Hash

config_report[host]
verpflichtend

Hostname oder Zertifikatsname

Validations:

  • Must be a String

config_report[reported_at]
verpflichtend

UTC-Zeit des Berichts

Validations:

  • Must be a String

config_report[status]
verpflichtend

Hash der Statustypensummen

Validations:

  • Must be a Hash

config_report[metrics]
verpflichtend

Hash der Berichtmetriken, kann einfach nur {} sein

Validations:

  • Must be a Hash

config_report[logs]
optional , nil erlaubt

Optionales Array der Log-Hashes

Validations:

  • Must be an array of any type


DELETE /api/config_reports/:id
Bericht löschen

Beispiele

DELETE /api/config_reports/1
{
  "config_report": {}
}
404
{
  "error": {
    "message": "Resource config_report not found by id '1'"
  }
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be a String


GET /api/hosts/:host_id/config_reports/last
Letzten Bericht für einen Host anzeigen

Beispiele

GET /api/hosts/host2546/config_reports/last
200
{
  "metrics": {
    "time": {
      "schedule": 0.00083,
      "service": 0.149739,
      "mailalias": 0.000283,
      "cron": 0.000419,
      "config_retrieval": 16.3637869358063,
      "package": 0.003989,
      "filebucket": 0.000171,
      "file": 0.007025,
      "exec": 0.000299
    },
    "resources": {
      "total": 33
    },
    "changes": {},
    "events": {
      "total": 0
    }
  },
  "created_at": "2019-09-11 14:57:33 UTC",
  "updated_at": "2019-09-11 14:57:33 UTC",
  "id": 12,
  "host_id": 31,
  "host_name": "host2546",
  "reported_at": "2019-09-11 14:57:33 UTC",
  "status": {
    "applied": 0,
    "restarted": 0,
    "failed": 0,
    "failed_restarts": 0,
    "skipped": 0,
    "pending": 0
  },
  "logs": [],
  "summary": "Success"
}

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.