Inventory

>>>

GET /api/organizations/:organization_id/rh_cloud/report
Download latest report

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
required

Set the current organization context for the request

Validations:

  • Integer
>>>

POST /api/organizations/:organization_id/rh_cloud/report
Start report generation

Examples

POST /api/organizations/447626503/rh_cloud/report
{
  "disconnected": false,
  "inventory": {
    "disconnected": false
  }
}
200
{
  "action_status": "success"
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
required

Set the current organization context for the request

Validations:

  • Integer
disconnected
optional

Generate the report, but do not upload

Validations:

  • Must be one of: true, false, 1, 0.
>>>

GET /api/organizations/:organization_id/rh_cloud/missing_hosts
Grab hosts that are missing in RH Cloud

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
required

Set the current organization context for the request

Validations:

  • Integer
>>>

POST /api/organizations/:organization_id/rh_cloud/missing_hosts
Grab hosts that are missing in RH Cloud

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
required

Set the current organization context for the request

Validations:

  • Integer
search_term
required

Scoped search string for host removal

Validations:

  • String
>>>

POST /api/organizations/:organization_id/rh_cloud/inventory_sync
Start inventory synchronization

Examples

POST /api/organizations/447626502/rh_cloud/inventory_sync
{
  "inventory": {}
}
200
{
  "task": {
    "id": "a294402e-ee9e-46e8-bc66-2b82a0e892f0",
    "label": "task1",
    "started_at": null,
    "ended_at": null,
    "state": "stopped",
    "result": "success",
    "external_id": null,
    "parent_task_id": null,
    "start_at": null,
    "start_before": null,
    "action": "N/A N/A",
    "user_id": null,
    "state_updated_at": "2024-05-23T19:44:14.465Z"
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
required

Set the current organization context for the request

Validations:

  • Integer
>>>

POST /api/rh_cloud/enable_connector
Enable cloud connector

Examples

POST /api/rh_cloud/enable_connector
{
  "inventory": {}
}
200
{
  "id": 406,
  "targeting_id": 449,
  "job_category": "Job name 1",
  "task_id": null,
  "task_group_id": null,
  "triggering_id": null,
  "description": null,
  "concurrency_level": null,
  "execution_timeout_interval": null,
  "password": null,
  "key_passphrase": null,
  "remote_execution_feature_id": null,
  "effective_user_password": null,
  "ssh_user": null,
  "time_to_pickup": null
}

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