Suspend a team

POST

/api/v1/admin/teams/{id}/suspend

curl --request POST \
  --url https://api.deploybase.eu/api/v1/api/v1/admin/teams/example/suspend \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "example" }'

Takes one team offline for a policy violation: sign-in, the API and API keys are refused, every site, preview, share link, custom domain, serverless function and form endpoint stops serving, and the team is emailed a statement of reasons carrying the reason verbatim. Nothing is deleted — every Edge Rule is disabled in place and every row is kept — so unsuspend restores the account exactly as it was. Safe to re-run: a second call re-applies the CDN teardown without moving the original timestamp or re-sending the email.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Team ID (UUID)

Request Body

Reason, sent to the team verbatim

Media type application/json

object

reason

required

string

>= 8 characters <= 2000 characters

Example ^generated

{
  "reason": "example"
}

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

functions_error

string

functions_reconciled

boolean

hostnames_purged

integer

notification_error

string

notification_sent

boolean

projects

Array<object>

object

domains_processed

integer

errors

Array<string>

previews_processed

integer

production

Production is one of: “disabled”, “restored”, “no_rule” (the project has no production Edge Rule to touch), “no_live_deployment” (nothing to restore it to), “not_processed: …” (the context budget ran out first), or “error: …”.

string

project_id

string

project_slug

string

shares_processed

integer

purge_errors

Array<string>

suspended

Suspended is the team’s state AFTER the call.

boolean

transitioned_now

TransitionedNow is whether THIS call moved the flag. False on a re-run, which is also what keeps the statement of reasons from being sent twice.

boolean

zitadel_error

string

zitadel_org_deactivated

boolean

Example ^generated

{
  "data": {
    "functions_error": "example",
    "functions_reconciled": true,
    "hostnames_purged": 1,
    "notification_error": "example",
    "notification_sent": true,
    "projects": [
      {
        "domains_processed": 1,
        "errors": [
          "example"
        ],
        "previews_processed": 1,
        "production": "example",
        "project_id": "example",
        "project_slug": "example",
        "shares_processed": 1
      }
    ],
    "purge_errors": [
      "example"
    ],
    "suspended": true,
    "transitioned_now": true,
    "zitadel_error": "example",
    "zitadel_org_deactivated": true
  },
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

400

Bad Request

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

401

Unauthorized

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

403

Forbidden

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

Not Found

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

500

Internal Server Error

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

503

Service Unavailable

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}