API Reference

Edit a workspace by ID.

patch
http://localhost/api/v1/workspaces/

Required permissions

  • modify workspaces

Optional permissions

  • read intel-sets To read/modify datasets attached to the workspace

  • read entities To read/modify entities pinned to the workspace

  • read tasks To read/modify discovery tasks associated to the workspace

  • read discovery-rules To read discovery tasks associated to the workspaces

  • read tickets To read/modify tickets attached to the workspace

  • read users To read/modify workspace collaborators

  • read groups To read/modify workspace collaborator groups

  • read files To read workspace files

  • read workspace-comments To read workspace comments

Path Params
int32
required
≥ 1

Workspace ID

Query Params
boolean

If ?overwrite_datasets=false and new datasets are provided, the resulting set of datasets will contain both the previous and the new datasets. Otherwise, the list of datasets will be overwritten by the new one (default: true).

boolean

If ?overwrite_entities=false and new entities are provided, the resulting set of entities will contain both the previous and the new entities. Otherwise, the list of entities will be overwritten by the new one (default: true).

boolean

If ?overwrite_discovery_tasks=false and new discovery_tasks are provided, the resulting set of discovery_tasks will contain both the previous and the new discovery_tasks. Otherwise, the list of discovery_tasks will be overwritten by the new one (default: true).

boolean

If ?overwrite_tickets=false and new tickets are provided, the resulting set of tickets will contain both the previous and the new tickets. Otherwise, the list of tickets will be overwritten by the new one (default: true).

boolean

If ?overwrite_collaborators=false and new collaborators are provided, the resulting set of collaborators will contain both the previous and the new collaborators. Otherwise, the list of collaborators will be overwritten by the new one (default: true).

boolean

If ?overwrite_groups=false and new groups are provided, the resulting set of groups will contain both the previous and the new groups. Otherwise, the list of groups will be overwritten by the new one (default: true).

Body Params
data
object
Responses

Updated 11 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 11 months ago