1. API Operations
  2. Add workspace

Deprecated

You are viewing a deprecated version of our API Reference. Please visit the up-to-date documentation.

Add workspace

This operation creates a new workspace, with an optional description.


Request

Parameters
Parameter
op
Type
string
required
true

Add a new workspace. The value is "add_workspace".

Parameter
name
Type
string
required
true

The name of the new workspace.

Parameter
description
Type
string
default
 
Added from API

Set a description for the new workspace.

{
  "op": "add_workspace",
  "name": "JulyPentest"
}

Response

Attributes
Attribute
op_status
Type
string

The status of the operation. The value can be "success" or "fail".

Attribute
workspace_id
Type
integer

The ID of the newly created. Returned in case of a successful operation.

Attribute
error
Type
string

Error message. Value returned in case of a failed operation: "invalid request".

Attribute
details
Type
string

Error details. Returned in case of an invalid target error.

{
  "op_status": "success",
  "workspace_id": 699761
}