Bulk delete hosts
Deletes multiple hosts in a single request. The request body should be an array of host IDs to delete. Fails if any host has an associated daemon.
User API key (Bearer scp_u_...). Create in Platform > API Keys.
In: header
Request Body
application/json
Array of Host IDs to delete
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/hosts/bulk-delete" \ -H "Content-Type: application/json" \ -d '[ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ]'{
"meta": {
"api_version": 1,
"server_version": "0.19.6"
},
"success": true,
"data": {
"deleted_count": 0,
"requested_count": 0
},
"error": "string"
}{
"meta": {
"api_version": 1,
"server_version": "0.19.6"
},
"success": true,
"code": "string",
"error": "string",
"params": {
"property1": null,
"property2": null
}
}Product names and logos are trademarks of their respective owners. See credits.
List hosts
Returns all hosts the authenticated user has access to, with their ip_addresses, ports, services and interfaces included — pass `include_children=false` to omit the ports, services and interfaces and get a much smaller payload. Supports pagination via `limit` and `offset` query parameters, and ordering via `group_by`, `order_by`, and `order_direction`.
Rescan hosts
Rescans several hosts at once. Hosts last found by the same daemon share one rescan, which scans all of their addresses in one session; hosts found by different daemons get one rescan per daemon. Every host is checked as in `POST /{id}/rescan` before any rescan starts, and the request is refused if any of them can't be rescanned. Returns one session per daemon.