Delete Sandbox

Beta

DELETE/v1/core/sandboxes/{id}

This endpoint is idempotent. Learn more

Deletes a sandbox account and everything inside it.

The sandbox becomes inaccessible as soon as this call returns, but its data is purged asynchronously and may persist briefly. Deletion is permanent: the sandbox cannot be restored, and deleting it again reports that it has already been deleted. Sandboxes cannot be deleted while acting in a sandbox.

Permissions requiredValues:sandboxes:delete

The role behind your API key or agent must grant every one of these permissions.

idstring

ID of the sandbox to delete.

Responses

202

Successful response for Delete Sandbox

Delete Sandbox

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const sandbox = await client.core.sandboxes.delete('sbac_d8ci32xggml9');

console.log(sandbox);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const sandbox = await client.core.sandboxes.delete('sbac_d8ci32xggml9');

console.log(sandbox);

202 example

{}

{}

Delete Sandbox

Authorization

Path Parameters

Responses