The Things Stack Documentation

https://www.thethingsindustries.com/docs
Admin
The Things Stack is a robust, yet flexible LoRaWAN® Network Server that caters to the needs of...
Tokens:639,659
Snippets:6,931
Trust Score:9.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### MAC Command RxTimingSetupReq Data Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Example of the data field for the ns.mac.rx_timing_setup.request event, indicating an Rx Timing Setup request.

```json
{
  "@type": "type.googleapis.com/ttn.lorawan.v3.MACCommand.RxTimingSetupReq"
}
```

--------------------------------

### ns.mac.tx_param_setup.request

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Tx parameter setup request enqueued. Includes an example of the `data` field.

```APIDOC
## Event ns.mac.tx_param_setup.request

### Description
Tx parameter setup request enqueued.

### Data Example
```json
{
  "@type": "type.googleapis.com/ttn.lorawan.v3.MACCommand.TxParamSetupReq"
}
```
```

--------------------------------

### ns.mac.rx_param_setup.request

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Rx parameter setup request enqueued. Includes an example of the `data` field.

```APIDOC
## Event ns.mac.rx_param_setup.request

### Description
Rx parameter setup request enqueued.

### Data Example
```json
{
  "@type": "type.googleapis.com/ttn.lorawan.v3.MACCommand.RxParamSetupReq"
}
```
```

--------------------------------

### MAC Command RxParamSetupReq Data Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Example of the data field for the ns.mac.rx_param_setup.request event, indicating an Rx Parameter Setup request.

```json
{
  "@type": "type.googleapis.com/ttn.lorawan.v3.MACCommand.RxParamSetupReq"
}
```

--------------------------------

### ns.mac.rejoin_param_setup.request

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Rejoin parameter setup request enqueued. Includes an example of the `data` field.

```APIDOC
## Event ns.mac.rejoin_param_setup.request

### Description
Rejoin parameter setup request enqueued.

### Data Example
```json
{
  "@type": "type.googleapis.com/ttn.lorawan.v3.MACCommand.RejoinParamSetupReq"
}
```
```

--------------------------------

### ns.mac.rx_param_setup.answer.accept

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Rx parameter setup accept received. Includes an example of the `data` field.

```APIDOC
## Event ns.mac.rx_param_setup.answer.accept

### Description
Rx parameter setup accept received.

### Data Example
```json
{
  "@type": "type.googleapis.com/ttn.lorawan.v3.MACCommand.RxParamSetupAns"
}
```
```

--------------------------------

### MAC Command RejoinParamSetupReq Data Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Example of the data field for the ns.mac.rejoin_param_setup.request event, indicating a Rejoin Parameter Setup request.

```json
{
  "@type": "type.googleapis.com/ttn.lorawan.v3.MACCommand.RejoinParamSetupReq"
}
```

--------------------------------

### MAC Command TxParamSetupReq Data Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Example of the data field for the ns.mac.tx_param_setup.request event, indicating a Tx Parameter Setup request.

```json
{
  "@type": "type.googleapis.com/ttn.lorawan.v3.MACCommand.TxParamSetupReq"
}
```

--------------------------------

### ns.mac.rx_timing_setup.request

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Rx timing setup request enqueued. Includes an example of the `data` field.

```APIDOC
## Event ns.mac.rx_timing_setup.request

### Description
Rx timing setup request enqueued.

### Data Example
```json
{
  "@type": "type.googleapis.com/ttn.lorawan.v3.MACCommand.RxTimingSetupReq"
}
```
```

--------------------------------

### MAC Command RejoinParamSetupAns Data Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Example of the data field for the ns.mac.rejoin_param_setup.answer event, representing a Rejoin Parameter Setup answer.

```json
{
  "@type": "type.googleapis.com/ttn.lorawan.v3.MACCommand.RejoinParamSetupAns"
}
```

--------------------------------

### ns.mac.rejoin_param_setup.answer

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Rejoin parameter setup answer received. Includes an example of the `data` field.

```APIDOC
## Event ns.mac.rejoin_param_setup.answer

### Description
Rejoin parameter setup answer received.

### Data Example
```json
{
  "@type": "type.googleapis.com/ttn.lorawan.v3.MACCommand.RejoinParamSetupAns"
}
```
```

--------------------------------

### MAC Command RxParamSetupAns Data Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Example of the data field for ns.mac.rx_param_setup.answer.accept and ns.mac.rx_param_setup.answer.reject events, representing an Rx Parameter Setup answer.

