v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1450250256.2 KB

Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.

delete/v1/gateway-instances/{gatewayInstanceArn}

Path parameters

gatewayInstanceArnstring required

The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister.

Query parameters

forceboolean

Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.

Response

Success

GatewayInstanceArnstring

The Amazon Resource Name (ARN) of the instance.

InstanceState'REGISTERING' | 'ACTIVE' | 'DEREGISTERING' | 'DEREGISTERED' | 'REGISTRATION_ERROR' | 'DEREGISTRATION_ERROR'

The status of the instance.