---
title: "List Event Gateway signals"
url: "https://nov18-dev.movespot.fyi/apis/gateway-admin-signals-dev-0/versions/e2254c09-056a-40a6-96db-b4f4a9e798b8/operations/ListEventGatewaySignals"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/gateway-admin-signals-dev-0/versions/e2254c09-056a-40a6-96db-b4f4a9e798b8.md

# List Event Gateway signals

`GET` `/event-gateway-signals/{gatewayId}`

Operation ID: `ListEventGatewaySignals`

DP-initiated signal fetch. The DP supplies: - `X-Node-Id` and `X-Node-Version` as HTTP headers - `capabilities` as a deepObject query parameter: - Keys are capability names (e.g. `config_sync`) - Values contain the capability request fields (`version`, optional `offset`) Example: GET /event-gateway-signals/{gatewayId}?capabilities[config_sync][version]=v1&capabilities[config_sync][offset]=v0.0 X-Node-Id: 226db49d-0198-4bc5-ab74-8bb4f5de3a43 X-Node-Version: 1.0.0 The CP responds with a JSON payload containing zero or more signals that the DP should process. If no signals are available, the CP responds with HTTP 304 Not Modified.

## Path parameters

- `gatewayId` (string, uuid, required)

## Query parameters

- `capabilities` (object, optional) - Capability requests as a deepObject map. - Keys are capability names (e.g. `config_sync`). - Values contain the capability request fields (`version`, optional `offset`).

## Header parameters

- `X-Node-Id` (string, uuid, required)
- `X-Node-Version` (string, required)

## Responses

