Group Delete Job

To delete an existing group as a Product Admin, use the API below.

info

{api-base-url} can be obtained from the MirrorFly console.

Note: This API initiates an asynchronous deletion process. To monitor the progress, use the Group Delete Job Status API.

HTTP request#

curl -X DELETE 'https://{api-base-url}/api/v1/group/jobs' \
--header 'Authorization: xxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{"groupId": ":groupId"}'

Note: To retrieve the groupId required for this API, use the Get Groups List API.

Request Params#

ParamDataTypeRequiredDescription
groupIdStringYesId of the group to be deleted

Responses#

If successful, this action deletes the given group.

{
"status": 202,
"data": {
"jobId": "xxxxxxxxxxxxxx"
},
"message": "Group deletion job submitted",
"error": false
}

Error#

In the case of an error, an error object like below is returned.

When the token passed in Headers is expired

{
"status": 401,
"message": "Token Expired"
}

In the case of a Unauthorized access (not a Product Admin)

{
"status": 403,
"message": "User access denied",
"error": true
}