PUpuppet
Inventory

Create an inventory sync job

Create an inventory sync job. If there is not an inventory sync job currently running, a new job will be created and start running immediately. If there is an inventory sync job currently running, a new job will not be created.

To use this endpoint, you must have one of the following roles: comply-admin comply-operator

post/v1/inventory-sync-job

Request

Response

CreateInventoryJobResponse represents the response to a create inventory sync job request.

created_atstring date-time required

The time at which the inventory sync job was created.

finished_atstring date-time nullable

The time at which the inventory sync job finished.

idinteger required

The ID of the inventory sync job.

nodes_deletedinteger required

The number of nodes deleted as part of the inventory sync job.

nodes_syncedinteger required

The number of nodes synced as part of the inventory sync job.

reasonstring required

The reason for failure of inventory sync job, if any.

status'started' | 'successful' | 'failed' | 'aborted' required

The status of the inventory sync job.

total_nodesinteger required

The total number of nodes in the inventory.

Example response

{
  "created_at": "2023-09-25T13:57:16.743Z",
  "finished_at": "2023-09-25T13:57:16.743Z",
  "id": 123,
  "nodes_synced": 100,
  "reason": "null",
  "status": "successful",
  "total_nodes": 100
}

Changes

No recorded changes to this operation across all 1 revision of this API.