DELETE

/v1/gateway-instances/{gatewayInstanceArn}

http://mediaconnect.{region}.amazonaws.com/v1/gateway-instances/{gatewayInstanceArn}

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.

Access Token Required: API Key

Path Parameters

gatewayInstanceArnstringrequired

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

Query Params

forceboolean

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'http://mediaconnect.{region}.amazonaws.com/v1/gateway-instances/{gatewayInstanceArn}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}