v18

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014211,6201.8 MB
gitpod.v1.AccountService

BlockAccount

Blocks an account, preventing all API access.

Use this method to:

  • Revoke access for policy violations
  • Handle abuse cases
  • Enforce compliance requirements

When an account is blocked:

  • All API requests return 403 PERMISSION_DENIED
  • All running environments are stopped
  • All active subscriptions are cancelled

Requires the block_account permission.

Examples

  • Block account for policy violation:

    accountId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
    reason: "Terms of Service violation - spam"
    
post/gitpod.v1.AccountService/BlockAccount

Request body

accountIdstring uuid required

account_id is the UUID of the account to block

reasonstring required

reason is the reason for blocking the account (required for audit trail)

Response

Success

environmentsStoppedinteger

environments_stopped is the number of environments that were stopped

subscriptionsCancelledinteger

subscriptions_cancelled is the number of subscriptions that were cancelled

All 421 operations