Sign in
gateway.openapi_Gateway

Disconnect Environment

Disconnects the environment from the node pool. Returns an error if the environment is not connected to a node pool.

post/v1/accounts/{account_id}/environments/{environment_id}:disconnect

Path parameters

account_idstring required

The Account Id

environment_idstring required

The Environment Id

Request body

forceboolean

Disconnect the environment even if snapshotting fails (e.g. due to pod failure). This flag should only be used if you are certain that the pod is gone.

resetSnapshotsboolean

Forces snapshots to be rebuilt. This can be used when there are too many snapshot layers or when an unforeseen snapshotting logic error has occurred.

Response

A successful response.

object required

Changes

Changed in 1 of the 27 revisions of this API.3

  • 311efdb2fa573See the full diff
    • ○

      the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • ○

      api tag gateway.openapi_Gateway added

      api-tag-added

    • ○

      api tag Gateway removed

      api-tag-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog