List Families
Returns a collection of all families in the system.
Starting index for pagination
Maximum number of families to return (0 for all)
Dictionary of families keyed by family_id
{
"status": "successful",
"data": {
"1": {
"family_id": 1,
"family_name": "emotet",
"num_samples": 42,
"is_library": false
}
}
}
Get Family
GET /families/{family_id}
ID of the family to retrieve
Include detailed sample information in the response
Family details including metadata and optionally samples
{
"status": "successful",
"data": {
"family_id": 1,
"family_name": "emotet",
"num_samples": 42,
"is_library": false,
"samples": {
"1": {
"sample_id": 1,
"sha256": "abc123...",
"version": "1.0"
}
}
}
}
Update Family
PUT /families/{family_id}
ID of the family to update
New family name (0-64 alphanumeric chars with single dots, dashes, underscores)
Whether the family is a library
{
"status": "successful",
"data": {
"message": "Family modified."
}
}
Delete Family
DELETE /families/{family_id}
ID of the family to delete
Keep samples but remove them from the family
Whether the deletion was successful
By default, deleting a family also deletes all its samples. Set keep_samples=true to preserve samples.
