Collections

This contains APIs specific to Collections

Retrieve a list of collections

This API endpoint allows you to retrieve a list of collections. The endpoint is paginated.

Securityx-api-key

Request

Request Body schema: application/json

page	integer Default: 0 The page number for pagination
page_size	integer The number of items per page (default may vary)
	object

Responses

200

OK response.

post/v1/org/units/list

Request samples

Payload
curl
Java
Go

application/json

{"page": 0,
"page_size": 0,
"filter": {"ou_category_id": ["string"
]
}
}

Response samples

application/json

{"records": [{"id": "76",
"ou_id": "8ffa98a4-c607-4d90-a333-b79bf095a7fb",
"name": "All Teams",
"tags": [ ],
"managers": [ ],
"admins": [ ],
"sections": [ ],
"version": "1",
"no_of_dashboards": 3,
"path": "/All Teams",
"ou_category_id": "ffaea171-ba57-4222-81b0-d26d3284c065",
"default_dashboard_id": 0,
"workspace_id": 34,
"created_at": 1710173818740,
"workflow_profile_id": "f1d1d2f2-bba6-4f19-92c2-fcd4e4fa8116",
"workflow_profile_name": "DORA profile"
},
{"id": "79",
"ou_id": "e1dc905b-0eca-4c4d-ad49-a3ce396fe0ff",
"name": "Frontend",
"tags": [ ],
"managers": [ ],
"admins": [ ],
"sections": [ ],
"parent_ref_id": 76,
"version": "2",
"no_of_dashboards": 0,
"path": "/All Teams/Frontend",
"ou_category_id": "ffaea171-ba57-4222-81b0-d26d3284c065",
"default_dashboard_id": 0,
"workspace_id": 34,
"created_at": 1710947467896
}
],
"count": 2,
"_metadata": {"page_size": 100,
"page": 0,
"has_next": false,
"total_count": 2
}
}

Create a new collection

This API endpoint allows you to create a new collection.

Securityx-api-key

Request

Request Body schema: application/json

Array

name	string The name of the new collection
ou_category_id	string The ID of the category to which the collection belongs
parent_ref_id	string The reference ID of the parent collection
	Array of objects

Responses

200

OK response.

post/v1/org/units

Request samples

Payload
curl
Java
Go

application/json

[{"name": "string",
"ou_category_id": "string",
"parent_ref_id": "string",
"sections": [{"id": "string",
"integrations": {"property1": {"type": "string",
"filters": { }
},
"property2": {"type": "string",
"filters": { }
}
}
}
]
}
]

Response samples

application/json

{"errors": [ ],
"success": [82
]
}

Edit an existing collection

This API endpoint allows you to edit an existing collection.

Securityx-api-key

Request

Request Body schema: application/json

Array

id	string The reference ID of the collection to be edited
name	string or null The new name for the collection
ou_category_id	string or null The ID of the category to which the collection belongs
parent_ref_id	string or null The reference ID of the parent collection
	Array of objects

Responses

200

OK response.

put/v1/org/units

Request samples

Payload
curl
Java
Go

application/json

[{"id": "string",
"name": "string",
"ou_category_id": "string",
"parent_ref_id": "string",
"sections": [{"id": "string",
"integrations": {"property1": {"type": "string",
"filters": { }
},
"property2": {"type": "string",
"filters": { }
}
}
}
]
}
]

Response samples

application/json

{"errors": [ ],
"success": [74
]
}

Delete an existing collection

This API endpoint allows you to delete an existing collection.

Securityx-api-key

Request

Request Body schema: application/json

Array

string

The reference ID of the collection to be deleted. Multiple IDs can be included in the array to delete multiple collections in a single request.

Responses

200

OK response.

delete/v1/org/units

Request samples

Payload
curl
Java
Go

application/json

["string"
]

Response samples

application/json

{"message": "The collection(s) were successfully deleted."
}

➔ Next to Contributors