```json
{
  "@type": "type.googleapis.com/ttn.lorawan.v3.MACCommand.RxParamSetupAns"
}
```

--------------------------------

### ns.mac.rx_param_setup.answer.reject

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Rx parameter setup rejection received. Includes an example of the `data` field.

```APIDOC
## Event ns.mac.rx_param_setup.answer.reject

### Description
Rx parameter setup rejection received.

### Data Example
```json
{
  "@type": "type.googleapis.com/ttn.lorawan.v3.MACCommand.RxParamSetupAns"
}
```
```

--------------------------------

### List Gateways with Pagination (Page 1)

Source: https://www.thethingsindustries.com/docs/api/concepts/pagination

This example demonstrates how to list gateways with a limit of 2 per page, starting with the first page. It also shows the `X-Total-Count` header which indicates the total number of accessible gateways.

```bash
curl -v -H "Authorization: Bearer $API_KEY" https://thethings.example.com/api/v3/users/admin/gateways\?limit\=2\&page\=1
...
< X-Total-Count: 10
...
{"gateways":[{"ids":{"gateway_id":"test-0001","eui":"1111111111111111"},"created_at":"2023-11-24T10:59:39.318638Z","updated_at":"2023-11-24T10:59:39.318639Z"},{"ids":{"gateway_id":"test-0002","eui":"1111111111111112"},"created_at":"2023-11-24T10:59:46.117823Z","updated_at":"2023-11-24T10:59:46.117824Z"}]}
```

--------------------------------

### List Application Packages Command

Source: https://www.thethingsindustries.com/docs/ttn-lw-cli/ttn-lw-cli_applications_packages_list

Use this command to list all available application packages for a given application. No specific setup is required beyond having the CLI installed.

```bash
ttn-lw-cli applications packages list [flags]
```

--------------------------------

### Enable and Start the Service

Source: https://www.thethingsindustries.com/docs/hardware/gateways/models/raspberry-pi

Enable the ttn-station service to start on boot and then start the service immediately. This makes the packet forwarder active.

```bash
sudo systemctl enable ttn-station

```

```bash
sudo systemctl start ttn-station

```

--------------------------------

### Rejoin Parameter Setup Answer

Source: https://www.thethingsindustries.com/docs/api/reference/http/messages

Answer for rejoin parameter setup.

```APIDOC
## Schema

### Rejoin Parameter Setup Answer

#### Description

Answer for rejoin parameter setup.

#### Parameters

##### Response Body

- **max_time_exponent_ack** (boolean) - Description of the max_time_exponent_ack field.
```

--------------------------------

### MACCommand.RejoinParamSetupAns Object Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/end_device

Example of the MACCommand.RejoinParamSetupAns message structure.

```json
{
  "max_time_exponent_ack": false
}
```

--------------------------------

### Rejoin Parameter Setup Request

Source: https://www.thethingsindustries.com/docs/api/reference/http/messages

Request for rejoin parameter setup.

```APIDOC
## Schema

### Rejoin Parameter Setup Request

#### Description

Request for rejoin parameter setup.

#### Parameters

##### Request Body

- **max_count_exponent** (string) - Optional - Specifies the maximum count exponent for rejoin requests. Possible values:
  - 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 value: REJOIN_COUNT_16.
- **max_time_exponent** (string) - Optional - Specifies the maximum time exponent for rejoin requests. Possible values:
  - REJOIN_TIME_0: Every ~17.1 minutes.
  - REJOIN_TIME_1: Every ~34.1 minutes.
  - REJOIN_TIME_2: Every ~1.1 hours.
  - REJOIN_TIME_3: Every ~2.3 hours.
  - REJOIN_TIME_4: Every ~4.6 hours.
  - REJOIN_TIME_5: Every ~9.1 hours.
  - REJOIN_TIME_6: Every ~18.2 hours.
  - REJOIN_TIME_7: Every ~1.5 days.
  - REJOIN_TIME_8: Every ~3.0 days.
  - REJOIN_TIME_9: Every ~6.1 days.
  - REJOIN_TIME_10: Every ~12.1 days.
  - REJOIN_TIME_11: Every ~3.5 weeks.
  - REJOIN_TIME_12: Every ~1.6 months.
  - REJOIN_TIME_13: Every ~3.2 months.
  - REJOIN_TIME_14: Every ~6.4 months.
  - REJOIN_TIME_15: Every ~1.1 year.
  Default value: REJOIN_TIME_0.
```

--------------------------------

### Start the Packet Forwarder

Source: https://www.thethingsindustries.com/docs/hardware/gateways/models/raspberry-pi

Navigate to the configuration directory and start the packet forwarder script. This initializes the hardware and connects to The Things Stack.

```bash
cd /opt/ttn-station/config
sudo RADIODEV=/dev/spidev0.0 /opt/ttn-station/bin/start.sh

```

--------------------------------

### Gateways Connectivity Times Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/network_operations_center

Example object containing connectivity times for multiple gateways. Use this to get a list of GatewayConnectivityTimes objects.

```json
{
  "gateways": [],
}
```

--------------------------------

### Configuration Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/tenant

Example of the Configuration message, including default cluster, clusters map, and packet broker configuration.

```json
{
  "default_cluster": {},
  "clusters": {},
  "pb": {},
}
```

--------------------------------

### Arduino MKRWAN Firmware Update Example

Source: https://www.thethingsindustries.com/docs/hardware/devices/models/mkr1310

Use this example to update the firmware for the MKRWAN library. Ensure the correct firmware is installed for the library you are using.

```Arduino
#include <MKRWAN.h>

// MKRWAN_v2 example
// MKRWANFWUpdate_standalone

void setup() {
  // put your setup code here, to run once:
}

void loop() {
  // put your main code here, to run repeatedly:
}
```

--------------------------------

### Create a Tenant with CLI

Source: https://www.thethingsindustries.com/docs/enterprise/management/tenant-management

Use the `tenant create` command to provision a new tenant. Ensure the tenant ID and admin key are correctly set.

```bash
tti-lw-cli tenant create $TENANT_ID --tenant-admin-key $TENANT_ADMIN_KEY
```

--------------------------------

### Join Server Configuration Example

Source: https://www.thethingsindustries.com/docs/enterprise/join-server

Example configuration for The Things Stack to connect to a Join Server. Specifies the path to the Join Server configuration file and a list of Join EUI prefixes the server should handle.

```yaml
join-servers:
- file: "./path/js.yml" # relative path to a file containing Join Server configuration
  components: ["as", "ns"] # optional selector for components (new in 3.21.0)
  join-euis:
  - "11AA000000000000/16" # in this example, the first 16 bits, so all JoinEUIs starting with 11AA
```

--------------------------------

### RX Param Setup Req

Source: https://www.thethingsindustries.com/docs/api/reference/http/messages

Request to set up reception parameters for the end device.

```APIDOC
## RX Param Setup Req

### Description
This message is used to configure the reception parameters for an end device, specifically the RX1 data rate offset, RX2 data rate index, and RX2 frequency.

### Request Body
- **rx1_data_rate_offset** (string) - Required - The offset for the data rate used in RX1. Possible values include `DATA_RATE_OFFSET_0` through `DATA_RATE_OFFSET_7`.
- **rx2_data_rate_index** (string) - Required - The index of the data rate used in RX2. Possible values include `DATA_RATE_0` through `DATA_RATE_15`.
- **rx2_frequency** (string) - Required - The frequency in Hz for RX2. This should be a uint64 formatted string.

### Request Example
```json
{
  "rx1_data_rate_offset": "DATA_RATE_OFFSET_3",
  "rx2_data_rate_index": "DATA_RATE_5",
  "rx2_frequency": "869525000"
}
```
```

--------------------------------

### Setup Gateway Configuration Directory

Source: https://www.thethingsindustries.com/docs/hardware/gateways/models/multitechconduit-mlinux

Create the necessary directory and file for the global_conf.json on the gateway. This is required before copying the configuration.

```bash
ssh username@<GATEWAY_IP_ADDRESS>
sudo mkdir /var/config/lora
sudo touch /var/config/lora/global_conf.json
sudo nano /var/config/lora/global_conf.json

```

--------------------------------

### Gateway Time Window Query Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/network_operations_center

Example of a request for gateway data within a specific time window. Use this for querying gateway activity during a defined start and end time.

```json
{
  "gateway_ids": {},
  "time_window": {},
}
```

--------------------------------

### ns.mac.tx_param_setup.answer

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Tx parameter setup answer received.

```APIDOC
## Event ns.mac.tx_param_setup.answer

### Description
Tx parameter setup answer received.
```

