Management API — Folders
Management API — Folders
Manage the organization’s folders. All endpoints are scoped to the Management API Key’s organization and require a Management API Key — see the Overview for authentication and error conventions.
Personal folders are never visible to the Management API. The organization folder (the built-in Default folder) is listed and readable, but cannot be renamed or deleted.
List folders
GET /management/folders
Returns the organization’s folders, newest first.
nextCursor is the before value to pass to fetch the next page, or null when the
last page has been reached. Keep requesting with it until it comes back null:
Get a folder
GET /management/folders/{folderId}
Returns 404 if the folder does not exist in the key’s organization.
Create a folder
POST /management/folders
Responds 201 with the created folder. The key’s owner is added as the folder’s admin.
Rename or update a folder
PATCH /management/folders/{folderId}
Supply name, description, or both; at least one is required. Renaming the
organization folder is rejected with 400.
Delete a folder
DELETE /management/folders/{folderId}
Because targets and evaluations live in a folder, deletion must say what happens to the
folder’s contents, via a contentMode field:
Either way, the folder’s Red Team API Keys are revoked. Deleting the organization folder
is rejected with 400.
Responds 204 with no body.