Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1436208157.4 KB

Creates a new link between gateways.

Establishes a connection that allows gateways to communicate and exchange bid requests and responses.

post/gateway/{gatewayId}/create-link

Path parameters

gatewayIdstring required

The unique identifier of the gateway.

Request body

peerGatewayIdstring required

The unique identifier of the peer gateway.

httpResponderAllowedboolean

Boolean to specify if an HTTP responder is allowed.

tagsobject

A map of the key-value pairs of the tag or tags to assign to the resource.

timeoutInMillisinteger

The timeout value in milliseconds.

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 request.

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.

customerProvidedIdstring

The customer-provided unique identifier of the link.