--------------------------------

### Get NOC Configuration Request Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/network_operations_center

An empty request object for retrieving the Network Operations Center configuration.

```json
{}
```

--------------------------------

### GetPayloadFormatterRequest Object Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/end_device

Request to get a payload formatter. Includes Application IDs, Version IDs, and a FieldMask for specific fields.

```json
{
  "application_ids": {},
  "version_ids": {},
  "field_mask": {},
}
```

--------------------------------

### RX Param Setup Request

Source: https://www.thethingsindustries.com/docs/api/reference/http/messages

Allows for configuring reception parameters for a device.

```APIDOC
## POST /api/v1/devices/{device_id}/lorawan-devices/{lorawan_device_id}/settings/rx-parameters

### Description
Configures the LoRaWAN reception parameters for a device.

### Method
POST

### Endpoint
/api/v1/devices/{device_id}/lorawan-devices/{lorawan_device_id}/settings/rx-parameters

### Parameters
#### Path Parameters
- **device_id** (string) - Required - The unique identifier of the device.
- **lorawan_device_id** (string) - Required - The LoRaWAN device identifier.

#### Request Body
- **rx1_data_rate_offset** (integer) - Optional - The data rate offset for RX1.

### Request Example
```json
{
  "rx1_data_rate_offset": 2
}
```

### Response
#### Success Response (200)
- **rx_param_setup_req** (object) - An object containing acknowledgements for the configured parameters.
  - **rx1_data_rate_offset_ack** (boolean) - Acknowledgement for RX1 data rate offset.
  - **rx2_data_rate_index_ack** (boolean) - Acknowledgement for RX2 data rate index.
  - **rx2_frequency_ack** (boolean) - Acknowledgement for RX2 frequency.

#### Response Example
```json
{
  "rx_param_setup_req": {
    "rx1_data_rate_offset_ack": true,
    "rx2_data_rate_index_ack": true,
    "rx2_frequency_ack": true
  }
}
```
```

--------------------------------

### Get NOC Configuration Response Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/network_operations_center

Response object containing the Network Operations Center configuration. Includes access settings.

```json
{
  "configuration": {},
}
```

--------------------------------

### Tx Param Setup Req

Source: https://www.thethingsindustries.com/docs/api/reference/http/messages

Request to configure transmission parameters for the end device.

```APIDOC
## Tx Param Setup Req

### Description
This message is used to configure transmission parameters for the end device, such as enabling or disabling downlink dwell time and setting the maximum transmit power.

### Request Body
- **downlink_dwell_time** (boolean) - Optional - Specifies whether to enable downlink dwell time.
- **max_eirp_index** (string) - Optional - The index representing the maximum Effective Isotropic Radiated Power (EIRP). Defaults to `DEVICE_EIRP_8`.

### Request Example
```json
{
  "downlink_dwell_time": true,
  "max_eirp_index": "DEVICE_EIRP_12"
}
```
```

--------------------------------

### Get User Request Object Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/user

Request object for retrieving user information. Allows specifying user identifiers and a field mask to select specific fields.

```json
{
  "user_ids": {},
  "field_mask": {},
}
```

--------------------------------

### Get External User by User ID Request Object Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/user

Request object for retrieving an external user by their User IDs. Requires provider identifiers and user identifiers.

```json
{
  "provider_ids": {},
  "user_ids": {},
}
```

--------------------------------

### ns.mac.rx_timing_setup.answer

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/events

Rx timing setup answer received.

```APIDOC
## Event ns.mac.rx_timing_setup.answer

### Description
Rx timing setup answer received.
```

--------------------------------

### The Things Join Server Configuration Example

Source: https://www.thethingsindustries.com/docs/enterprise/join-server/device-claiming-configuration

Example of configuring The Things Join Server within the `config.yml` file, specifying its file path, Join EUI ranges, and type.

```yaml
# config.yml
join-servers:
  ...
  - file: './tti/js.yml'
    join-euis:
      - '70B3D57ED0000000/64'
      - 'EC656E0000000000/56'
    type: 'ttjsv2'
  ...

```

--------------------------------

### Install Fish Shell Autocompletion Script for New Sessions

Source: https://www.thethingsindustries.com/docs/ttn-lw-cli/ttn-lw-cli_completion_fish

To enable autocompletions for every new shell session, redirect the output of the completion command to a fish completion file. This setup needs to be done only once.

