SuspendAccount
    • Dark
      Light

    SuspendAccount

    • Dark
      Light

    Article summary

    Post
    /v1/accounts/{accountId}:suspend

    Availability

    Early Access: November 17, 2026

    Early Access is gated; contact the Backblaze Sales team for access.

    Limited Availability: November 17, 2026

    This API is available only to customers with access to the Backblaze Enterprise Web Console. For more information, contact the Backblaze Sales team.

    Suspend an account

    Freezes account usage by adding EXTERNALLY_INITIATED to suspensionReasons.

    Semantics

    • May be called when the account is ACTIVE or already SUSPENDED.
    • If EXTERNALLY_INITIATED is already present, the operation is a no-op success.
    • BACKBLAZE_INITIATED and EXTERNALLY_INITIATED may coexist.
    • The resulting state is SUSPENDED.
    • If the account is DELETED, the request fails and existing suspension reasons are unchanged.
    • Suspension reasons are unique and their JSON array order is unspecified.

    While suspended

    • B2 data access, IAM workload access, STS issuance, B2/IAM resource mutations, and public B2 access are blocked.
    • Account Get/List, Update, Move, Suspend, and Unsuspend operations remain available subject to normal authorization.
    • DeleteAccount is allowed only when EXTERNALLY_INITIATED is the sole suspension reason; that reason is retained through deletion.
    • Suspension does not modify stored data, IAM users, access keys, IAM policies, buckets, bucket policies, or bucket settings.
    Security
    HTTP
    Type bearer

    Short-lived bearer token obtained from GET /orgs/v1/authorize. Sent as Authorization - Bearer .

    Path parameters
    accountId
    stringRequired

    The numeric identifier of the account. Valid account IDs match 9[0-4][0-9]{10}.

    Pattern^9[0-4][0-9]{10}$
    Example912345678901
    Responses
    200

    The request succeeded.

    {
      "name": "accounts/912345678901",
      "accountId": "912345678901",
      "parent": "organizations/org-acme-prod",
      "organization": "organizations/org-acme-prod",
      "displayName": "tenant-prod-renamed",
      "billingAccount": "billingAccounts/456",
      "state": "SUSPENDED",
      "suspensionReasons": [
        "EXTERNALLY_INITIATED"
      ],
      "etag": "FwQ1J8D0bA4=",
      "createTime": "2026-02-03T21:10:00Z",
      "updateTime": "2026-02-07T12:00:00Z",
      "deleteTime": null,
      "purgeTime": null
    }
    object
    name
    string

    Resource name in the form accounts/.

    Exampleaccounts/912345678901
    accountId
    string

    The numeric account identifier. Valid values match 9[0-4][0-9]{10}.

    Example912345678901
    parent
    string

    Parent resource name. May be an organization or an Organizational Unit.

    Exampleorganizations/org-acme-prod
    organization
    string

    The organization the account belongs to. Always populated, even if parent is an Organizational Unit.

    Exampleorganizations/org-acme-prod
    billingAccount
    string

    Billing account reference, in the form billingAccounts/. Must belong to the same organization as the account. Cannot be changed after creation.

    ExamplebillingAccounts/456
    displayName
    string
    Exampletenant-prod
    state
    string

    Account lifecycle state. An account is SUSPENDED while one or more suspension reasons are active.

    Valid values[ "ACTIVE", "SUSPENDED", "DELETED" ]
    ExampleACTIVE
    suspensionReasons
    Array of string

    Reasons the account is suspended. Values are unique and array order is unspecified.

    Example[]
    string
    Valid values[ "BACKBLAZE_INITIATED", "EXTERNALLY_INITIATED" ]
    etag
    string
    ExampleBwXk9a2J8p0=
    createTime
    string (date-time)
    updateTime
    string (date-time)
    deleteTime
    string (date-time) | null
    purgeTime
    string (date-time) | null
    401

    The request was not authenticated.

    HTTP StatusCodeDescription
    401UNAUTHORIZEDMissing, expired, or invalid bearer token.
    Expand All
    object
    requestId
    string

    Opaque correlation identifier matching the Request-Id response header. Include in support requests.

    Example4bf92f3577b34da6a3ce929d0e0e4736
    error
    object
    code
    integer

    Numeric error code.

    Example10
    message
    string

    Human-readable description of the error.

    Exampleetag mismatch
    details
    object

    Reserved for structured, non-sensitive diagnostic information related to the error condition.

    403

    The caller is not authorized to perform this operation.

    HTTP StatusCodeDescription
    403FORBIDDENThe authenticated principal lacks permission for this action.
    Expand All
    object
    requestId
    string

    Opaque correlation identifier matching the Request-Id response header. Include in support requests.

    Example4bf92f3577b34da6a3ce929d0e0e4736
    error
    object
    code
    integer

    Numeric error code.

    Example10
    message
    string

    Human-readable description of the error.

    Exampleetag mismatch
    details
    object

    Reserved for structured, non-sensitive diagnostic information related to the error condition.

    404

    The requested resource was not found.

    HTTP StatusCodeDescription
    404NOT_FOUNDThe resource does not exist or has been purged.
    Expand All
    object
    requestId
    string

    Opaque correlation identifier matching the Request-Id response header. Include in support requests.

    Example4bf92f3577b34da6a3ce929d0e0e4736
    error
    object
    code
    integer

    Numeric error code.

    Example10
    message
    string

    Human-readable description of the error.

    Exampleetag mismatch
    details
    object

    Reserved for structured, non-sensitive diagnostic information related to the error condition.

    409

    The request conflicted with the current state of the resource.

    HTTP StatusCodeDescription
    409CONFLICTetag mismatch, resource already exists, or precondition failed.
    Expand All
    object
    requestId
    string

    Opaque correlation identifier matching the Request-Id response header. Include in support requests.

    Example4bf92f3577b34da6a3ce929d0e0e4736
    error
    object
    code
    integer

    Numeric error code.

    Example10
    message
    string

    Human-readable description of the error.

    Exampleetag mismatch
    details
    object

    Reserved for structured, non-sensitive diagnostic information related to the error condition.

    429

    The request was rate-limited.

    HTTP StatusCodeDescription
    429TOO_MANY_REQUESTSRate limit exceeded. Use exponential backoff.
    Expand All
    object
    requestId
    string

    Opaque correlation identifier matching the Request-Id response header. Include in support requests.

    Example4bf92f3577b34da6a3ce929d0e0e4736
    error
    object
    code
    integer

    Numeric error code.

    Example10
    message
    string

    Human-readable description of the error.

    Exampleetag mismatch
    details
    object

    Reserved for structured, non-sensitive diagnostic information related to the error condition.

    500

    The server encountered an unexpected condition.

    HTTP StatusCodeDescription
    500INTERNALUnexpected server error. Include the requestId when contacting support.
    Expand All
    object
    requestId
    string

    Opaque correlation identifier matching the Request-Id response header. Include in support requests.

    Example4bf92f3577b34da6a3ce929d0e0e4736
    error
    object
    code
    integer

    Numeric error code.

    Example10
    message
    string

    Human-readable description of the error.

    Exampleetag mismatch
    details
    object

    Reserved for structured, non-sensitive diagnostic information related to the error condition.


    Was this article helpful?