---
title: "GET /gateway/{gatewayId}/links/"
method: GET
path: "/gateway/{gatewayId}/links/"
---

# GET /gateway/{gatewayId}/links/

`GET /gateway/{gatewayId}/links/`

Lists links associated with gateways.

Returns a list of all links for the specified gateways, including their status and configuration details.

## Path parameters

- `gatewayId` string, required

## Query parameters

- `nextToken` string
- `maxResults` integer

## Response `200`

Success

- ListLinksResponse
  - `links` ListLinksResponseStructure[] — Information about created links.
    - `gatewayId` string, required — The unique identifier of the gateway.
    - `peerGatewayId` string, 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.
    - `createdAt` string, date-time, required — The timestamp of when the link was created.
    - `updatedAt` string, date-time, required — The timestamp of when the link was updated.
    - `direction` 'RESPONSE' | 'REQUEST' — The direction of the link.
    - `flowModules` ModuleConfiguration[] — Describes the configuration of flow modules.
      - `version` string — The version of the module.
      - `name` string, required — The name of the module.
      - `dependsOn` FlowModuleName[] — The dependencies of the module.
      - `moduleParameters` object — Describes the parameters of a module.
        - `noBid` object — Describes the parameters of a no bid module.
          - `reason` string — The reason description.
          - `reasonCode` integer — The reason code.
          - `passThroughPercentage` number, float — The pass through percentage.
        - `openRtbAttribute` object — Describes the parameters of an open RTB attribute module.
          - `filterType` 'INCLUDE' | 'EXCLUDE', required — The filter type.
          - `filterConfiguration` Filter[], required — Describes the configuration of a filter.
            - `criteria` FilterCriterion[], required — Describes the criteria for a filter.
              - …
          - `action` object, required — Describes a bid action.
            - `noBid` object — Describes a no bid action.
              - …
            - `headerTag` object — Describes the header tag for a bid action.
              - …
          - `holdbackPercentage` number, float, required — The hold back percentage.
        - `rateLimiter` object — Describes the parameters of a rate limit.
          - `tps` number, float — The transactions per second rate limit.
    - `pendingFlowModules` ModuleConfiguration[] — Describes the configuration of pending flow modules.
      - `version` string — The version of the module.
      - `name` string, required — The name of the module.
      - `dependsOn` FlowModuleName[] — The dependencies of the module.
      - `moduleParameters` object — Describes the parameters of a module.
        - `noBid` object — Describes the parameters of a no bid module.
          - `reason` string — The reason description.
          - `reasonCode` integer — The reason code.
          - `passThroughPercentage` number, float — The pass through percentage.
        - `openRtbAttribute` object — Describes the parameters of an open RTB attribute module.
          - `filterType` 'INCLUDE' | 'EXCLUDE', required — The filter type.
          - `filterConfiguration` Filter[], required — Describes the configuration of a filter.
            - `criteria` FilterCriterion[], required — Describes the criteria for a filter.
              - …
          - `action` object, required — Describes a bid action.
            - `noBid` object — Describes a no bid action.
              - …
            - `headerTag` object — Describes the header tag for a bid action.
              - …
          - `holdbackPercentage` number, float, required — The hold back percentage.
        - `rateLimiter` object — Describes the parameters of a rate limit.
          - `tps` number, float — The transactions per second rate limit.
    - `attributes` object — Describes attributes of a link.
      - `responderErrorMasking` ResponderErrorMaskingForHttpCode[] — Describes the masking for HTTP error codes.
        - `httpCode` string, required — The HTTP error code.
        - `action` 'NO_BID' | 'PASSTHROUGH', required — The action for the error..
        - `loggingTypes` ResponderErrorMaskingLoggingType[], required — The error log type.
        - `responseLoggingPercentage` number, float — The percentage of response logging.
      - `customerProvidedId` string — The customer-provided unique identifier of the link.
    - `logSettings` LinkLogSettings — Describes the settings for a link log.
      - `applicationLogs` object, required — Describes the configuration of a link application log.
        - `sampling` object, required — Describes a link application log sample.
          - `errorLog` number, double, required — An error log entry.
          - `filterLog` number, double, required — A filter log entry.
    - `connectivityType` 'DEFAULT' | 'PUBLIC_INGRESS' | 'PUBLIC_EGRESS' | 'EXTERNAL_INBOUND' — The connectivity type of the link.
    - `linkId` string, required — The unique identifier of the link.
    - `tags` object — A map of the key-value pairs of the tag or tags to assign to the resource.
    - `publicEndpoint` string — The public endpoint of the outbound link.
  - `nextToken` string — If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken error</i>.

## Other responses

- `480` — ResourceNotFoundException
- `481` — ThrottlingException
- `482` — AccessDeniedException
- `483` — InternalServerException
- `484` — ValidationException

---

[API](https://skmtc.net/aws/apis/rtbfabric.md) · [All operations](https://skmtc.net/aws/apis/rtbfabric/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/rtbfabric/versions/9fa17cecba3a/schema)