```bash
$ ttn-lw-cli completion --shell fish > ~/.config/fish/completions/ttn-lw-cli.fish

```

--------------------------------

### Complete The Things Uno Arduino Sketch

Source: https://www.thethingsindustries.com/docs/hardware/devices/models/the-things-uno

A full example sketch for The Things Uno, including necessary includes, definitions for serial ports and frequency plan, and the setup function for initialization and status display.

```cpp
#include <TheThingsNetwork.h>

#define loraSerial Serial1
#define debugSerial Serial

// Replace REPLACE_ME with TTN_FP_EU868 or TTN_FP_US915
#define freqPlan TTN_FP_EU868

TheThingsNetwork ttn(loraSerial, debugSerial, freqPlan);

void setup()
{
  loraSerial.begin(57600);
  debugSerial.begin(9600);

    while (!debugSerial) {
    ;
    }

  debugSerial.println("-- STATUS");
  ttn.showStatus();

}

void loop()
{
}
```

--------------------------------

### User Console Preferences Tutorials Object

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/user

Example of the UserConsolePreferences.Tutorials object, showing the structure for tracking seen tutorials.

```json
{
  "seen": [],
}
```

--------------------------------

### Select Specific Fields for Registry Totals

Source: https://www.thethingsindustries.com/docs/ttn-lw-cli/ttn-lw-cli_tenants_get-registry-totals

Use these flags to select specific fields to be included in the registry totals output. For example, to get only the count of activated end devices, use the --activated-end-devices flag.

```bash
--activated-end-devices
      --applications
      --clients
      --end-devices
      --gateways
      --organizations
      --users
```

--------------------------------

### Initialize ttjs CLI

Source: https://www.thethingsindustries.com/docs/hardware/devices/adding-devices/atecc608a/claim

Run this command to initialize the The Things Join Server CLI. It will prompt for server URL, provisioner credentials, and configuration file location.

```bash
ttjs init

```

--------------------------------

### ADRSettings Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/network_server

Example of ADRSettings, showing the possible modes: static, dynamic, or disabled. Only one mode can be set at a time.

```json
{
  "static": {},
  "dynamic": {},
  "disabled": {}
}
```

--------------------------------

### Select Specific Fields for Alert Notification Profile

Source: https://www.thethingsindustries.com/docs/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_get

Use these flags to select and display specific fields of an alert notification profile. For example, to get only the name and description, you would use `--name --description`.

```bash
      --description     select the description field
  -h, --help            help for get
      --is-default      select the is_default field
      --name            select the name field
      --profile-id      select the profile_id field
      --receivers-ids   select the receivers_ids field
```

--------------------------------

### Message Schema Example

Source: https://www.thethingsindustries.com/docs/api/reference/http/messages

Shows an example of the 'example', 'format', and 'type' fields within a message schema.

```json
{
  "example": "70B3D57ED000ABCD",
  "format": "string",
  "type": "string"
}
```

--------------------------------

### MACCommand.RxParamSetupReq Object Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/end_device

Represents an RxParamSetupReq MAC command. Use this to configure receive window parameters.

```json
{
  "rx2_data_rate_index": "DATA_RATE_0",
  "rx1_data_rate_offset": "DATA_RATE_OFFSET_0",
  "rx2_frequency": 0
}
```

--------------------------------

### RX Param Setup Answer

Source: https://www.thethingsindustries.com/docs/api/reference/http/messages

This message provides the acknowledgment status for RX parameters setup.

```APIDOC
## rx_param_setup_ans

### Description
This message provides the acknowledgment status for RX parameters setup.

### Response Body
- **rx1_data_rate_offset_ack** (boolean) - Indicates acknowledgment for RX1 data rate offset.
- **rx2_data_rate_index_ack** (boolean) - Indicates acknowledgment for RX2 data rate index.
- **rx2_frequency_ack** (boolean) - Indicates acknowledgment for RX2 frequency.

### Response Example
```json
{
  "rx1_data_rate_offset_ack": true,
  "rx2_data_rate_index_ack": true,
  "rx2_frequency_ack": true
}
```
```

--------------------------------

### Install ttn-lw-migrate with Homebrew

Source: https://www.thethingsindustries.com/docs/concepts/migration/exporting-end-devices

Installs the `ttn-lw-migrate` tool on macOS using Homebrew. Ensure you have Homebrew installed.

