Returns string representing a host status of a given type

Examples

GET /api/hosts/host281/status/global
200
{
  "status_label": "OK",
  "status": 0
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

id
required

Validations:

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

type
required

status type, can be one of * global * configuration * build

Validations:

  • Must be one of: HostStatus::Global, configuration, build.