Config reports

>>>

GET /api/config_reports
List all reports

Examples

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": "2021-05-19 07:12:24 UTC",
      "updated_at": "2021-05-19 07:12:24 UTC",
      "id": 1,
      "host_id": 2,
      "host_name": "host3",
      "reported_at": "2021-05-19 07:12:24 UTC",
      "status": {
        "applied": 0,
        "restarted": 0,
        "failed": 0,
        "failed_restarts": 0,
        "skipped": 0,
        "pending": 0
      }
    }
  ]
}

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
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
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
Show a report

Examples

GET /api/config_reports/35
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": "2021-05-19 07:44:59 UTC",
  "updated_at": "2021-05-19 07:44:59 UTC",
  "id": 35,
  "host_id": 127,
  "host_name": "host2224",
  "reported_at": "2021-05-19 07:44:59 UTC",
  "status": {
    "applied": 0,
    "restarted": 0,
    "failed": 0,
    "failed_restarts": 0,
    "skipped": 0,
    "pending": 0
  },
  "logs": [],
  "summary": "Success"
}

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

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
Create a report

Examples

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

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

DELETE /api/config_reports/:id
Delete a report

Examples

DELETE /api/config_reports/37
{
  "config_report": {}
}
200
{
  "id": 37,
  "host_id": 129,
  "reported_at": "2021-05-19T07:44:59.426Z",
  "created_at": "2021-05-19T07:44:59.429Z",
  "updated_at": "2021-05-19T07:44:59.429Z",
  "status": {
    "applied": 0,
    "restarted": 0,
    "failed": 0,
    "failed_restarts": 0,
    "skipped": 0,
    "pending": 0
  },
  "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
    }
  },
  "origin": null
}

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

Validations:

  • Must be a String
>>>

GET /api/hosts/:host_id/config_reports/last
Show the last report for a host

Examples

GET /api/hosts/host2210/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": "2021-05-19 07:44:57 UTC",
  "updated_at": "2021-05-19 07:44:57 UTC",
  "id": 23,
  "host_id": 113,
  "host_name": "host2210",
  "reported_at": "2021-05-19 07:44:57 UTC",
  "status": {
    "applied": 0,
    "restarted": 0,
    "failed": 0,
    "failed_restarts": 0,
    "skipped": 0,
    "pending": 0
  },
  "logs": [],
  "summary": "Success"
}

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

Validations:

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