```bash
brew install TheThingsNetwork/homebrew-lorawan-stack/ttn-lw-migrate

```

--------------------------------

### Create User Invitation Options

Source: https://www.thethingsindustries.com/docs/ttn-lw-cli/ttn-lw-cli_users_invitations_create

These are the available options for the 'create' command, including flags for help and other configuration parameters.

```bash
  -h, --help   help for create
```

--------------------------------

### Check if Basic Station is Installed

Source: https://www.thethingsindustries.com/docs/hardware/gateways/models/tektelickonamicro/lbs

Verifies that the Basic Station package is installed on the gateway by listing installed packages and filtering for 'bstn'.

```bash
opkg list-installed | grep bstn

```

--------------------------------

### rejoin_param_setup_ans

Source: https://www.thethingsindustries.com/docs/api/reference/http/messages

Represents the answer to a rejoin parameter setup request, indicating the status of the configuration.

```APIDOC
## rejoin_param_setup_ans

### Description
This message is sent as a response to a `rejoin_param_setup_req` and indicates whether the requested rejoin parameters were accepted.

### Schema
```json
{
  "type": "object",
  "properties": {
    "max_time_exponent_ack": {
      "type": "boolean"
    }
  }
}
```

### Response Example
```json
{
  "max_time_exponent_ack": true
}
```
```

--------------------------------

### RxTimingSetupReq Object Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/end_device

Example of the RxTimingSetupReq MAC Command object. Specifies the delay for receiving downlink messages.

```json
{
  "delay": "RX_DELAY_0",
}
```

--------------------------------

### Install ttn-lw-migrate with Snap

Source: https://www.thethingsindustries.com/docs/concepts/migration/exporting-end-devices

Installs the `ttn-lw-migrate` tool on Linux using Snap. This is a convenient way to manage the tool's installation and updates.

```bash
sudo snap install ttn-lw-migrate

```

--------------------------------

### Example The Things Stack Configuration File

Source: https://www.thethingsindustries.com/docs/enterprise/docker/configuration

This is a comprehensive example of the `ttn-lw-stack-docker.yml` file for The Things Stack Enterprise. It includes settings for license, identity server, HTTP server, events, and TLS.

```yaml
# The Things Stack requires a license key
license:
  # License contents may be specified directly
  key: ""
  # Or stored in a file
  # file: ''

# Identity Server configuration
# Email configuration for "thethings.example.com"
is:
  email:
    sender-name: "The Things Stack"
    sender-address: "noreply@thethings.example.com"
    network:
      name: "The Things Stack"
      console-url: "https://thethings.example.com/console"
      identity-server-url: "https://thethings.example.com/oauth"

    # If sending email with Sendgrid
    # provider: sendgrid
    # sendgrid:
    #   api-key: '...'              # enter Sendgrid API key

    # If sending email with SMTP
    # provider: smtp
    # smtp:
    #   address:  '...'             # enter SMTP server address
    #   username: '...'             # enter SMTP server username
    #   password: '...'             # enter SMTP server password

  # Web UI configuration for "thethings.example.com":
  oauth:
    ui:
      canonical-url: "https://thethings.example.com/oauth"
      is:
        base-url: "https://thethings.example.com/api/v3"
      ui:
        console-url: "https://thethings.example.com/oauth"

  # If running a multi-tenant environment, configure tenant admin keys
  tenancy:
    admin-keys: "" # generate 32 bytes (openssl rand -hex 32)

# HTTP server configuration
http:
  cookie:
    block-key: "" # generate 32 bytes (openssl rand -hex 32)
    hash-key: "" # generate 64 bytes (openssl rand -hex 64)
  metrics:
    password: "metrics" # choose a password
  pprof:
    password: "pprof" # choose a password

# Events configuration
events:
  backend: redis
  redis:
    store:
      enable: true

# If using custom certificates:
#tls:
#  source: file
#  root-ca: /run/secrets/ca.pem
#  certificate: /run/secrets/cert.pem
#  key: /run/secrets/key.pem

# Let's encrypt for "thethings.example.com"
tls:
  source: acme
  acme:
    enable: true
    dir: /var/lib/acme
    email: "you@thethings.example.com"
    hosts: ["thethings.example.com"]
    # If running a multi-tenant environment, specify the wildcard address too:
    # hosts: ["*.thethings.example.com", "thethings.example.com"]
    default-host: "thethings.example.com"

# If Gateway Server enabled, defaults for "thethings.example.com":
gs:
  mqtt:
    public-address: "thethings.example.com:1882"
    public-tls-address: "thethings.example.com:8882"
  mqtt-v2:
    public-address: "thethings.example.com:1881"
    public-tls-address: "thethings.example.com:8881"

```

