Delete an app API Reference

DELETE

/tenants/{tenant}/apps/{app}

curl --request DELETE \
  --url https://api.kupe.cloud/api/v1/tenants/example/apps/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "confirm": "example", "environments": [ "example" ] }'

Delete the app and its environments, including their namespaces and everything in them. Vault entries and clusters remain. Turn off protection on the app and all environments first. Independent secret deliveries or service bindings into its environments’ namespaces must be removed first. Repeat the app name in confirm and send the environment names you reviewed in environments. Only environments named in the review are deleted. Any other environment is kept. If the app has already gone, an administrator must remove that environment. Deletion is asynchronous.

Authorizations

• BearerAuth

Parameters

Path Parameters

tenant

required

string

Tenant name

app

required

string

App name

Header Parameters

If-Match

string

ETag from the app or environment read

Request Body

Request

Media type application/json

object

confirm

Repeat the app name, or the environment name for an environment delete.

string

environments

App deletion only: the exact environment names reviewed, when supplied.

Array<string>

Example ^generated

{
  "confirm": "example",
  "environments": [
    "example"
  ]
}

Responses

202

Accepted

Media type application/json

object

name

string

status

object

phase

Always “Terminating” on acceptance; GET /tenants/{tenant} reports the same phase until the tenant is gone (then 404).

string

Example

{
  "name": "acme",
  "status": {
    "phase": "Terminating"
  }
}

400

Bad Request

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

401

Unauthorized

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

403

Forbidden

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

404

Not Found

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

409

Conflict

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

412

Precondition Failed

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

429

Too Many Requests

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

500

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}