Delete public folder

DELETE

/domains/{domainID}/folders/{folderID}

curl --request DELETE \
  --url 'https://example.com/api/v1/domains/1/folders/1?clear=false&timeout=1' \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Parameters

Path Parameters

domainID

required

integer

ID of the domain

folderID

required

integer

ID of the folder

Header Parameters

X-Csrf-Token

string

CSRF Token

Query Parameters

clear

boolean

Clear folder before deleting it

timeout

number

default: 1

Time in seconds to wait for completion

Responses

200

Deletion successful

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

202

Task took more than timeout seconds and is resumed in the background

Media typeapplication/json

object

message

string

taskID

ID of the task running the command

integer

Example^generated

{
  "message": "example",
  "taskID": 1
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

404

The requested resource could not be found

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}

503

The database query failed

Media typeapplication/json

object

message

Description of the error

string

Example^generated

{
  "message": "example"
}