Get inventory by identifier

GET

https://example.itential.io/inventory_manager/v1/inventories/:identifier

GET

/inventory_manager/v1/inventories/:identifier

$ curl https://example.itential.io/inventory_manager/v1/inventories/string \
>      -u "<username>:<password>"

1 {
2   "status": "Success",
3   "result": {
4     "name": "string",
5     "version": "2024-01-15T09:30:00Z",
6     "groups": [
7       "string"
8     ],
9     "description": "string",
10     "actions": [
11       {
12         "name": "string",
13         "action_type": "string",
14         "action_config": {},
15         "action_parameters": {},
16         "created_at": "2024-01-15T09:30:00Z",
17         "updated_at": "2024-01-15T09:30:00Z",
18         "created_by": "string",
19         "updated_by": "string"
20       }
21     ],
22     "tags": [
23       "string"
24     ],
25     "created_at": "2024-01-15T09:30:00Z",
26     "updated_at": "2024-01-15T09:30:00Z",
27     "created_by": "string",
28     "updated_by": "string",
29     "_id": "string"
30   },
31   "error": "string"
32 }

Returns a single inventory document by ID or name.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

identifierstringRequired

Inventory ID or name

Response

Single inventory document

statusstringOptional

resultobjectOptional

The inventory document

errorstringOptional

Errors

500

Internal Server Error