External DocumentationTo learn more, visit the Sekoia.io documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Asset Categories | A comma separated list of asset categories to filter by. |
| Asset Name | Filter by the asset’s name. |
| Asset Types | A comma separated list of asset types to filter by. |
| Asset UUIDs | A comma separated list of asset UUIDs to filter by. |
| Direction | The direction of the sort. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Sort | Sort returned assets by a provided field. |
| Sources | A comma separated list of asset sources to filter by. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Community UUIDs | A comma separated list of asset community UUIDs to filter by. |
| Include Revoked | Select to include revoked assets in the search results. |
| Incorporate Atoms | Select to enrich returned assets with their detection properties. |
| Limit | The number of items to retrieve. The allowed range is 1-100. The default is 20. |
| Offset | The number of items to skip when paginating. Must be bigger or equal to 0. |
| Reviewed | If set to True, filters reviewed assets only. |
| Rule UUIDs | A comma separated list of asset rule UUIDs to filter by. |
| Rule Version | A comma separated list of asset discovery rules versions to filter by. |
| Search In Detection Properties | Select to search by attached detection property. |
| Search In Tags | Select to search by asset tags. |
| With Telemetry | Select to Enrich returned assets with their telemetry statistics. |
Example Output
{
"total": 54,
"items": [
{
"uuid": "<string>",
"community_uuid": "<string>",
"name": "<string>",
"type": "<string>",
"criticality": 2,
"created_at": "<string>",
"created_by_type": "<string>",
"updated_at": "<string>",
"nb_atoms": 2,
"props": {
"sekoia.io_agent_id": "<string>",
"os": "<string>",
"os_type": "<string>"
},
"tags": [],
"revoked": false,
"reviewed": false,
"source": "<string>"
},
{
"uuid": "<string>",
"community_uuid": "<string>",
"name": "<string>",
"type": "<string>",
"criticality": 1,
"created_at": "<string>",
"created_by_type": "<string>",
"updated_at": "<string>",
"nb_atoms": 0,
"props": {
"sekoia.io_agent_id": "<string>",
"os": "<string>",
"os_type": "<string>"
},
"tags": [],
"revoked": false,
"reviewed": false,
"source": "<string>"
}
]
}