The Things Network / The Things Stack AsEndDeviceRegistry API

openapi: 3.2.0
info:
  title: Things Stack — Application Server AppAs As End Device Registry API
  version: v3.36
  description: The Things Stack is an open-source LoRaWAN Network Server implementation. This OpenAPI was derived from the upstream gRPC-Gateway generated api.swagger.json published by TheThingsNetwork/lorawan-stack v3.36.
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    name: The Things Industries
    url: https://www.thethingsindustries.com
servers:
- url: https://eu1.cloud.thethings.industries/api/v3
security:
- ApiKeyAuth: []
tags:
- name: AsEndDeviceRegistry
paths:
  /as/applications/{application_ids.application_id}/devices/{device_id}:
    delete:
      summary: 'Delete deletes the device that matches the given identifiers.

        If there are multiple matches, an error will be returned.'
      operationId: AsEndDeviceRegistry_Delete
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                type: object
                properties: {}
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: application_ids.application_id
        in: path
        required: true
        schema:
          type: string
      - name: device_id
        in: path
        required: true
        schema:
          type: string
      - name: dev_eui
        description: The LoRaWAN DevEUI.
        in: query
        required: false
        schema:
          type: string
          format: string
      - name: join_eui
        description: The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).
        in: query
        required: false
        schema:
          type: string
          format: string
      - name: dev_addr
        description: The LoRaWAN DevAddr.
        in: query
        required: false
        schema:
          type: string
          format: string
      tags:
      - AsEndDeviceRegistry
  /as/applications/{end_device.ids.application_ids.application_id}/devices:
    post:
      summary: Set creates or updates the device.
      operationId: AsEndDeviceRegistry_Set2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3EndDevice'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: end_device.ids.application_ids.application_id
        in: path
        required: true
        schema:
          type: string
      tags:
      - AsEndDeviceRegistry
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v3AsEndDeviceRegistrySetBody'
        required: true
  /as/applications/{end_device.ids.application_ids.application_id}/devices/{end_device.ids.device_id}:
    put:
      summary: Set creates or updates the device.
      operationId: AsEndDeviceRegistry_Set
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3EndDevice'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: end_device.ids.application_ids.application_id
        in: path
        required: true
        schema:
          type: string
      - name: end_device.ids.device_id
        in: path
        required: true
        schema:
          type: string
      tags:
      - AsEndDeviceRegistry
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v3AsEndDeviceRegistrySetBody'
        required: true
  /as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}:
    get:
      summary: 'Get returns the device that matches the given identifiers.

        If there are multiple matches, an error will be returned.'
      operationId: AsEndDeviceRegistry_Get
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3EndDevice'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: end_device_ids.application_ids.application_id
        in: path
        required: true
        schema:
          type: string
      - name: end_device_ids.device_id
        in: path
        required: true
        schema:
          type: string
      - name: end_device_ids.dev_eui
        description: The LoRaWAN DevEUI.
        in: query
        required: false
        schema:
          type: string
          format: string
      - name: end_device_ids.join_eui
        description: The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).
        in: query
        required: false
        schema:
          type: string
          format: string
      - name: end_device_ids.dev_addr
        description: The LoRaWAN DevAddr.
        in: query
        required: false
        schema:
          type: string
          format: string
      - name: field_mask
        description: 'The names of the end device fields that should be returned.

          See the API reference for which fields can be returned by the different services.'
        in: query
        required: false
        schema:
          type: string
      tags:
      - AsEndDeviceRegistry
