For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI ReferenceRelease notes
DocumentationAPI ReferenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Integration API routes
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTBuild inventory filter structure
        • POSTBulk load inventory nodes
        • DELClear all nodes from an inventory
        • POSTCreate a new inventory
        • POSTCreate a new inventory action
        • DELDelete an inventory
        • DELDelete an inventory action
        • POSTExpand node identifiers to full documents
        • POSTFind inventories and nodes by tags
        • GETGet inventory action by identifier
        • GETGet inventory by identifier
        • GETGet inventory manager overview statistics
        • GETGet node by identifier
        • GETGet tag by identifier
        • GETGet tags from accessible inventories
        • GETGet usage statistics for a tag
        • GETInventory manager health check
        • GETList all actions for a specific inventory
        • GETList all inventories with filtering and pagination
        • GETList all nodes for a specific inventory
        • GETList all nodes with filtering and pagination
        • GETList all tags for a specific inventory
        • GETList all tags with filtering and pagination
        • GETList inventory actions
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceInventory Manager

Get inventory by identifier

GET
http://localhost:3000/inventory_manager/v1/inventories/:identifier
GET
/inventory_manager/v1/inventories/:identifier
$curl http://localhost:3000/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.
Was this page helpful?
Previous

Get inventory manager overview statistics

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

identifierstringRequired
Inventory ID or name

Response

Single inventory document
statusstring
resultobject
The inventory document
errorstring

Errors

500
Internal Server Error