Skip to navigation
API ReferenceSpaces

Delete a Space

View as Markdown

Delete a Space and everything in it: its browsers and sandboxes are stopped and destroyed, and its agents, Tasks, Conversations, files and views deleted. Run records, usage and Events stay with the organization. The deletion runs in the background; the Space shows status deleting until it is gone. Pass wait to block until then.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

spaceIdstringRequired

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.
Idempotency-KeystringOptional1-200 characters

Optional retry key for this billable operation. Reusing the same key with the same request replays its stable outcome; credential-bearing results may be freshly issued for the same principal. Reusing it with a different request returns 409.

Query parameters

waitintegerOptional0-60Defaults to 0
Seconds to wait for the deletion to finish before answering.

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

OK
capabilityScopeslist of strings
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
deletionErrorstring or null

Why the deletion is not finished yet; it is retried. Null otherwise.

environmentobject
expireAfterIdleDaysinteger1-365
idstring
Unique space identifier generated by BCTRL.
isDefaultboolean
namestring1-200 characters

Customer-facing resource name. 1–200 characters.

object"space"
regionenum
Allowed values:
statusenum

deleting once DELETE is accepted: its browsers, sandboxes, agents, Tasks, Conversations, files and views are being stopped and removed. deleted appears only in the DELETE response when the deletion finished within wait; the Space is then gone.

Allowed values:
updatedAtdatetime
RFC 3339 timestamp with a UTC offset.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error