ROCKITPLAY API

Delete Organization

DELETE

https://Example-Server.com/be/v1/orgs/{ORG_NAME}

Last modified:2025-03-31 07:46:34

This function deletes all data of an ROCKIT Edge organization.

Note, this operation cannot be undone.

Request

Path Params

ORG_NAME

string

required

Example:

Match pattern:

/^[A-Za-z0-9_]{2,50}$/

Query Params

prune

boolean

optional

Example:

true

Header Params

x-rockit-beauth-token

string

required

ROCKIT Edge backend auth token generated by POST auth.

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request DELETE 'https://Example-Server.com/be/v1/orgs/ExampleOrg?prune=true' \
--header 'x-rockit-beauth-token: eyjhvcIhvds;huVODV...'

Responses

🟢200200: success

application/json

Body

status

string

required

A string confirming that the organization was deleted successfully.

message

string

required

Provides a confirmation message such as "organization deleted" to indicate the deletion was completed.

Example

{
  "status": "success",
  "message": "organization deleted"
}

🟠400Invalid Param

🟠401Unauthorized

Create Organization

Authentication