- `200` - The gateway signals response.
- `304` - No signals available (DP is up to date)
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Gateway Admin Signals
  version: 0.1.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /event-gateway-signals/{gatewayId}:
    get:
      operationId: ListEventGatewaySignals
      summary: List Event Gateway signals
      description: >
        DP-initiated signal fetch.


        The DP supplies:
          - `X-Node-Id` and `X-Node-Version` as HTTP headers
          - `capabilities` as a deepObject query parameter:
              - Keys are capability names (e.g. `config_sync`)
              - Values contain the capability request fields (`version`, optional `offset`)

        Example:
          GET /event-gateway-signals/{gatewayId}?capabilities[config_sync][version]=v1&capabilities[config_sync][offset]=v0.0
          X-Node-Id: 226db49d-0198-4bc5-ab74-8bb4f5de3a43
          X-Node-Version: 1.0.0

        The CP responds with a JSON payload containing zero or more signals that
        the DP should process.

        If no signals are available, the CP responds with HTTP 304 Not Modified.
      parameters:
        - $ref: "#/components/parameters/GatewayId"
        - $ref: "#/components/parameters/NodeId"
        - $ref: "#/components/parameters/NodeVersion"
        - $ref: "#/components/parameters/Capabilities"
      responses:
        "200":
          $ref: "#/components/responses/EventGatewaySignalsResponse"
        "304":
          description: No signals available (DP is up to date)
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Signals API
components:
  parameters:
    GatewayId:
      name: gatewayId
      in: path
      required: true
      schema:
        description: The ID of the gateway.
        type: string
        format: uuid
    NodeId:
      name: X-Node-Id
      in: header
      required: true
      schema:
        description: The ID of the node.
        type: string
        format: uuid
    NodeVersion:
      name: X-Node-Version
      in: header
      required: true
      schema:
        description: The string representation of the node version.
        type: string
    Capabilities:
      name: capabilities
      in: query
      style: deepObject
      explode: true
      description: >
        Capability requests as a deepObject map.


        - Keys are capability names (e.g. `config_sync`).

        - Values contain the capability request fields (`version`, optional
        `offset`).
      schema:
        $ref: "#/components/schemas/CapabilitiesMap"
      example:
        config_sync:
          version: v1
          offset: v0.0
  responses:
    EventGatewaySignalsResponse:
      description: The gateway signals response.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/EventGatewaySignals"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
  schemas:
    CapabilitiesMap:
      description: |
        Map of capability name -> capability request fields.

        Example:
          {
            "config_sync": { "version": "v1", "offset": "v0.0" }
          }
      type: object
      additionalProperties:
        $ref: "#/components/schemas/CapabilityRequest"
    EventGatewaySignals:
      description: The gateway signals response.
      type: object
      properties:
        signals:
          description: A list of signals for the gateway.
          type: array
          items:
            $ref: "#/components/schemas/EventGatewaySignal"
      required:
        - signals
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    CapabilityRequest:
      type: object
      properties:
        version:
          description: Capability schema version, such as "v1".
          $ref: "#/components/schemas/CapabilityVersion"
        offset:
          $ref: "#/components/schemas/CapabilityOffset"
      additionalProperties: false
      required:
        - version
    EventGatewaySignal:
      description: A single signal envelope containing exactly one typed capability signal.
      discriminator:
        propertyName: type
        mapping:
          config_sync: "#/components/schemas/ConfigSyncSignalV1"
      oneOf:
        - $ref: "#/components/schemas/ConfigSyncSignalV1"
      x-rust-attrs:
        - "#[derive(derive_more::Display, Debug, Clone, Serialize, Deserialize)]"
        - "#[non_exhaustive]"
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    CapabilityVersion:
      description: Capability-defined monotonic version.
      type: string
      enum:
        - v1
    CapabilityOffset:
      description: Capability-defined monotonic offset.
      type: string
      format: offset
      x-rust-type: String
    ConfigSyncSignalV1:
      description: >
        Signal notifying the DP that config has changed.


        `parameters` contains capability-specific notification details.

        For config_sync, that includes data-channel endpoints the DP can call to
        fetch config.
      allOf:
        - $ref: "#/components/schemas/BaseCapabilityEnvelope"
        - type: object
          x-rust-attrs:
            - "#[derive(Debug, Clone, Serialize, Deserialize)]"
          additionalProperties: false
          required:
            - type
            - version
            - offset
            - parameters
          properties:
            type:
              type: string
              enum:
                - config_sync
              x-rust-attrs:
                - "#[derive(derive_more::Display, Debug, Clone, Serialize,
                  Deserialize)]"
            version:
              type: string
              enum:
                - v1
            parameters:
              $ref: "#/components/schemas/ConfigSyncV1Parameters"
      x-rust-attrs:
        - "#[derive(derive_more::Display, Debug, Clone, Serialize, Deserialize)]"
        - '#[display( "({} {:?} {} {} {})", version, correlation_id, r#type,
          parameters, offset)]'
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    BaseCapabilityEnvelope:
      description: |
        Base envelope for all capability signals.
        Contains fields common to all capability signals.
      type: object
      properties:
        type:
          description: The signal type identifier.
          type: string
        version:
          description: The capability schema version for this signal type.
          type: string
        offset:
          $ref: "#/components/schemas/CapabilityOffset"
        correlation_id:
          description: Optional correlation id for tracing/debugging.
          type: string
        parameters:
          description: Optional map of additional parameters for future use.
          additionalProperties: true
          type: object
      required:
        - type
        - version
        - offset
    ConfigSyncV1Parameters:
      type: object
      properties:
        endpoint_prefix:
          $ref: "#/components/schemas/EndpointPrefixRef"
      additionalProperties: false
      required:
        - endpoint_prefix
      x-rust-attrs:
        - "#[derive(derive_more::Display, Debug, Clone, Serialize, Deserialize)]"
        - '#[display("({:?})", endpoint_prefix)]'
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
    EndpointPrefixRef:
      description: Relative URI the DP should call to interact with capability workers.
      type: string
      example: /v1/event-gateway-data-planes/<cp-id>
      x-rust-type: String
  examples:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
```
