Last updated
Last updated
You can manage your programmatically using the Roboflow API.
Note: This feature is only available for Enterprise workspaces.
Note: Your api_key
must be sent in all requests. The api_key
can be sent as a query parameter or as a top level attribute in the post body.
POST
/:workspace/groups
Creates a Project Folder.
Headers
Body
Response
GET
/:workspace/groups/:folderId
Retrieves a Project Folder by ID
Headers
Query
Example Request
Response
POST
/:workspace/groups/:folderId
Updates a Project Folder's properities
Headers
Query
Body
Example Request
Response
No Content. Resource was updated successfully
PATCH
/:workspace/groups/:folderId/projects
Adds one or more projects to an existing folder
Headers
Body
Example Request
Response
No Content. Project was added to the group successfully
DELETE
/:workspace/groups/:folderId/projects
Removes one or more projects from an existing folder and places it back into the top level workspace
Headers
Body
Example Request
Response
No Content. Project was removed from the group successfully
DELETE
/:workspace/groups/:folderId
Deletes a project Folder. All projects within the folder will be placed back into the top level workspace and not deleted.
Headers
Example Request
Response
No Content. Project Folder was successfully deleted
Content-Type
application/json
api_key
string
API Key of workspace where Project Folder exists
Content-Type
application/json
returnUpdated
boolean
When set, returns the full resource payload in the response
api_key
string
The api key of the workspace where the Project Folder should be created
name
string
The name of the Project Folder
projects
Array<string>
A list of ids of projects that should be moved to this folder
external_id
string
The id of this Project Folder in an external system
auth_groups
Map<"read" | "write , Array<string>
A list of permission groups that should have read/write access to the projects within this Folder. (Note: please contact Roboflow before using this feature as it requires additional set up)
Content-Type
application/json
projects
Array<string>
A list of project ids to add to the Project Folder
Content-Type
application/json
projects
Array<string>
A list of project ids to remove from the Project Folder
Content-Type
application/json
Content-Type
application/json
api_key
string
The api key of the workspace where the Project Folder should be created
name
string
The name of the Project Folder
projects
Array<string>
A list of ids of projects that should be moved to this folder
external_id
string
The id of this Project Folder in an external system
auth_groups
Map<"read" | "write , Array<string>
A list of permission groups that should have read/write access to the projects within this Folder. (Note: please contact Roboflow before using this feature as it requires additional set up)