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

This service is available for unauthenticated users

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer


GET /api/statuses
Shows status and version information of Foreman system and it's subcomponents

This service is only available for authenticated users

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer


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

This service is only available for authenticated users

Examples

GET /katello/api/ping
200
{
  "status": "ok",
  "services": {
    "candlepin": {
      "status": "ok",
      "duration_ms": "23"
    },
    "candlepin_auth": {
      "status": "ok",
      "duration_ms": "0"
    },
    "foreman_tasks": {},
    "katello_events": {},
    "candlepin_events": {},
    "pulp3": {},
    "pulp3_content": {},
    "pulp": {
      "status": "ok",
      "duration_ms": "38"
    },
    "pulp_auth": {
      "status": "ok",
      "duration_ms": "0"
    }
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer


GET /katello/api/status
Shows version information

This service is available for unauthenticated users

Examples

GET /katello/api/status
200
{
  "version": "4.14.0.rc1",
  "timeUTC": "2024-08-26 18:34:13 UTC"
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer