Skip to content
Aether Docs

Delete a cluster

DELETE
/api/v1/organizations/{orgID}/clusters/{clusterID}
 
curl --request DELETE \
  --url https://api.aetherplatform.cloud/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Begins teardown. Returns 202 with {"status":"deleting"} when infrastructure exists, or 200 with {"status":"deleted"} when there was nothing to tear down.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
orgID
required
string format: uuid

Organization UUID.

clusterID
required
string format: uuid

Cluster UUID.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Cluster deleted (no infrastructure was provisioned).

Media type application/json
object
status

A short status word, e.g. “deleting”, “deleted”, or “ok”.

string
Example generated
{
  "status": "example"
}

202

Section titled “202 ”

Cluster teardown started.

Media type application/json
object
status

A short status word, e.g. “deleting”, “deleted”, or “ok”.

string
Example generated
{
  "status": "example"
}

401

Section titled “401 ”

Missing or invalid credentials.

Media type application/json
object
error
required
object
code
required

A stable, machine-readable error code.

string
message
required
string
details
Array<object>
object
field
required
string
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}

404

Section titled “404 ”

The requested resource was not found.

Media type application/json
object
error
required
object
code
required

A stable, machine-readable error code.

string
message
required
string
details
Array<object>
object
field
required
string
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}