Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1436208157.4 KB

Retrieves information about a link between gateways.

Returns detailed information about the link configuration, status, and associated gateways.

get/gateway/{gatewayId}/link/{linkId}

Path parameters

gatewayIdstring required

The unique identifier of the gateway.

linkIdstring required

The unique identifier of the link.

Response

Success

gatewayIdstring required

The unique identifier of the gateway.

peerGatewayIdstring required

The unique identifier of the peer gateway.

status'PENDING_CREATION' | 'PENDING_REQUEST' | 'REQUESTED' | 'ACCEPTED' | 'ACTIVE' | 'REJECTED' | 'FAILED' | 'PENDING_DELETION' | 'DELETED' | 'PENDING_UPDATE' | 'PENDING_ISOLATION' | 'ISOLATED' | 'PENDING_RESTORATION' required

The status of the link.

createdAtstring date-time required

The timestamp of when the link was created.

updatedAtstring date-time required

The timestamp of when the link was updated.

direction'RESPONSE' | 'REQUEST'

The direction of the link.

connectivityType'DEFAULT' | 'PUBLIC_INGRESS' | 'PUBLIC_EGRESS' | 'EXTERNAL_INBOUND'

The connectivity type of the link.

linkIdstring required

The unique identifier of the link.

tagsobject

A map of the key-value pairs for the tag or tags assigned to the specified resource.

httpResponderAllowedboolean

Boolean to specify if an HTTP responder is allowed.

timeoutInMillisinteger

The timeout value in milliseconds.