| Object type: asset-data-container | |
|---|---|
| An Asset Data object contains identification and location information about enterprise assets. | |
| Field | Description |
| assets | A list of asset objects, generated as the result of an executed asset report. Definition |
| events | The list of AssetEventData objects used to locate AssetData objects when executing an asset report. Definition |
| id | Unique identifier for asset container. |
| meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
| Object type: meta | |
|---|---|
| The metadata for an object, including the object type name and the URL reference to the object. | |
| Field | Description |
| @href | The URL reference to the object. |
| type | The name of the object type |
| Object type: asset-data | |
|---|---|
| An Asset Data object contains identification and location information about an enterprise assets. | |
| Field | Description |
| address-line1 | The primary address of the asset. |
| address-line2 | The secondary address of the asset, such as a suite or appartment number. |
| asset-category | The category or grouping for the asset. Must be one of the values from the asset category table. Default values include: "UNKNOWN", "DESKTOP", "OS". "SERVICE". |
| asset-name | The human readable name given to the asset. |
| asset-value | The monitary or relative value assigned to the asset. |
| building | The building where the asset is located. |
| city | The city were the asset is located. |
| contacts | A contact or responsible party list for the asset. Definition |
| country | The country where the asset is located. |
| criticality | A value indicating how critical the asset is in the enterprise. |
| customer-id | A unique ID assigned to a specific customer. For example an MSSP will assign their customers a unique ID. |
| hostname | The host name assigned to the asset. |
| ip | The IP address assigned to the asset. |
| ip-addresses | A list of IP addresses assigned to the asset. Definition |
| mac-address | The MAC Address of the asset. |
| product-name | The asset product name. |
| product-version | The aset product version. |
| rack-number | The number used to identify a specific rack or shelve where the asset is located. |
| room | The room number where the asset is located. |
| sensitivity | Needs description. |
| soft-assets | A list of software assets installed or registered to the asset. Definition |
| state | The state were the asset is located. |
| vendor | The vendor or manufacturer of the asset. |
| zipcode | The zip code of the city where the asset is located. |
| Object type: asset-event-data | |
|---|---|
| An Asset Event Data object contains event information required to search for assets in the system such as host names, IP addresses as well as event IDs and event times. | |
| Field | Description |
| customer-name | Search for assets from a specific customer. |
| dhn | Search for assets containing the given target host name event field value. |
| dip | Search for assets containing the given target IP event field value. |
| shn | Search for assets containing the given source host name event field value. |
| sip | Search for assets containing the given source IP event field value. |
| time | Used to find assets associated with a given event ID and time. |
| uuid | Used to find assets associated with a given event ID and time. |
GET https://164.99.19.131:8443/SentinelRESTServices/objects/asset-data-container/Wildebeest
{
"meta":{
"type":"asset-data-container",
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/asset-data-container/Wildebeest"
},
"id":"Wildebeest",
"assets":[
{
"building":"Main",
"product-name":"Windows",
"sensitivity":"Wildebeest",
"vendor":"Company",
"zipcode":"84606",
"asset-name":"HR Server1",
"state":"Utah",
"asset-category":"DESKTOP",
"hostname":"server1.company.com",
"address-line1":"1800 North Place",
"mac-address":"Wildebeest",
"address-line2":"Suite 22",
"ip":"167.54.1.12",
"city":"Provo",
"country":"USA",
"criticality":"High",
"customer-id":"101001",
"asset-value":"$1000",
"rack-number":"A3-3",
"product-version":"v1.0.0",
"room":"H363",
"ip-addresses":[
{
"ip-address":"167.51.2.11",
"id":"79600390-9B73-102E-A3E2-001676E4A757",
"hostname":"server.company.com"
}
],
"soft-assets":[
{
"id":"79600390-9B73-102E-A3E2-001676E4A757",
"category":"OS",
"product-name":"Windows 7",
"vendor":"Company",
"name":"Windows 7",
"product-version":"v1.0.0"
}
],
"contacts":[
{
"id":"79600390-9B73-102E-A3E2-001676E4A757",
"name":"Joe Smith",
"seq":"Wildebeest",
"role":"IT Manager",
"email-address":"joe@company.com",
"phone-number":"555-555-7000"
}
]
}
],
"events":[
{
"shn":"server.company.com",
"time":"2012-04-25T13:33:44.675Z",
"dip":"167.52.1.12",
"sip":"167.52.1.12",
"uuid":"79600390-9B73-102E-A3E2-001676E4A757",
"customer-name":"Company A",
"dhn":"server.company.com"
}
]
}
| Object type: asset-data-container | ||
|---|---|---|
| An Asset Data object contains identification and location information about enterprise assets. | ||
| Field | Required | Description |
| assets | false | A list of asset objects, generated as the result of an executed asset report. Definition |
| events | false | The list of AssetEventData objects used to locate AssetData objects when executing an asset report. Definition |
| id | false | Unique identifier for asset container. |
| Object type: meta | ||
|---|---|---|
| The metadata for an object, including the object type name and the URL reference to the object. | ||
| Field | Required | Description |
| @href | false | The URL reference to the object. |
| type | false | The name of the object type |
| Object type: asset-data | ||
|---|---|---|
| An Asset Data object contains identification and location information about an enterprise assets. | ||
| Field | Required | Description |
| address-line1 | false | The primary address of the asset. |
| address-line2 | false | The secondary address of the asset, such as a suite or appartment number. |
| asset-category | false | The category or grouping for the asset. Must be one of the values from the asset category table. Default values include: "UNKNOWN", "DESKTOP", "OS". "SERVICE". |
| asset-name | false | The human readable name given to the asset. |
| asset-value | false | The monitary or relative value assigned to the asset. |
| building | false | The building where the asset is located. |
| city | false | The city were the asset is located. |
| contacts | false | A contact or responsible party list for the asset. Definition |
| country | false | The country where the asset is located. |
| criticality | false | A value indicating how critical the asset is in the enterprise. |
| customer-id | false | A unique ID assigned to a specific customer. For example an MSSP will assign their customers a unique ID. |
| hostname | false | The host name assigned to the asset. |
| ip | false | The IP address assigned to the asset. |
| ip-addresses | false | A list of IP addresses assigned to the asset. Definition |
| mac-address | false | The MAC Address of the asset. |
| product-name | false | The asset product name. |
| product-version | false | The aset product version. |
| rack-number | false | The number used to identify a specific rack or shelve where the asset is located. |
| room | false | The room number where the asset is located. |
| sensitivity | false | Needs description. |
| soft-assets | false | A list of software assets installed or registered to the asset. Definition |
| state | false | The state were the asset is located. |
| vendor | false | The vendor or manufacturer of the asset. |
| zipcode | false | The zip code of the city where the asset is located. |
| Object type: asset-event-data | ||
|---|---|---|
| An Asset Event Data object contains event information required to search for assets in the system such as host names, IP addresses as well as event IDs and event times. | ||
| Field | Required | Description |
| customer-name | false | Search for assets from a specific customer. |
| dhn | false | Search for assets containing the given target host name event field value. |
| dip | false | Search for assets containing the given target IP event field value. |
| shn | false | Search for assets containing the given source host name event field value. |
| sip | false | Search for assets containing the given source IP event field value. |
| time | false | Used to find assets associated with a given event ID and time. |
| uuid | false | Used to find assets associated with a given event ID and time. |
PUT https://164.99.19.131:8443/SentinelRESTServices/objects/asset-data-container/Wildebeest
{
"id":"Wildebeest",
"assets":[
{
"building":"Main",
"product-name":"Windows",
"sensitivity":"Wildebeest",
"vendor":"Company",
"zipcode":"84606",
"asset-name":"HR Server1",
"state":"Utah",
"asset-category":"DESKTOP",
"hostname":"server1.company.com",
"address-line1":"1800 North Place",
"mac-address":"Wildebeest",
"address-line2":"Suite 22",
"ip":"167.54.1.12",
"city":"Provo",
"country":"USA",
"criticality":"High",
"customer-id":"101001",
"asset-value":"$1000",
"rack-number":"A3-3",
"product-version":"v1.0.0",
"room":"H363",
"ip-addresses":[
{
"ip-address":"167.51.2.11",
"id":"79600390-9B73-102E-A3E2-001676E4A757",
"hostname":"server.company.com"
}
],
"soft-assets":[
{
"id":"79600390-9B73-102E-A3E2-001676E4A757",
"category":"OS",
"product-name":"Windows 7",
"vendor":"Company",
"name":"Windows 7",
"product-version":"v1.0.0"
}
],
"contacts":[
{
"id":"79600390-9B73-102E-A3E2-001676E4A757",
"name":"Joe Smith",
"seq":"Wildebeest",
"role":"IT Manager",
"email-address":"joe@company.com",
"phone-number":"555-555-7000"
}
]
}
],
"events":[
{
"shn":"server.company.com",
"time":"2012-04-25T13:33:44.675Z",
"dip":"167.52.1.12",
"sip":"167.52.1.12",
"uuid":"79600390-9B73-102E-A3E2-001676E4A757",
"customer-name":"Company A",
"dhn":"server.company.com"
}
]
}
DELETE https://164.99.19.131:8443/SentinelRESTServices/objects/asset-data-container/Wildebeest