components:
  schemas:
    MACCommandRekeyConf:
      type: object
      properties:
        minor_version:
          $ref: '#/components/schemas/v3Minor'
    ApplicationDownlinkConfirmedRetry:
      type: object
      properties:
        attempt:
          type: integer
          format: int64
          description: The number of attempted confirmed downlink acknowledgements.
        max_attempts:
          type: integer
          format: int64
          description: 'The maximum number of confirmed downlink acknowledgement attempts.

            If null, the Application Server configuration is used instead.'
    v3ADRSettingsDisabledMode:
      type: object
      description: 'Configuration options for cases in which ADR is to be disabled

        completely.'
    MACCommandRelayEndDeviceConfReq:
      type: object
      properties:
        configuration:
          $ref: '#/components/schemas/MACCommandRelayEndDeviceConfReqConfiguration'
    v3ADRAckLimitExponentValue:
      type: object
      properties:
        value:
          $ref: '#/components/schemas/v3ADRAckLimitExponent'
    v3PowerState:
      type: string
      enum:
      - POWER_UNKNOWN
      - POWER_BATTERY
      - POWER_EXTERNAL
      default: POWER_UNKNOWN
      description: Power state of the device.
    ApplicationDownlinkClassBC:
      type: object
      properties:
        gateways:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/v3ClassBCGatewayIdentifiers'
          description: 'Possible gateway identifiers, antenna index, and group index to use for this downlink message.

            The Network Server selects one of these gateways for downlink, based on connectivity, signal quality, channel utilization and an available slot.

            If none of the gateways can be selected, the downlink message fails.

            If empty, a gateway and antenna is selected automatically from the gateways seen in recent uplinks.

            If group index is set, gateways will be grouped by the index for the Network Server to select one gateway per group.'
        absolute_time:
          type: string
          format: date-time
          description: 'Absolute time when the downlink message should be transmitted.

            This requires the gateway to have GPS time synchronization.

            If the time is in the past or if there is a scheduling conflict, the downlink message fails.

            If null, the time is selected based on slot availability. This is recommended in class B mode.'
    v3JoinRequestPayload:
      type: object
      properties:
        join_eui:
          type: string
          format: string
          example: 70B3D57ED000ABCD
        dev_eui:
          type: string
          format: string
          example: 70B3D57ED000ABCD
        dev_nonce:
          type: string
          format: string
          example: ABCD
    DynamicModeOverrides:
      type: object
      properties:
        data_rate_0:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_1:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_2:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_3:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_4:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_5:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_6:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_7:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_8:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_9:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_10:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_11:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_12:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_13:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_14:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
        data_rate_15:
          $ref: '#/components/schemas/DynamicModePerDataRateIndexOverride'
      description: 'EXPERIMENTAL: Configuration overrides.'
    v3ADRAckDelayExponentValue:
      type: object
      properties:
        value:
          $ref: '#/components/schemas/v3ADRAckDelayExponent'
    v3Picture:
      type: object
      properties:
        embedded:
          $ref: '#/components/schemas/PictureEmbedded'
          description: 'Embedded picture.

            Omitted if there are external URLs available (in sizes).'
        sizes:
          type: object
          additionalProperties:
            type: string
          description: URLs of the picture for different sizes, if available on a CDN.
    v3AggregatedDutyCycleValue:
      type: object
      properties:
        value:
          $ref: '#/components/schemas/v3AggregatedDutyCycle'
    MACCommandRxTimingSetupReq:
      type: object
      properties:
        delay:
          $ref: '#/components/schemas/v3RxDelay'
    v3KeyEnvelope:
      type: object
      properties:
        key:
          type: string
          format: string
          example: 0123456789ABCDEF0123456789ABCDEF
          description: The unencrypted AES key.
        kek_label:
          type: string
          description: The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.
        encrypted_key:
          type: string
          format: byte
    MACCommandRelayUpdateUplinkListReq:
      type: object
      properties:
        rule_index:
          type: integer
          format: int64
        forward_limits:
          $ref: '#/components/schemas/v3RelayUplinkForwardLimits'
        dev_addr:
          type: string
          format: string
          example: 2600ABCD
        w_f_cnt:
          type: integer
          format: int64
        root_wor_s_key:
          type: string
          format: string
          example: 0123456789ABCDEF0123456789ABCDEF
        device_id:
          type: string
        session_key_id:
          type: string
          format: byte
    v3RejoinCountExponent:
      type: string
      enum:
      - REJOIN_COUNT_16
      - REJOIN_COUNT_32
      - REJOIN_COUNT_64
      - REJOIN_COUNT_128
      - REJOIN_COUNT_256
      - REJOIN_COUNT_512
      - REJOIN_COUNT_1024
      - REJOIN_COUNT_2048
      - REJOIN_COUNT_4096
      - REJOIN_COUNT_8192
      - REJOIN_COUNT_16384
      - REJOIN_COUNT_32768
      - REJOIN_COUNT_65536
      - REJOIN_COUNT_131072
      - REJOIN_COUNT_262144
      - REJOIN_COUNT_524288
      default: REJOIN_COUNT_16
    googlerpcStatus:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/protobufAny'
    v3ApplicationDownlink:
      type: object
      properties:
        session_key_id:
          type: string
          format: byte
          description: Join Server issued identifier for the session keys used by this downlink.
        f_port:
          type: integer
          format: int64
        f_cnt:
          type: integer
          format: int64
        frm_payload:
          type: string
          format: byte
          description: 'The frame payload of the downlink message.

            The payload is encrypted if the skip_payload_crypto field of the EndDevice

            is true.'
        decoded_payload:
          type: object
          description: 'The decoded frame payload of the downlink message.

            When scheduling downlink with a message processor configured for the end device (see formatters) or application (see default_formatters),

            this fields acts as input for the downlink encoder, and the output is set to frm_payload.

            When reading downlink (listing the queue, downlink message events, etc), this fields acts as output of the downlink decoder, and the input is frm_payload.'
        decoded_payload_warnings:
          type: array
          items:
            type: string
          description: Warnings generated by the message processor while encoding frm_payload (scheduling downlink) or decoding the frm_payload (reading downlink).
        confirmed:
          type: boolean
        class_b_c:
          $ref: '#/components/schemas/ApplicationDownlinkClassBC'
          description: 'Optional gateway and timing information for class B and C.

            If set, this downlink message will only be transmitted as class B or C downlink.

            If not set, this downlink message may be transmitted in class A, B and C.'
        priority:
          $ref: '#/components/schemas/v3TxSchedulePriority'
          description: Priority for scheduling the downlink message.
        correlation_ids:
          type: array
          items:
            type: string
        confirmed_retry:
          $ref: '#/components/schemas/ApplicationDownlinkConfirmedRetry'
        locations:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/lorawanv3Location'
          description: End device location metadata, set by the Application Server while handling the message.
        version_ids:
          $ref: '#/components/schemas/v3EndDeviceVersionIdentifiers'
          description: End device version identifiers, set by the Application Server while handling the message.
        network_ids:
          $ref: '#/components/schemas/v3NetworkIdentifiers'
          description: Network identifiers, set by the Network Server that handles the message.
        attributes:
          type: object
          additionalProperties:
            type: string
          description: Attributes for devices, set by the Application Server while handling the message.
    v3RxDelay:
      type: string
      enum:
      - RX_DELAY_0
      - RX_DELAY_1
      - RX_DELAY_2
      - RX_DELAY_3
      - RX_DELAY_4
      - RX_DELAY_5
      - RX_DELAY_6
      - RX_DELAY_7
      - RX_DELAY_8
      - RX_DELAY_9
      - RX_DELAY_10
      - RX_DELAY_11
      - RX_DELAY_12
      - RX_DELAY_13
      - RX_DELAY_14
      - RX_DELAY_15
      default: RX_DELAY_0
      description: " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds."
    v3Minor:
      type: string
      enum:
      - MINOR_RFU_0
      - MINOR_1
      - MINOR_RFU_2
      - MINOR_RFU_3
      - MINOR_RFU_4
      - MINOR_RFU_5
      - MINOR_RFU_6
      - MINOR_RFU_7
      - MINOR_RFU_8
      - MINOR_RFU_9
      - MINOR_RFU_10
      - MINOR_RFU_11
      - MINOR_RFU_12
      - MINOR_RFU_13
      - MINOR_RFU_14
      - MINOR_RFU_15
      default: MINOR_RFU_0
    DownlinkMessageMessageMHDR:
      type: object
      properties:
        m_type:
          $ref: '#/components/schemas/v3MType'
    v3Session:
      type: object
      properties:
        dev_addr:
          type: string
          format: string
          example: 2600ABCD
          description: 'Device Address, issued by the Network Server or chosen by device manufacturer in case of testing range (beginning with 00-03).

            Known by Network Server, Application Server and Join Server. Owned by Network Server.'
        keys:
          $ref: '#/components/schemas/v3SessionKeys'
        last_f_cnt_up:
          type: integer
          format: int64
          description: Last uplink frame counter value used. Network Server only. Application Server assumes the Network Server checked it.
        last_n_f_cnt_down:
          type: integer
          format: int64
          description: Last network downlink frame counter value used. Network Server only.
        last_a_f_cnt_down:
          type: integer
          format: int64
          description: Last application downlink frame counter value used. Application Server only.
        last_conf_f_cnt_down:
          type: integer
          format: int64
          description: Frame counter of the last confirmed downlink message sent. Network Server only.
        started_at:
          type: string
          format: date-time
          description: Time when the session started. Network Server only.
        queued_application_downlinks:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/v3ApplicationDownlink'
          description: Queued Application downlink messages. Stored in Application Server and Network Server.
    v3DeviceEIRP:
      type: string
      enum:
      - DEVICE_EIRP_8
      - DEVICE_EIRP_10
      - DEVICE_EIRP_12
      - DEVICE_EIRP_13
      - DEVICE_EIRP_14
      - DEVICE_EIRP_16
      - DEVICE_EIRP_18
      - DEVICE_EIRP_20
      - DEVICE_EIRP_21
      - DEVICE_EIRP_24
      - DEVICE_EIRP_26
      - DEVICE_EIRP_27
      - DEVICE_EIRP_29
      - DEVICE_EIRP_30
      - DEVICE_EIRP_33
      - DEVICE_EIRP_36
      default: DEVICE_EIRP_8
      description: " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm."
    MACCommandPingSlotChannelReq:
      type: object
      properties:
        frequency:
          type: string
          format: uint64
          description: Ping slot channel frequency (Hz).
        data_rate_index:
          $ref: '#/components/schemas/v3DataRateIndex'
    MACCommandTxParamSetupReq:
      type: object
      properties:
        max_eirp_index:
          $ref: '#/components/schemas/v3DeviceEIRP'
          title: 'Indicates the maximum EIRP value in dBm, indexed by the following vector:

            [ 8 10 12 13 14 16 18 20 21 24 26 27 29 30 33 36 ]'
        uplink_dwell_time:
          type: boolean
        downlink_dwell_time:
          type: boolean
    v3MessagePayloadFormatters:
      type: object
      properties:
        up_formatter:
          $ref: '#/components/schemas/v3PayloadFormatter'
          description: Payload formatter for uplink messages, must be set together with its parameter.
        up_formatter_parameter:
          type: string
          description: Parameter for the up_formatter, must be set together. The API enforces a maximum length of 64KB, but the size may be restricted further by deployment configuration.
        down_formatter:
          $ref: '#/components/schemas/v3PayloadFormatter'
          description: Payload formatter for downlink messages, must be set together with its parameter.
        down_formatter_parameter:
          type: string
          description: Parameter for the down_formatter, must be set together. The API enforces a maximum length of 64KB, but the size may be restricted further by deployment configuration.
    DownlinkMessageMessageMACPayload:
      type: object
      properties:
        f_port:
          type: integer
          format: int64
        full_f_cnt:
          type: integer
          format: int64
    MACCommandLinkCheckAns:
      type: object
      properties:
        margin:
          type: integer
          format: int64
          description: Indicates the link margin in dB of the received LinkCheckReq, relative to the demodulation floor.
        gateway_count:
          type: integer
          format: int64
    MACCommandDutyCycleReq:
      type: object
      properties:
        max_duty_cycle:
          $ref: '#/components/schemas/v3AggregatedDutyCycle'
    MACCommandBeaconFreqAns:
      type: object
      properties:
        frequency_ack:
          type: boolean
    v3ADRSettings:
      type: object
      properties:
        static:
          $ref: '#/components/schemas/ADRSettingsStaticMode'
        dynamic:
          $ref: '#/components/schemas/ADRSettingsDynamicMode'
        disabled:
          $ref: '#/components/schemas/v3ADRSettingsDisabledMode'
      description: Adaptive Data Rate settings.
    v3DownlinkPathConstraint:
      type: string
      enum:
      - DOWNLINK_PATH_CONSTRAINT_NONE
      - DOWNLINK_PATH_CONSTRAINT_PREFER_OTHER
      - DOWNLINK_PATH_CONSTRAINT_NEVER
      default: DOWNLINK_PATH_CONSTRAINT_NONE
      description: " - DOWNLINK_PATH_CONSTRAINT_NONE: Indicates that the gateway can be selected for downlink without constraints by the Network Server.\n - DOWNLINK_PATH_CONSTRAINT_PREFER_OTHER: Indicates that the gateway can be selected for downlink only if no other or better gateway can be selected.\n - DOWNLINK_PATH_CONSTRAINT_NEVER: Indicates that this gateway will never be selected for downlink, even if that results in no available downlink path."
    MACCommandRelayEndDeviceConfReqConfiguration:
      type: object
      properties:
        always:
          $ref: '#/components/schemas/v3RelayEndDeviceAlwaysMode'
        dynamic:
          $ref: '#/components/schemas/v3RelayEndDeviceDynamicMode'
        end_device_controlled:
          $ref: '#/components/schemas/v3RelayEndDeviceControlledMode'
        backoff:
          type: integer
          format: int64
        second_channel:
          $ref: '#/components/schemas/v3RelaySecondChannel'
        serving_device_id:
          type: string
    v3RejoinRequestPayload:
      type: object
      properties:
        rejoin_type:
          $ref: '#/components/schemas/v3RejoinRequestType'
        net_id:
          type: string
          format: string
          example: '000013'
        join_eui:
          type: string
          format: string
          example: 70B3D57ED000ABCD
        dev_eui:
          type: string
          format: string
          example: 70B3D57ED000ABCD
        rejoin_cnt:
          type: integer
          format: int64
          description: Contains RJCount0 or RJCount1 depending on rejoin_type.
    v3EndDeviceAuthenticationCode:
      type: object
      properties:
        value:
          type: string
        valid_from:
          type: string
          format: date-time
        valid_to:
          type: string
          format: date-time
      description: Authentication code for end devices.
    ChannelSteeringSettingsLoRaNarrowMode:
      type: object
      description: 'Configuration options for LoRa narrow channels steering.

        The narrow mode attempts to steer the end device towards

        using the LoRa modulated, 125kHz bandwidth channels.'
    v3RejoinTimeExponent:
      type: string
      enum:
      - REJOIN_TIME_0
      - REJOIN_TIME_1
      - REJOIN_TIME_2
      - REJOIN_TIME_3
      - REJOIN_TIME_4
      - REJOIN_TIME_5
      - REJOIN_TIME_6
      - REJOIN_TIME_7
      - REJOIN_TIME_8
      - REJOIN_TIME_9
      - REJOIN_TIME_10
      - REJOIN_TIME_11
      - REJOIN_TIME_12
      - REJOIN_TIME_13
      - REJOIN_TIME_14
      - REJOIN_TIME_15
      default: REJOIN_TIME_0
      description: " - REJOIN_TIME_0: Every ~17.1 minutes.\n - REJOIN_TIME_1: Every ~34.1 minutes.\n - REJOIN_TIME_2: Every ~1.1 hours.\n - REJOIN_TIME_3: Every ~2.3 hours.\n - REJOIN_TIME_4: Every ~4.6 hours.\n - REJOIN_TIME_5: Every ~9.1 hours.\n - REJOIN_TIME_6: Every ~18.2 hours.\n - REJOIN_TIME_7: Every ~1.5 days.\n - REJOIN_TIME_8: Every ~3.0 days.\n - REJOIN_TIME_9: Every ~6.1 days.\n - REJOIN_TIME_10: Every ~12.1 days.\n - REJOIN_TIME_11: Every ~3.5 weeks.\n - REJOIN_TIME_12: Every ~1.6 months.\n - REJOIN_TIME_13: Every ~3.2 months.\n - REJOIN_TIME_14: Every ~6.4 months.\n - REJOIN_TIME_15: Every ~1.1 year."
    ADRSettingsDynamicMode:
      type: object
      properties:
        margin:
          type: number
          format: float
          description: 'The ADR margin (dB) tells the network server how much margin it should add in ADR requests.

            A bigger margin is less efficient, but gives a better chance of successful reception.

            If unset, the default value from Network Server configuration will be used.'
        min_data_rate_index:
          $ref: '#/components/schemas/v3DataRateIndexValue'
          description: 'Minimum data rate index.

            If unset, the default value from Network Server configuration will be used.'
        max_data_rate_index:
          $ref: '#/components/schemas/v3DataRateIndexValue'
          description: 'Maximum data rate index.

            If unset, the default value from Network Server configuration will be used.'
        min_tx_power_index:
          type: integer
          format: int64
          description: 'Minimum transmission power index.

            If unset, the default value from Network Server configuration will be used.'
        max_tx_power_index:
          type: integer
          format: int64
          description: 'Maximum transmission power index.

            If unset, the default value from Network Server configuration will be used.'
        min_nb_trans:
          type: integer
          format: int64
          description: 'Minimum number of retransmissions.

            If unset, the default value from Network Server configuration will be used.'
        max_nb_trans:
          type: integer
          format: int64
          description: 'Maximum number of retransmissions.

            If unset, the default value from Network Server configuration will be used.'
        channel_steering:
          $ref: '#/components/schemas/DynamicModeChannelSteeringSettings'
        overrides:
          $ref: '#/components/schemas/DynamicModeOverrides'
      description: Configuration options for dynamic ADR.
    MACCommandPingSlotInfoReq:
      type: object
      properties:
        period:
          $ref: '#/components/schemas/v3PingSlotPeriod'
    MACCommandRelayCtrlUplinkListReq:
      type: object
      properties:
        rule_index:
          type: integer
          format: int64
        action:
          $ref: '#/components/schemas/v3RelayCtrlUplinkListAction'
    MACCommandNewChannelAns:
      type: object
      properties:
        frequency_ack:
          type: boolean
        data_rate_ack:
          type: boolean
    MACCommandDevStatusAns:
      type: object
      properties:
        battery:
          type: integer
          format: int64
          description: 'Device battery status.

            0 indicates that the device is connected to an external power source.

            1..254 indicates a battery level.

            255 indicates that the device was not able to measure the battery level.'
        margin:
          type: integer
          format: int32
          description: SNR of the last downlink (dB; [-32, +31]).
    UplinkMessageRxMetadataRelayMetadata:
      type: object
    v3SessionKeys:
      type: object
      properties:
        session_key_id:
          type: string
          format: byte
          description: 'Join Server issued identifier for the session keys.

            This ID can be used to request the keys from the Join Server in case the are lost.'
        f_nwk_s_int_key:
          $ref: '#/components/schemas/v3KeyEnvelope'
          description: 'The (encrypted) Forwarding Network Session Integrity Key (or Network Session Key in 1.0 compatibility mode).

            This key is stored by the (forwarding) Network Server.'
        s_nwk_s_int_key:
          $ref: '#/components/schemas/v3KeyEnvelope'
          description: 'The (encrypted) Serving Network Session Integrity Key.

            This key is stored by the (serving) Network Server.'
        nwk_s_enc_key:
          $ref: '#/components/schemas/v3KeyEnvelope'
          description: 'The (encrypted) Network Session Encryption Key.

            This key is stored by the (serving) Network Server.'
        app_s_key:
          $ref: '#/components/schemas/v3KeyEnvelope'
          description: 'The (encrypted) Application Session Key.

            This key is stored by the Application Server.'
      description: 'Session keys for a LoRaWAN session.

        Only the components for which the keys were meant, will have the key-encryption-key (KEK) to decrypt the individual keys.'
    v3DataRateIndex:
      type: string
      enum:
      - DATA_RATE_0
      - DATA_RATE_1
      - DATA_RATE_2
      - DATA_RATE_3
      - DATA_RATE_4
      - DATA_RATE_5
      - DATA_RATE_6
      - DATA_RATE_7
      - DATA_RATE_8
      - DATA_RATE_9
      - DATA_RATE_10
      - DATA_RATE_11
      - DATA_RATE_12
      - DATA_RATE_13
      - DATA_RATE_14
      - DATA_RATE_15
      default: DATA_RATE_0
    v3RelayForwardDownlinkReq:
      type: object
      properties:
        raw_payload:
          type: string
          format: byte
    MACStateUplinkMessageRxMetadata:
      type: object
      properties:
        gateway_ids:
          $ref: '#/components/schemas/lorawanv3GatewayIdentifiers'
        channel_rssi:
          type: number
          format: float
        snr:
          type: number
          format: float
        downlink_path_constraint:
          $ref: '#/components/schemas/v3DownlinkPathConstraint'
        uplink_token:
          type: string
          format: byte
        packet_broker:
          $ref: '#/components/schemas/UplinkMessageRxMetadataPacketBrokerMetadata'
        relay:
          $ref: '#/components/schemas/UplinkMessageRxMetadataRelayMetadata'
    MACCommandLinkADRReq:
      type: object
      properties:
        data_rate_index:
          $ref: '#/components/schemas/v3DataRateIndex'
        tx_power_index:
          type: integer
          format: int64
        channel_mask:
          type: array
          items:
            type: boolean
        channel_mask_control:
          type: integer
          format: int64
        nb_trans:
          type: integer
          format: int64
    v3JoinAcceptPayload:
      type: object
      properties:
        encrypted:
          type:

# --- truncated at 32 KB (128 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/openapi/the-things-network-asenddeviceregistry-api-openapi.yml