POST /api/config_reports
Create a report

Examples

POST /api/v2/config_reports
{
  "config_report": {
    "host": "report.example.com",
    "logs": [
      {
        "log": {
          "level": "err",
          "messages": {
            "message": "Could not retrieve catalog from remote server: Error 400 on SERVER: Could not find node 'rhel6n01.corp.com'; cannot compile"
          },
          "sources": {
            "source": "Puppet"
          }
        }
      },
      {
        "log": {
          "level": "notice",
          "messages": {
            "message": "Using cached catalog"
          },
          "sources": {
            "source": "Puppet"
          }
        }
      },
      {
        "log": {
          "level": "err",
          "messages": {
            "message": "Could not retrieve catalog; skipping run"
          },
          "sources": {
            "source": "Puppet"
          }
        }
      }
    ],
    "metrics": {},
    "reported_at": "2010-11-19 02:39:04 UTC",
    "status": {
      "applied": 0,
      "failed": 0,
      "failed_restarts": 0,
      "pending": 0,
      "restarted": 0,
      "skipped": 0
    }
  }
}
201
{
  "metrics": {},
  "created_at": "2022-03-29 08:34:28 UTC",
  "updated_at": "2022-03-29 08:34:28 UTC",
  "id": 4,
  "host_id": 16,
  "host_name": "report.example.com",
  "reported_at": "2010-11-19 02:39:04 UTC",
  "status": {
    "applied": 0,
    "restarted": 0,
    "failed": 0,
    "failed_restarts": 0,
    "skipped": 0,
    "pending": 0
  },
  "origin": "Puppet"
}

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
config_report
required

Validations:

  • Must be a Hash
config_report[host]
required

Hostname or certname

Validations:

  • Must be a String
config_report[reported_at]
required

UTC time of report

Validations:

  • Must be a String
config_report[status]
required

Hash of status type totals

Validations:

  • Must be a Hash
config_report[metrics]
required

Hash of report metrics, can be just {}

Validations:

  • Must be a Hash
config_report[logs]
optional , nil allowed

Optional array of log hashes

Validations:

  • Must be an array of any type