/

The AWS IoT Secure Tunneling multi-region endpoint

http://api.tunneling.iot.{region}.amazonaws.com

POST

Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.

Requires permission to access the CloseTunnel action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://api.tunneling.iot.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tunnelId": "string",
    "delete": true
}'

Response Example

200 - Example 1

{}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

tunnelId

string

required

The ID of the tunnel to close.

Match pattern:

[a-zA-Z0-9_\-+=:]{1,128}

delete

boolean

optional

When set to true, IoT Secure Tunneling deletes the tunnel data immediately.

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480ResourceNotFoundException

Modified at 2023-08-16 07:32:16