--------------------------------

### BatchGetTenantRegistryTotalsRequest Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/tenant

Example structure for the BatchGetTenantRegistryTotalsRequest message.

```json
{
  "tenant_ids": [],
  "field_mask": {}
}
```

--------------------------------

### MACSettingsProfileIdentifiers Object Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/end_device

An example of the MACSettingsProfileIdentifiers object structure.

```json
{
  "application_ids": {},
  "profile_id": "",
}
```

--------------------------------

### ttn-lw-cli Activation Settings Help

Source: https://www.thethingsindustries.com/docs/ttn-lw-cli/ttn-lw-cli_applications_activation-settings

Displays help information for the activation-settings command.

```bash
ttn-lw-cli applications activation-settings --help
```

--------------------------------

### Application Activation Settings Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/application

Configuration settings for application activation, including key encryption and network identifiers.

```json
{
  "kek_label": "",
  "kek": {},
  "home_net_id": "",
  "application_server_id": "",
}
```

--------------------------------

### UpdateAlertNotificationReceiverRequest Object Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/identity_server

An example of the UpdateAlertNotificationReceiverRequest object structure.

```json
{
  "receiver": {},
  "field_mask": {},
}
```

--------------------------------

### Enable Serving Mode for End Device

Source: https://www.thethingsindustries.com/docs/hardware/devices/configuring-devices/relay-settings

Use the `create` command with the `--mode.serving` parameter to enable the serving mode for an end device.

```bash
ttn-lw-cli relays create <app-id> <device-id> --mode.serving

```

--------------------------------

### TxSettings.Downlink Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/packet_broker

Example of specific transmission settings for a downlink operation.

```json
{
  "antenna_index": 0,
  "tx_power": 0,
  "invert_polarization": false,
}
```

--------------------------------

### Create Application Request Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/application

Request to create a new application, including application details and initial collaborator.

```json
{
  "application": {},
  "collaborator": {},
}
```

--------------------------------

### EndDevices Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/end_device

Example of the EndDevices message. Contains a list of end devices.

```json
{
  "end_devices": []
}
```

--------------------------------

### RX Param Setup Answer

Source: https://www.thethingsindustries.com/docs/api/reference/http/messages

This message provides the answer to an RX parameter setup request, indicating the status of configuration changes.

```APIDOC
## RX Param Setup Answer

### Description
This message provides the answer to an RX parameter setup request, indicating the status of configuration changes.

### Method
POST

### Endpoint
`/api/v1/devices/{device_id}/rx_param_setup/ans`

### Parameters
#### Path Parameters
- **device_id** (string) - Required - The ID of the device.

#### Request Body
- **rx1_data_rate_offset_ack** (boolean) - Optional - Acknowledgment status for RX1 data rate offset.
- **rx2_data_rate_index_ack** (boolean) - Optional - Acknowledgment status for RX2 data rate index.
- **rx2_frequency_ack** (boolean) - Optional - Acknowledgment status for RX2 frequency.

### Request Example
```json
{
  "rx1_data_rate_offset_ack": true,
  "rx2_data_rate_index_ack": false,
  "rx2_frequency_ack": true
}
```

### Response
#### Success Response (200)
- **rx_param_setup_ans** (object) - An empty object indicating success.

#### Response Example
```json
{
  "rx_param_setup_ans": {}
}
```
```

--------------------------------

### SetApplicationLinkRequest Object Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/application_server

An example of the SetApplicationLinkRequest object, used for linking applications.

```json
{
  "application_ids": {},
  "link": {},
  "field_mask": {},
}
```

--------------------------------

### Create Login Token Help Options

Source: https://www.thethingsindustries.com/docs/ttn-lw-cli/ttn-lw-cli_users_create-login-token

This snippet displays the available options for the 'create-login-token' command, including help flags and user ID specification.

```bash
  -h, --help             help for create-login-token
      --user-id string   

```

--------------------------------

### ConcentratorConfig.LBTConfiguration Object Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/gateway_server

An example of the ConcentratorConfig.LBTConfiguration object, used for Listen-Before-Talk configuration.

