Skip to content

Commit

Permalink
Delete hosts add info to readme (#251)
Browse files Browse the repository at this point in the history
* Adding delete event info to the README
  • Loading branch information
dehort authored Apr 29, 2019
1 parent 0ff3a0b commit 6b7e201
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,21 @@ will be added to the existing host entry.
If the canonical facts based lookup does not locate an existing host, then
a new host entry is created.

#### Host deletion

Hosts can be deleted by using the DELETE HTTP Method on the _/hosts/id_ endpoint.
When a host is deleted, the inventory service will send an event message
to the _platform.inventory.events_ message queue. The delete event message
will look like the following:

```
{"id": <host id>, "timestamp": <delete timestamp>, "type": "delete"}
```

- type: type of host change (delete in this case)
- id: Inventory host id of the host that was deleted
- timestamp: the time at which the host was deleted

#### Testing API Calls

It is necessary to pass an authentication header along on each call to the
Expand Down

0 comments on commit 6b7e201

Please sign in to comment.