Skip to content
SupaCloud Docs
Select themeSelect language

delete_api_management_v1_runners_name_

DELETE
/api/management/v1/runners/{name}
curl --request DELETE \
  --url https://example.com/api/management/v1/runners/example

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
name
required
string

Management API runner name

Responses

Section titled “ Responses ”

200

Section titled “200”

Deleted with all its tokens

Media typeapplication/json
object
changed
required
boolean
id
required
string format: uuid
key
required
string
resource_type
required
string
status
required
string
Examplegenerated
{
  "changed": true,
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "key": "example",
  "resource_type": "example",
  "status": "example"
}

403

Section titled “403”

Missing runners:write, or not an instance-level token

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

404

Section titled “404”

No runner registered under this name

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}