```json
{
  "rssi_target": 0,
  "rssi_offset": 0,
  "scan_time": "0s"
}
```

--------------------------------

### Create Client Command

Source: https://www.thethingsindustries.com/docs/ttn-lw-cli/ttn-lw-cli_clients_create

The basic command structure for creating a client. Replace `[client-id]` with the desired client ID and `[flags]` with any necessary options.

```bash
ttn-lw-cli clients create [client-id] [flags]
```

--------------------------------

### ADRSettings.DynamicMode Object Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/network_server

Provides an example of the ADRSettings.DynamicMode configuration object, used for dynamic Adaptive Data Rate settings.

```json
{
  "margin": null,
  "min_data_rate_index": {},
  "max_data_rate_index": {},
  "min_tx_power_index": null,
  "max_tx_power_index": null,
  "min_nb_trans": null,
  "max_nb_trans": null,
  "channel_steering": {},
  "overrides": {},
}
```

--------------------------------

### Billing Identifiers Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/tenant

Example of the BillingIdentifiers message, containing a billing ID.

```json
{
  "billing_id": "",
}
```

--------------------------------

### ArsConfiguration Object Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/identity_server

Example of the ArsConfiguration object, which contains routing settings.

```json
{
  "routing": {}
}
```

--------------------------------

### Create Device on Application Server

Source: https://www.thethingsindustries.com/docs/hardware/devices/adding-devices/manual/otaa

Prepare the device configuration for the Application Server. This step typically involves minimal configuration, focusing on device IDs.

```json
{
  "end_device": {
    "ids": {
      "device_id": "test-device",
      "dev_eui": "0000000000000011",
      "join_eui": "1111111111111111"
    }
  },
  "field_mask": {
    "paths": ["ids.device_id", "ids.dev_eui", "ids.join_eui"]
  }
}
```

--------------------------------

### Tenant Identifiers for Billing Request Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/tenant

Example of the GetTenantIdentifiersForBillingIdentifiersRequest message structure.

```json
{
  "ids": {},
}
```

--------------------------------

### MACSettings Object Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/network_server

An example of the MACSettings object structure, showing all possible fields and their default or unset states.

```json
{
  "class_b_timeout": "0s",
  "ping_slot_periodicity": {},
  "ping_slot_data_rate_index": {},
  "ping_slot_frequency": {},
  "beacon_frequency": {},
  "class_c_timeout": "0s",
  "rx1_delay": {},
  "rx1_data_rate_offset": {},
  "rx2_data_rate_index": {},
  "rx2_frequency": {},
  "factory_preset_frequencies": [],
  "max_duty_cycle": {},
  "supports_32_bit_f_cnt": {},
  "use_adr": {},
  "adr_margin": null,
  "resets_f_cnt": {},
  "status_time_periodicity": "0s",
  "status_count_periodicity": null,
  "desired_rx1_delay": {},
  "desired_rx1_data_rate_offset": {},
  "desired_rx2_data_rate_index": {},
  "desired_rx2_frequency": {},
  "desired_max_duty_cycle": {},
  "desired_adr_ack_limit_exponent": {},
  "desired_adr_ack_delay_exponent": {},
  "desired_ping_slot_data_rate_index": {},
  "desired_ping_slot_frequency": {},
  "desired_beacon_frequency": {},
  "desired_max_eirp": {},
  "class_b_c_downlink_interval": "0s",
  "uplink_dwell_time": {},
  "downlink_dwell_time": {},
  "adr": {},
  "schedule_downlinks": {},
  "relay": {},
  "desired_relay": {},
}
```

--------------------------------

### Configuration Cluster IdentityServer UserLimits Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/tenant

Example structure for the Configuration.Cluster.IdentityServer.UserLimits message.

```json
{
  "applications": null,
  "clients": null,
  "gateways": null,
  "organizations": null
}
```

--------------------------------

### Configuration Cluster IdentityServer OrganizationLimits Example

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/tenant

Example structure for the Configuration.Cluster.IdentityServer.OrganizationLimits message.

```json
{
  "applications": null,
  "clients": null,
  "gateways": null
}
```

--------------------------------

### List All Tenants with CLI

Source: https://www.thethingsindustries.com/docs/enterprise/management/tenant-management

Obtain descriptions of all tenants within the deployment using the `tenant list` command.

```bash
tti-lw-cli tenant list --tenant-admin-key $TENANT_ADMIN_KEY
```
Tokens:
Raw