Ping

>>>

GET /api/ping
Shows status of Foreman system and it's subcomponents

This service is available for unauthenticated users

Examples

GET /api/ping
200
{
  "results": {
    "foreman": {
      "database": true
    }
  }
}

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/statuses
Shows status and version information of Foreman system and it's subcomponents

This service is only available for authenticated users

Examples

GET /api/statuses
200
{
  "results": {
    "foreman": {
      "version": "1.20.0",
      "api": {
        "version": "v2"
      }
    }
  }
}

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