Delete database API Reference

DELETE

/tenants/{tenant}/databases/{name}

const url = 'https://api.kupe.cloud/api/v1/tenants/acme/databases/orders-db';
const options = {method: 'DELETE', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.kupe.cloud/api/v1/tenants/acme/databases/orders-db \
  --header 'Authorization: <Authorization>'

Delete a managed database and its bindings in every cluster. Refused with 409 (code deletion_protected) while deletionProtection is true: PATCH it to false first.

Authorizations

BearerAuth

Parameters

Path Parameters

tenant

required

string

Tenant name

name

required

string

Database name

Responses

204

Database deletion initiated

400

Invalid name

object

code

string

error

string

field

string

message

string

severity

string

401

Missing or invalid authentication

object

code

string

error

string

field

string

message

string

severity

string

403

Admin access required

object

code

string

error

string

field

string

message

string

severity

string

404

Database not found

object

code

string

error

string

field

string

message

string

severity

string

409

Deletion protection is enabled (code deletion_protected), or the database kept changing while it was being deleted

object

code

string

error

string

field

string

message

string

severity

string

429

Rate limit exceeded

object

code

string

error

string

field

string

message

string

severity

string