Update Tunnel Status.

POST

/api/infraprotect/namespaces/{namespace}/infraprotect_tunnels/update-tunnel-status

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/infraprotect/namespaces/example/infraprotect_tunnels/update-tunnel-status \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "namespace": "example", "tunnel_id": "example", "tunnel_status": "TUNNEL_STATUS_INACTIVE" }'

• F5 Distributed Cloud Console

Update Tunnel Status.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace

x-required Namespace in which the tunnel status is to be updated.

Request Body^required

Media typeapplication/json

Update Tunnel Status

Request to update tunnel status.

object

namespace

Namespace

Namespace in which the tunnel status is to be updated.

string

>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/

tunnel_id

Tunnel identifier

Unique identifier of the tunnel to update.

string

<= 1024 characters

tunnel_status

string

default: TUNNEL_STATUS_INACTIVE

Allowed values: TUNNEL_STATUS_INACTIVE TUNNEL_STATUS_DOWN TUNNEL_STATUS_ACTIVE TUNNEL_STATUS_ACTIVATION_PENDING TUNNEL_STATUS_ACTIVATION_ERROR TUNNEL_STATUS_ACTIVATION_INITIALIZING

Responses

200

A successful response.

Media typeapplication/json

Update Tunnel Status Response

Response returned from a tunnel status update.

object

Example^generated

{}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example