openapi: 3.0.3
info:
  description: Provides a set of endpoints to manage Devices, Things, Properties and Timeseries
  title: Arduino IoT Cloud binaries_v2 lora_devices_v1 API
  version: '2.0'
tags:
- name: lora_devices_v1
paths:
  /iot/v1/lora-devices/:
    put:
      description: Create a new lora device. Its info are saved on our database, and on the lora provider network. Creates a device_v2 automatically
      operationId: lora_devices_v1#create
      parameters:
      - in: header
        name: X-Organization
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLoraDevicesV1Payload'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateLoraDevicesV1Payload'
        required: true
        x-originalParamName: payload
      responses:
        '201':
          content:
            application/vnd.arduino.loradevicev1+json:
              schema:
                $ref: '#/components/schemas/ArduinoLoradevicev1'
          description: Created
      summary: create lora_devices_v1
      tags:
      - lora_devices_v1
components:
  schemas:
    CreateLoraDevicesV1Payload:
      properties:
        app:
          description: The app name
          type: string
        app_eui:
          description: The app eui of the lora device
          pattern: '[0-9a-z]{16}'
          type: string
        app_key:
          description: The app key of the lora device
          pattern: '[0-9a-z]{16}'
          type: string
        eui:
          description: The eui of the lora device
          pattern: '[0-9a-z]{16}'
          type: string
        frequency_plan:
          description: 'The frequency plan required by your country '
          enum:
          - EU_863_870_TTN
          - US_902_928_FSB_2
          - EU_433
          - AU_915_928_FSB_2
          - CN_470_510_FSB_11
          - AS_920_923
          - AS_920_923_TTN_AU
          - AS_923_925
          - AS_923_925_TTN_AU
          - KR_920_923_TTN
          - IN_865_867
          type: string
        name:
          description: A common name for the device
          type: string
        serial:
          description: The optional serial number
          type: string
        type:
          description: The type of device
          enum:
          - lora-device
          - mkrwan1300
          - mkrwan1310
          type: string
        user_id:
          description: The id of the user. Can be the special string 'me'
          type: string
      required:
      - name
      - eui
      - frequency_plan
      - user_id
      - app
      - type
      title: CreateLoraDevicesV1Payload
      type: object
    ArduinoLoradevicev1:
      description: ArduinoLoradevicev1 media type (default view)
      properties:
        app_eui:
          description: The eui of the app
          type: string
        app_key:
          description: The key of the device
          type: string
        device_id:
          description: The id of the device
          format: uuid
          type: string
        eui:
          description: The eui of the lora device
          example: '71619230301'
          type: string
      required:
      - eui
      - device_id
      - app_eui
      - app_key
      title: 'Mediatype identifier: application/vnd.arduino.loradevicev1+json; view=default'
      type: object
externalDocs:
  description: See docs on Confluence
  url: https://arduino.atlassian.net/wiki/spaces/FTWEB/pages/91160610/Arduino+IoT+Cloud