Skip to main content
GET
/
inventory
Retrieve Default Inventory
curl --request GET \
  --url https://api.alerty.ai/inventory \
  --header 'Authorization: Bearer <token>'
{
  "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "default": true,
  "resources": [
    {
      "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "type": "WEBSITE",
      "configuration": {
        "url": "<string>"
      }
    }
  ],
  "description": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful inventory retrieval

​
id
string<uuid>
required

Unique identifier for the entity

Example:

"5df33a85-2b9c-40e3-8854-760ee3b8efc7"

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
name
string
required

the inventory name

​
default
boolean
required

flag if the inventory is the default one

​
resources
object[]
required

the inventory resources list

​
description
string

the inventory description