folders

create_folder

Create a new folder.

Securityx-api-key
Request
query Parameters
accountId
string
Request Body schema: application/json
required

Create a new folder

name
required
string
Responses
200

Returns the newly created folder's details.

default

Unexpected error.

post/dashboard/folders
Request samples
application/json
{
  • "name": "string"
}
Response samples
application/json
{
  • "resource": {
    }
}

get_folder

Get a folder by ID.

Securityx-api-key
Request
path Parameters
folder_id
required
string
query Parameters
accountId
string
Responses
200

Returns the folder details.

default

Unexpected error.

get/dashboard/folders/{folder_id}
Request samples
Response samples
application/json
{
  • "resource": {
    }
}

update_folder

Update a folder's name.

Securityx-api-key
Request
path Parameters
folder_id
required
string
query Parameters
accountId
string
Request Body schema: application/json
required

Change the name of a folder

name
required
string
Responses
200

Returns the updated folder.

default

Unexpected error.

patch/dashboard/folders/{folder_id}
Request samples
application/json
{
  • "name": "string"
}
Response samples
application/json
{
  • "resource": {
    }
}

delete_folder

Delete a folder along with any dashboards it contains.

Securityx-api-key
Request
path Parameters
folder_id
required
string
query Parameters
accountId
string
Responses
200

Returns the deleted folder.

default

Unexpected error.

delete/dashboard/folders/{folder_id}
Request samples
Response samples
application/json
{
  • "resource": {
    }
}