openapi: 3.0.0
info:
  contact:
    email: support@teltonika-networks.com
  description: This is a Remote Management System API.
  title: RMS API
  version: 3.0.0
servers:
- description: RMS api server.
  url: https://rms.teltonika-networks.com/api
paths:
  /companies:
    get:
      description: Returns list of all companies.
      operationId: companiesGet
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: 'Filter entries by id. For example: 7441,5558,7410'
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Order companies by specified field. Multiple values are allowed
          with comma separation. The dash symbol before field name indicates desc
          sorting direction.
        in: query
        name: sort
        required: false
        schema:
          enum:
          - parent_id
          - crated_at
          - company_name
          - device_count
          type: string
      - description: Parent id filter.
        in: query
        name: parent_id
        required: false
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200'
          description: Returned companies list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: List all companies
      tags:
      - companies
    post:
      description: Creates a new subsidiary company.
      operationId: companyCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/company_create'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Company created.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Create a new subsidiary company
      tags:
      - companies
  /companies/move:
    post:
      description: Assigns a company as subsidiary of another company.
      operationId: companyMove
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/company_move'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Company moved successfully.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Assign a company as subsidiary of another company
      tags:
      - companies
  /companies/{id}:
    delete:
      description: Deletes a company from the system.
      operationId: companyDelete
      parameters:
      - description: The company's id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
      security:
      - BearerAuth: []
      summary: Delete a company from the system
      tags:
      - companies
    get:
      description: Returns information about a single company.
      operationId: companyGet
      parameters:
      - description: The company's id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_1'
          description: Returned a single company.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get information about a single company
      tags:
      - companies
    put:
      description: Edits a specific company's information.
      operationId: companyEdit
      parameters:
      - description: The company's id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/company_update'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Company updated.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Edit a specific company's information
      tags:
      - companies
  /user:
    get:
      description: Returns a current logged in user's information.
      operationId: currentUser
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_3'
          description: Returned current users information.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get authenticated user info
      tags:
      - users
  /users:
    get:
      description: Returns a list of all users.
      operationId: usersAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: 'Filter entries by id. For example: 7441,5558,7410'
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: Filter for role.
        in: query
        name: role
        required: false
        schema:
          type: string
      - description: Company id filter.
        in: query
        name: company_id
        required: false
        schema:
          type: string
      - description: Order users by specified field. Multiple values are allowed with
          comma separation. The dash symbol before field name indicates desc sorting
          direction.
        in: query
        name: sort
        required: false
        schema:
          enum:
          - id
          - username
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_4'
          description: Returned users list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all users
      tags:
      - users
  /users/{id}:
    delete:
      description: Deletes a user from the system.
      operationId: userDelete
      parameters:
      - description: The user's id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: User information deleted.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
      security:
      - BearerAuth: []
      summary: Delete a user from the system
      tags:
      - users
    get:
      description: Returns one single user's information.
      operationId: userGet
      parameters:
      - description: The user's id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_5'
          description: Returned single user data.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get single user
      tags:
      - users
  /users/invitations:
    get:
      description: Returns a list of all active invitations for users that have not
        yet been accepted.
      operationId: invitesAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Filter for role.
        in: query
        name: role
        required: false
        schema:
          type: string
      - description: Company id filter.
        in: query
        name: company_id
        required: false
        schema:
          type: string
      - description: Order invites of users by specified field. Multiple values are
          allowed with comma separation. The dash symbol before field name indicates
          desc sorting direction.
        in: query
        name: sort
        required: false
        schema:
          enum:
          - email
          - created_at
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_6'
          description: Returned user invitations list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all invitations
      tags:
      - user invites
  /users/invite:
    post:
      description: Invites a new user to register to the system. The invited user
        will automatically be assigned to the company they are invited to.
      operationId: inviteUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/invite_user'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Invited user for registration.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
      security:
      - BearerAuth: []
      summary: Invite user
      tags:
      - user invites
  /users/invitations/{id}:
    delete:
      description: Deletes a user invitation, so it is no longer valid.
      operationId: inviteDelete
      parameters:
      - description: The user's invite id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Deleted user's invitation.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Delete user invitation
      tags:
      - user invites
  /tags:
    get:
      description: Returns a list of all tags.
      operationId: tagsGet
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: 'Filter entries by id. For example: 7441,5558,7410'
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: Filter tags by their company id.
        in: query
        name: company_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Order tags by specified field. Multiple values are allowed with
          comma separation. The dash symbol before field name indicates desc sorting
          direction.
        in: query
        name: sort
        required: false
        schema:
          enum:
          - id
          - device_count
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_7'
          description: Returned tags list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all tags
      tags:
      - tags
    post:
      description: Creates a new tag.
      operationId: tagCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tag_create'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Tag created.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_409'
          description: A conflict occurred.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Create a new tag
      tags:
      - tags
  /tags/{id}:
    delete:
      description: Deletes a tag from the system.
      operationId: tagDelete
      parameters:
      - description: Id of a tag.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Tag information was deleted.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Delete tag
      tags:
      - tags
    get:
      description: Returns information about a specific tag.
      operationId: tagReturn
      parameters:
      - description: Id of a tag.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_8'
          description: Returned a tag.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get a single tag
      tags:
      - tags
    put:
      description: Changes tag data.
      operationId: tagEdit
      parameters:
      - description: Id of a tag.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tag_update'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Tag information was updated.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Edit tag's information
      tags:
      - tags
  /devices:
    delete:
      description: Delete a list of devices.
      operationId: deleteDevices
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/devices_delete'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Devices deleted successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Delete devices
      tags:
      - devices
    get:
      description: Returns a list of all devices.
      operationId: devicesGet
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Order elements by specified field. Multiple values are allowed
          with comma separation. The dash symbol before field name indicates desc
          sorting direction.
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: 'Filter entries by id. For example: 7441,5558,7410'
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: Device status filter.
        in: query
        name: status
        required: false
        schema:
          enum:
          - online
          - offline
          - not_activated
          type: string
      - description: Device model filter.
        in: query
        name: model
        required: false
        schema:
          type: string
      - description: Device mac filter.
        in: query
        name: mac
        required: false
        schema:
          type: string
      - description: Device firmware filter.
        in: query
        name: firmware
        required: false
        schema:
          type: string
      - description: Device signal filter.
        in: query
        name: signal
        required: false
        schema:
          enum:
          - excellent
          - average
          - low
          - no_signal
          type: string
      - description: Network state filter.
        in: query
        name: network_state
        required: false
        schema:
          enum:
          - home
          - roaming
          - unknown
          type: string
      - description: Connection type filter.
        in: query
        name: connection_type
        required: false
        schema:
          enum:
          - 5g
          - 4g
          - 3g
          - 2g
          - unknown
          type: string
      - description: Information updated filter.
        in: query
        name: information_updated
        required: false
        schema:
          enum:
          - never_been_updated
          - less_than_5_minutes_ago
          - more_than_5_minutes_ago
          - more_than_1_hour_ago
          - more_than_1_week_ago
          type: string
      - description: Company id filter.
        in: query
        name: company_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Operator filter.
        in: query
        name: operator
        required: false
        schema:
          type: string
      - description: Modem model filter.
        in: query
        name: modem_model
        required: false
        schema:
          enum:
          - up_to_1_hour_ago
          type: string
      - description: Modem manufacturer filter.
        in: query
        name: modem_manufacturer
        required: false
        schema:
          enum:
          - up_to_1_hour_ago
          type: string
      - description: Modem firmware filter.
        in: query
        name: modem_firmware
        required: false
        schema:
          enum:
          - up_to_1_hour_ago
          type: string
      - description: Monitoring status filter.
        in: query
        name: monitoring_status
        required: false
        schema:
          enum:
          - not_monitored
          - monitored
          type: string
      - description: Task filter.
        in: query
        name: task
        required: false
        schema:
          enum:
          - no_pending_task
          - pending_firmware
          - pending_configuration
          type: string
      - description: Wan state filter.
        in: query
        name: wan_state
        required: false
        schema:
          enum:
          - unknown
          - mobile
          - wifi
          - wired
          type: string
      - description: Tag id filter.
        in: query
        name: tag_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Credit type name filter.
        in: query
        name: management_credit_type
        required: false
        schema:
          enum:
          - credit
          - management_5y
          - management_10y
          type: string
      - description: Credit type id.
        in: query
        name: management_credit_type_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Credit type name.
        in: query
        name: data_credit_type
        required: false
        schema:
          enum:
          - data_150GB_10y
          type: string
      - description: Credit type id.
        in: query
        name: data_credit_type_id
        required: false
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_9'
          description: Returned devices list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all devices
      tags:
      - devices
    post:
      description: Adds a new device.
      operationId: addDevice
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/device_add'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Add a new device
      tags:
      - devices
    put:
      description: Updates multiple devices at once.
      operationId: updateDevices
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/devices_update'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Devices updated successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Update devices
      tags:
      - devices
  /devices/{id}:
    get:
      description: Returns information about a single device.
      operationId: deviceGet
      parameters:
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_10'
          description: Returned a device information.
      security:
      - BearerAuth: []
      summary: Get a single device's information
      tags:
      - devices
    put:
      description: Updates information of a single device.
      operationId: updateDevice
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/device_update'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Device updated successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Edit device's information
      tags:
      - devices
  /devices/export/csv:
    get:
      description: Exports device information to a CSV file.
      operationId: devicesExport
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Order elements by specified field. Multiple values are allowed
          with comma separation. The dash symbol before field name indicates desc
          sorting direction.
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: Device status filter.
        in: query
        name: status
        required: false
        schema:
          enum:
          - online
          - offline
          - not_activated
          type: string
      - description: Device model filter.
        in: query
        name: model
        required: false
        schema:
          type: string
      - description: Device firmware filter.
        in: query
        name: firmware
        required: false
        schema:
          type: string
      - description: Device signal filter.
        in: query
        name: signal
        required: false
        schema:
          enum:
          - excellent
          - average
          - low
          - no_signal
          type: string
      - description: Network state filter.
        in: query
        name: network_state
        required: false
        schema:
          enum:
          - home
          - roaming
          - unknown
          type: string
      - description: Connection type filter.
        in: query
        name: connection_type
        required: false
        schema:
          enum:
          - 5g
          - 4g
          - 3g
          - 2g
          - unknown
          type: string
      - description: Information updated filter.
        in: query
        name: information_updated
        required: false
        schema:
          enum:
          - never_been_updated
          - less_than_5_minutes_ago
          - more_than_5_minutes_ago
          - more_than_1_hour_ago
          - more_than_1_week_ago
          type: string
      - description: Company id filter.
        in: query
        name: company_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Operator filter.
        in: query
        name: operator
        required: false
        schema:
          type: string
      - description: Modem model filter.
        in: query
        name: modem_model
        required: false
        schema:
          enum:
          - up_to_1_hour_ago
          type: string
      - description: Modem manufacturer filter.
        in: query
        name: modem_manufacturer
        required: false
        schema:
          enum:
          - up_to_1_hour_ago
          type: string
      - description: Modem firmware filter.
        in: query
        name: modem_firmware
        required: false
        schema:
          enum:
          - up_to_1_hour_ago
          type: string
      - description: Credit type filter.
        in: query
        name: credit_type
        required: false
        schema:
          enum:
          - free
          - paid
          type: string
      - description: Monitoring status filter.
        in: query
        name: monitoring_status
        required: false
        schema:
          enum:
          - not_monitored
          - monitored
          type: string
      - description: Task filter.
        in: query
        name: task
        required: false
        schema:
          enum:
          - no_pending_task
          - pending_firmware
          - pending_configuration
          type: string
      - description: Wan state filter.
        in: query
        name: wan_state
        required: false
        schema:
          enum:
          - unknown
          - mobile
          - wifi
          - wired
          type: string
      responses:
        "200":
          content:
            text/csv; charset=utf-8:
              schema:
                $ref: '#/components/schemas/inline_response_200_11'
          description: Exported devices to csv file.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Export device information to a CSV file
      tags:
      - devices
  /devices/import:
    post:
      description: Imports new devices from csv or xls file.
      operationId: importDevicesCsv
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/device_import'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_409'
          description: A conflict occurred.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Import new devices from csv or xls file
      tags:
      - devices
  /devices/monitoring:
    put:
      description: Switch a single device's monitoring status.
      operationId: devicesMoniotring
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/devices_monitoring'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Change devices monitoring
      tags:
      - devices
  /devices/tags:
    post:
      description: Sets tags for devices using a CSV file.
      operationId: fileSetDeviceTags
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/set_device_tags'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_12'
          description: Tags successfully set for devices from file.
        "207":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_207'
          description: Some tags successfully set for devices from file, others failed.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Set tags for devices
      tags:
      - device tags
  /devices/tags/assign:
    put:
      description: Assigns a list of tags for a specific device.
      operationId: assignDeviceTags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/device_assign_tags'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Devices tags assigned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Assign tags for device
      tags:
      - device tags
  /devices/tags/overwrite:
    put:
      description: Deletes all tags and then assigns new designated ones.
      operationId: overwriteDeviceTags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/device_overwrite_tags'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Devices tags overwritten.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Overwrite tags for devices
      tags:
      - device tags
  /devices/tags/unassign:
    put:
      description: Deletes all tags from a specific device.
      operationId: unassignDeviceTags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/device_unassign_tags'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Devices tags unassigned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Unassign tags for devices
      tags:
      - device tags
  /devices/{id}/logs:
    get:
      description: Get all logs of a single device.
      operationId: getDevicesLogsAll
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_13'
          description: Logs returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get device's logs
      tags:
      - device logs
  /devices/logs:
    get:
      description: Returns all devices logs.
      operationId: getAllDevicesLogs
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_13'
          description: Logs returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all logs of devices
      tags:
      - device logs
  /devices/{id}/links:
    get:
      description: Returns active device access links of a specific device.
      operationId: getLinks
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Type of device access.
        in: query
        name: type
        required: true
        schema:
          enum:
          - webui
          - cli
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_14'
          description: Links of device access returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get active device access links
      tags:
      - device access
  /rms-connect/restart:
    post:
      description: Restart RMS connection session.
      operationId: restartRmsSession
      requestBody:
        $ref: '#/components/requestBodies/inline_object'
        content:
          application/json:
            schema:
              properties:
                url:
                  description: RMS Connect connection url.
                  example: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.proxy1-connect.rms.teltonika-networks.com
                  type: string
              required:
              - url
              type: object
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      summary: Restart RMS connection session.
      tags:
      - device access
  /devices/{id}/connect/webui:
    post:
      description: Generates a WebUI link for main device. For lan device see [Start
        a RMS Connect session](#operation/rmsConnect)
      operationId: connectWebui
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/connect_webui'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Generate a WebUI link for device.
      tags:
      - device access
  /devices/{id}/connect/cli:
    post:
      description: Generates a CLI link for a main device. For lan device see [Start
        a RMS Connect session](#operation/rmsConnect)
      operationId: connectCli
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/connect_cli'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Generate a CLI link
      tags:
      - device access
  /devices/connect/{access_id}:
    post:
      description: Start a RMS Connect session. Requires an already created remote
        access configuration.
      operationId: rmsConnect
      parameters:
      - description: Access id.
        in: path
        name: access_id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rms_connect'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Start a RMS Connect session
      tags:
      - device access
  /devices/connect/status:
    post:
      description: Returns the status of an RMS Connect connection.
      operationId: rmsConnectStatus
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rms_connect_status'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get the status of an RMS Connect connection
      tags:
      - device access
  /devices/connect/{access_id}/sessions:
    get:
      description: Returns RMS Connect sessions list.
      operationId: rmsConnectLinks
      parameters:
      - description: Access id.
        in: path
        name: access_id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: filter active RMS connect sessions.
        in: query
        name: active
        required: false
        schema:
          enum:
          - "true"
          - "false"
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_15'
          description: List of RMS connect sessions.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
      security:
      - BearerAuth: []
      summary: Get RMS Connect sessions.
      tags:
      - device access
  /devices/connect/sessions/{session_id}:
    delete:
      description: Close RMS Connect session.
      operationId: closeRmsConnectSession
      parameters:
      - description: RMS Connect session id.
        in: path
        name: session_id
        required: true
        schema:
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
      security:
      - BearerAuth: []
      summary: Close RMS Connect session.
      tags:
      - device access
  /devices/connect/logs:
    get:
      description: Returns RMS Connect sessions logs.
      operationId: rmsConnectLogs
      parameters:
      - description: filter active RMS connect sessions.
        in: query
        name: active
        required: false
        schema:
          enum:
          - "true"
          - "false"
          type: string
      - description: Filter RMS connect sessions by user id.
        in: query
        name: user_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Filter RMS connect sessions by type.
        in: query
        name: type
        required: false
        schema:
          enum:
          - webui
          - lan-webui
          - cli
          type: string
      - description: 'Start of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: start_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: 'End of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: end_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: Order data by specified field. Multiple values are allowed with
          comma separation. The dash symbol before field name indicates desc sorting
          direction.
        in: query
        name: sort
        required: false
        schema:
          enum:
          - start_date
          - end_date
          - company_name
          - input_data
          - output_data
          type: string
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_16'
          description: List of RMS connect sessions logs.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get RMS Connect sessions logs.
      tags:
      - device access
  /mobile-devices:
    get:
      description: Get mobile device from the system.
      operationId: mobileDeviceGetAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_17'
          description: Returned mobile devices list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get mobile devices
      tags:
      - mobile device
    post:
      description: Creates a mobile device from the system.
      operationId: mobileDeviceCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mobile_device_create'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Mobile device created.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Create a mobile device
      tags:
      - mobile device
  /mobile-devices/{id}:
    delete:
      description: Deletes a mobile device from the system.
      operationId: mobileDeviceDelete
      parameters:
      - description: Mobile device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Mobile device information was deleted.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Delete a mobile device
      tags:
      - mobile device
    get:
      description: Get single mobile device from the system.
      operationId: mobileDeviceGetOne
      parameters:
      - description: Mobile device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_18'
          description: Returned mobile device data.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get mobile device
      tags:
      - mobile device
    put:
      description: Edit mobile device.
      operationId: mobileDeviceUpdate
      parameters:
      - description: Mobile device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mobile_device_edit'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Mobile device updated.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Edit mobile devices
      tags:
      - mobile device
  /mobile-devices/connections:
    get:
      description: Get mobile device connection from the system.
      operationId: mobileDeviceConnectionGetAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Mobile device connection id filter.
        in: query
        name: id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Mobile device id filter for connection.
        in: query
        name: mobile_device_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Mobile device uuid filter for connection.
        in: query
        name: mobile_device_uuid
        required: false
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_19'
          description: Returned mobile device connections list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get mobile device connections
      tags:
      - mobile device connection
    post:
      description: Creates a mobile device connection from the system.
      operationId: mobileDeviceConnectionCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mobile_device_connection_create'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Mobile device connection created.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Create a mobile device connection
      tags:
      - mobile device connection
  /mobile-devices/connections/{id}:
    delete:
      description: Deletes a mobile device connection from the system.
      operationId: mobileDeviceConnectionDelete
      parameters:
      - description: Mobile device connection id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Mobile device connection information was deleted.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Delete a mobile device connection
      tags:
      - mobile device connection
    get:
      description: Get single mobile device connection from the system.
      operationId: mobileDeviceConnectionGetOne
      parameters:
      - description: Mobile device connection id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_20'
          description: Returned mobile device connection data.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get mobile device connection
      tags:
      - mobile device connection
    put:
      description: Edit mobile device connection.
      operationId: mobileDeviceConnectionUpdate
      parameters:
      - description: Mobile device connection id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mobile_device_connection_edit'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Mobile device connection updated.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Edit mobile device connection
      tags:
      - mobile device connection
  /mobile-devices/connections/access/:
    get:
      description: Gets all mobile device connections access.
      operationId: mobileDeviceConnectionAccessGetAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Order elements by specified field. Multiple values are allowed
          with comma separation. The dash symbol before field name indicates desc
          sorting direction.
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: Mobile device connection access id filter.
        in: query
        name: id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Filter by type.
        in: query
        name: type
        required: false
        schema:
          type: string
      - description: Mobile device uuid filter for connection.
        in: query
        name: status
        required: false
        schema:
          enum:
          - active
          - closed_by_user
          - expired
          - failed
          - out_of_data
          type: string
      - description: Mobile device id filter.
        in: query
        name: mobile_device_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Mobile device connection id filter.
        in: query
        name: mobile_device_connection_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Leaves only links that are not expired.
        in: query
        name: unexpired
        required: false
        schema:
          type: boolean
      - description: Webrtc user filter.
        in: query
        name: webrtc_user
        required: false
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_21'
          description: Returned mobile device connections access list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all mobile device connections access
      tags:
      - mobile device connection access
    post:
      description: Creates a access to mobile device connection.
      operationId: mobileDeviceConnectionAccessCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mobile_device_connection_access_create'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Create a mobile device connection access
      tags:
      - mobile device connection access
  /mobile-devices/connections/access/{id}/check:
    get:
      description: Checks single mobile device connections access.
      operationId: mobileDeviceConnectionAccessCheck
      parameters:
      - description: Mobile device connection access id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Check single mobile device connections access
      tags:
      - mobile device connection access
  /mobile-devices/connections/access/{id}/connect:
    post:
      description: Connects to a created mobile connection via access link.
      operationId: mobileDeviceConnectionAccessConnect
      parameters:
      - description: Mobile device connection access id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Connect to created mobile connection via access link
      tags:
      - mobile device connection access
  /mobile-devices/connections/access/{id}:
    delete:
      description: Close mobile device connections access.
      operationId: mobileDeviceConnectionAccessClose
      parameters:
      - description: Mobile device connection access id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Close mobile device connections access
      tags:
      - mobile device connection access
  /mobile-devices/connections/access/log:
    get:
      description: Gets all mobile device connections access logs.
      operationId: mobileDeviceConnectionAccessLogsGetAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Order elements by specified field. Multiple values are allowed
          with comma separation. The dash symbol before field name indicates desc
          sorting direction.
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: Mobile device connection access log id filter.
        in: query
        name: id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Mobile device uuid filter for connection.
        in: query
        name: status
        required: false
        schema:
          enum:
          - active
          - update
          - close
          type: string
      - description: Mobile device id filter.
        in: query
        name: mobile_device_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Mobile device connection access id filter.
        in: query
        name: mobile_device_connection_access_id
        required: false
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_22'
          description: Returned mobile device connections access list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all mobile device connections access logs
      tags:
      - mobile device connection access log
  /devices/remote-access:
    delete:
      description: Deletes a device's remote access configuration.
      operationId: deleteDeviceRemoteAccess
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/devices_remote_access_delete'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Delete device's remote access configuration
      tags:
      - device access
    get:
      description: Returns all remote access configurations of a specific device.
      operationId: getDeviceRemoteAccess
      parameters:
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Device id filter. Ids separated by column.
        in: query
        name: device_id
        required: false
        schema:
          example: 100,100,1000
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_23'
          description: Remote access of a device returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all device's remote access configurations
      tags:
      - device access
    post:
      description: Creates a remote access configuration for a specific device.
      operationId: postDeviceRemoteAccess
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/device_remote_access_post'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Create a remote access configuration
      tags:
      - device access
  /devices/remote-access/{access_id}:
    put:
      description: Updates device access rule.
      operationId: deviceAccessUpdate
      parameters:
      - description: Access id.
        in: path
        name: access_id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/devices_remote_access_update'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Update device access rule.
      tags:
      - device access
  /devices/{device_id}/remote-access/{action}:
    post:
      description: Does an action to a device's remote access.
      operationId: actionRemoteAccess
      parameters:
      - description: Device id.
        in: path
        name: device_id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Access id.
        in: path
        name: action
        required: true
        schema:
          enum:
          - check
          - unblock
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Do an action for remote access
      tags:
      - device access
  /devices/{id}/port-scan/:
    get:
      description: Get information about devices connected to ports
      operationId: getPortsInformation
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Type of device ports.
        in: query
        name: type
        required: true
        schema:
          enum:
          - ethernet
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get information about ports
      tags:
      - device access
  /devices/{id}/connect-auto-scan/:
    get:
      description: Get information about devices connected to ports
      operationId: getRmsConnectPortsInformation
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Device ports to scan.
        in: path
        name: ports
        required: true
        schema:
          example: 80,433
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get information rms connect ports
      tags:
      - device access
  /devices/actions:
    post:
      description: Executes a given action for a device list.
      operationId: deviceActionExecute
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/device_action'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Execute device action
      tags:
      - device actions
  /devices/updates/pending:
    get:
      description: Returns a list of all pending update actions.
      operationId: pendingUpdates
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_24'
          description: Pending devices updates returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all pending updates
      tags:
      - device update actions
  /devices/updates/set:
    post:
      description: Sets a device to update firmware or upload backup whenever possible.
        If the device in question is offline, it will update whenever it becomes online.
      operationId: setUpates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/set_updates'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Set updates
      tags:
      - device update actions
  /devices/updates/cancel:
    post:
      description: Cancels device updates for a given device.
      operationId: cancelUpates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cancel_updates'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_25'
          description: Updates canceled. Returns list of canceled updates.
        "207":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_207_1'
          description: Some updates canceled. Returns list of canceled updates, and
            list of errors.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_409'
          description: A conflict occurred.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Cancel updates
      tags:
      - device update actions
  /devices/actions/cancel:
    post:
      description: Cancels device action for a given device.
      operationId: cancelAction
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cancel_action'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Cancel action
      tags:
      - device update actions
  /devices/actions/logs:
    get:
      description: Get action log by device_id or tag_id.
      operationId: getActionLogs
      parameters:
      - description: Filter by device ID. Required if tag_id is not present.
        in: query
        name: device_id
        required: true
        schema:
          type: integer
      - description: Filter by tag ID. Required if device_id is not present.
        in: query
        name: tag_id
        required: true
        schema:
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_26'
          description: Action tag log response.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
      security:
      - BearerAuth: []
      summary: Get action logs
      tags:
      - device actions tag
  /devices/passwords/generated/tasks:
    get:
      description: Returns a list of all generated password tasks.
      operationId: getDevicePasswordsTasksList
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_27'
          description: Returned tasks list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get device passwords tasks list
      tags:
      - device passwords
  /devices/passwords/upload:
    post:
      description: Sets passwords for devices listed in a CSV file.
      operationId: uploadDevicePasswords
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/device_passwords_upload'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201_1'
          description: Devices passwords set successfully.
        "207":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_207_2'
          description: Some devices passwords set successfully, others failed.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_409'
          description: A conflict occurred.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Set passwords for devices from a file
      tags:
      - device passwords
  /tasks/{id}/download/passwords:
    get:
      description: Downloads passwords list by task batch id.
      operationId: downloadDevicePasswords
      parameters:
      - description: Task batch id.
        in: path
        name: id
        required: true
        schema:
          example: 0H4RIY7iLTm8bM0jk4rrlYzXshlc05PujH56PkbZqTlZJeLFNiVq2zWDU6TdN7L07oYwvF2jeAWfUju81WJus4qAfR0ODZXFv7h2
          type: string
      responses:
        "200":
          content:
            application/csv:
              schema:
                description: CSV file with passwords of devices.
                format: binary
                type: string
          description: File downloaded.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Download passwords
      tags:
      - device passwords
  /tasks/{id}/devices:
    get:
      description: Returns a list of devices that belong to a specified task.
      operationId: getTaskDevices
      parameters:
      - description: The id of a task.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_28'
          description: Returned list for devices of the task.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get task's devices
      tags:
      - device passwords
  /devices/passwords/generate:
    post:
      description: Generates new random password for given devices.
      operationId: generateDevicePassword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generate_password'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Generate passwords for given devices
      tags:
      - device passwords
  /devices/passwords/set:
    post:
      description: Set password for given devices.
      operationId: setDevicePassword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/set_passwords'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Set passwords for given devices
      tags:
      - device passwords
  /devices/credit:
    put:
      description: Control credits usage on device.
      operationId: deviceCreditCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/add_device_credit'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Create new credit for device
      tags:
      - device credits
  /devices/{id}/locations/history:
    get:
      description: Returns a single device's location history in the given time range.
      operationId: deviceLocationHistory
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: 'Start of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: start_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: 'End of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: end_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_29'
          description: Returned history of device locations.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get a device location history
      tags:
      - device locations
  /devices/{id}/information/{type}:
    get:
      description: Returns a single device's graphical statistics data.
      operationId: getDeviceGraphData
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Type of information to get.
        in: path
        name: type
        required: true
        schema:
          enum:
          - dynamic
          - io
          - gps
          type: string
      - description: 'Start of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: start_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: 'End of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: end_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_30'
          description: Device's information returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get a device graph data
      tags:
      - device graph
  /devices/tags/{id}/data:
    get:
      description: Returns a single parameter's data from devices that have a specific
        tag assigned.
      operationId: getTagGroupData
      parameters:
      - description: Tag id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: 'Parameter whose data must be returned. Available options: temperature,
          signal, sent, received, analog_input, satellites, speed'
        in: query
        name: parameter
        required: true
        schema:
          type: string
      - description: 'Start of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: start_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: 'End of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: end_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_31'
          description: Devices with same tag data returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get single parameter data of a tag devices
      tags:
      - device graph
  /devices/tags/{id}/group/data:
    get:
      description: Returns a single parameter's maximum and minimum data from devices
        that have a specific tag assigned.
      operationId: getTagDetailedGroup
      parameters:
      - description: Tag id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: 'Parameter whose data must be returned. Available options: temperature,
          signal, sent, received, analog_input, satellites, speed'
        in: query
        name: parameter
        required: true
        schema:
          type: string
      - description: 'Start of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: start_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: 'End of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: end_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_31'
          description: Devices with same tag data returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get single tag devices group's detailed information
      tags:
      - device graph
  /devices/companies/{id}/data:
    get:
      description: Returns a single parameter's data from devices that have belong
        to a specific company.
      operationId: getCompanyGroupData
      parameters:
      - description: Tag id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: 'Parameter whose data must be returned. Available options: temperature,
          signal, sent, received, analog_input, satellites, speed'
        in: query
        name: parameter
        required: true
        schema:
          type: string
      - description: 'Start of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: start_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: 'End of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: end_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_31'
          description: Devices with same tag data returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get single parameter data of a company devices
      tags:
      - device graph
  /devices/companies/{id}/group/data:
    get:
      description: Returns a single parameter's maximum and minimum data from devices
        that belong to a specific company.
      operationId: getCompanyDetailedGroup
      parameters:
      - description: Tag id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: 'Parameter whose data must be returned. Available options: temperature,
          signal, sent, received, analog_input, satellites, speed'
        in: query
        name: parameter
        required: true
        schema:
          type: string
      - description: 'Start of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: start_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: 'End of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: end_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_31'
          description: Devices with same tag data returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get single company devices group's detailed information
      tags:
      - device graph
  /devices/{id}/information-history:
    get:
      description: Returns a single device's update information history.
      operationId: getInformationHistory
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Specific date and time to extract device data at that time moment.
        in: query
        name: datetime
        required: true
        schema:
          format: date-time
          pattern: Y-m-d H:i:s
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_32'
          description: Device update information history returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get device's update information history
      tags:
      - information history
  /devices/{id}/information-history/parameter:
    get:
      description: Returns a single device's update information history of a specific
        parameter.
      operationId: getParameterInformationHistory
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Specific date and time to extract device data at that time moment.
        in: query
        name: datetime
        required: true
        schema:
          format: date-time
          pattern: Y-m-d H:i:s
          type: string
      - description: Specified parameter, whose information must be returned.
        in: query
        name: parameter
        required: true
        schema:
          enum:
          - firmware
          - sim_state
          - pin_state
          - sim_slot
          - network_state
          - mobile_ip
          - signal
          - operator
          - operator_number
          - connection_state
          - connection_type
          - temperature
          - router_uptime
          - connection_uptime
          - wan_state
          - wan_ip
          - cell_id
          - mcc
          - mnc
          - lac
          - iccid
          - rx_day
          - rx_week
          - rx_month
          - tx_day
          - tx_week
          - tx_month
          - period
          - sent
          - received
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_33'
          description: Device update information of single parameter history returned
            successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get device parameter's update information history
      tags:
      - information history
  /devices/{id}/information-history/datetimes:
    get:
      description: Returns a list of dates and times when the given device was updated.
      operationId: getDatetimesInformationHistory
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_34'
          description: Dates and times for a device returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get dates and times for a device
      tags:
      - information history
  /devices/{id}/data-usage:
    get:
      description: Returns device data usage in a given time range.
      operationId: getDeviceDataUsage
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: 'Start of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: start_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: 'End of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: end_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_35'
          description: Device data usage returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get device data usage
      tags:
      - data usage
  /devices/statistics:
    get:
      description: Returns statistics of aggregated device information.
      operationId: aggregatedDevicehStats
      parameters:
      - description: Charts to be returned.
        in: query
        name: charts
        required: true
        schema:
          enum:
          - model
          - status
          - firmware
          - network_state
          - network_state_2
          - signal
          - signal_2
          - connection_type
          - connection_type_2
          - wan_state
          - operator
          - operator_2
          - information_updated
          - modem_manufacturer
          - modem_manufacturer_2
          - modem_firmware
          - modem_firmware_2
          - modem_model
          - modem_model_2
          - task
          type: string
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: Model name filter
        in: query
        name: model
        required: false
        schema:
          type: string
      - description: Firmware filter
        in: query
        name: firmware
        required: false
        schema:
          type: string
      - description: Connection type filter
        in: query
        name: connection_type
        required: false
        schema:
          type: string
      - description: Connection type filter
        in: query
        name: connection_type_2
        required: false
        schema:
          type: string
      - description: Signal filter
        in: query
        name: signal
        required: false
        schema:
          type: string
      - description: Signal filter
        in: query
        name: signal_2
        required: false
        schema:
          type: string
      - description: Status filter
        in: query
        name: status
        required: false
        schema:
          type: string
      - description: Wan state filter
        in: query
        name: wan_state
        required: false
        schema:
          type: string
      - description: Network state filter
        in: query
        name: network_state
        required: false
        schema:
          type: string
      - description: Network state filter
        in: query
        name: network_state_2
        required: false
        schema:
          type: string
      - description: Information last update filter
        in: query
        name: information_updated
        required: false
        schema:
          type: string
      - description: Operator filter
        in: query
        name: operator
        required: false
        schema:
          type: string
      - description: Operator filter
        in: query
        name: operator_2
        required: false
        schema:
          type: string
      - description: Modem manufacturer filter
        in: query
        name: modem_manufacturer
        required: false
        schema:
          type: string
      - description: Modem manufacturer filter
        in: query
        name: modem_manufacturer_2
        required: false
        schema:
          type: string
      - description: Modem model filter
        in: query
        name: modem_model
        required: false
        schema:
          type: string
      - description: Modem model filter
        in: query
        name: modem_model_2
        required: false
        schema:
          type: string
      - description: Modem firmware filter
        in: query
        name: modem_firmware
        required: false
        schema:
          type: string
      - description: Modem firmware filter
        in: query
        name: modem_firmware_2
        required: false
        schema:
          type: string
      - description: Task filter
        in: query
        name: task
        required: false
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_36'
          description: Stats returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get devices statistics
      tags:
      - statistics
  /hotspots:
    get:
      description: Returns all available hotspots information.
      operationId: hotspotsAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Hotspot ssid names filters. (not_null filter out null values)
        in: query
        name: ssid_names
        required: false
        schema:
          type: string
      - description: Device status filter.
        in: query
        name: status
        required: false
        schema:
          enum:
          - online
          - offline
          - not_activated
          type: string
      - description: Device model filter.
        in: query
        name: model
        required: false
        schema:
          type: string
      - description: Device firmware filter.
        in: query
        name: firmware
        required: false
        schema:
          type: string
      - description: Hotspot device company id filter
        in: query
        name: company_id
        required: false
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_37'
          description: Hotspots information returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all hotspots information
      tags:
      - hotspots
  /devices/{id}/hotspots:
    get:
      description: Returns all available hotspots information about a single device.
      operationId: deviceHotspotsA
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_38'
          description: Hotspot information returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get device hotspots information
      tags:
      - hotspots
  /devices/{id}/hotspots/{index}/users:
    delete:
      description: Deletes a hotspot user.
      operationId: hotspotUsersDelete
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Hotspot index.
        in: path
        name: index
        required: true
        schema:
          example: 2
          maximum: 4
          minimum: 1
          type: integer
      - description: User name
        in: query
        name: username
        required: true
        schema:
          example: username123
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Delete hotspot user
      tags:
      - hotspots
    get:
      description: Returns channel to a device's hotspot users.
      operationId: hotspotUsers
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Hotspot index.
        in: path
        name: index
        required: true
        schema:
          example: 2
          maximum: 4
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
      security:
      - BearerAuth: []
      summary: Get hotspot users
      tags:
      - hotspots
    post:
      description: Creates a new hotspot user.
      operationId: hotspotUsersAdd
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Hotspot index.
        in: path
        name: index
        required: true
        schema:
          example: 2
          maximum: 4
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/user_add'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Create user for hotspot
      tags:
      - hotspots
  /devices/{id}/hotspots/{index}/users/active:
    get:
      description: Returns device hotspot's active users.
      operationId: hotspotActiveUsers
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Hotspot index.
        in: path
        name: index
        required: true
        schema:
          example: 2
          maximum: 4
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_39'
          description: Returned hotspot active users successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get hotspot active users
      tags:
      - hotspots
  /reports:
    get:
      description: Returns a list of report templates.
      operationId: reportsAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: Filters reports by their period type
        in: query
        name: period
        required: false
        schema:
          enum:
          - single
          - periodic
          example: periodic
          type: string
      - description: Filters reports by company id
        in: query
        name: company_id
        required: false
        schema:
          example: 1
          minimum: 1
          type: integer
      - description: Filters reports by what they apply to
        in: query
        name: applied_by
        required: false
        schema:
          example: device
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_40'
          description: Reports returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get list of reports
      tags:
      - reports
    post:
      description: Creates a new report template.
      operationId: reportAdd
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reports_add'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Report created successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Create new report
      tags:
      - reports
  /reports/{id}/generate:
    post:
      description: Generates a report using a given report template.
      operationId: reportGenerate
      parameters:
      - description: Report id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Generate a report
      tags:
      - reports
  /reports/{id}:
    delete:
      description: Deletes report specified by ID.
      operationId: reportDelete
      parameters:
      - description: Report id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Report deleted successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Delete report
      tags:
      - reports
    put:
      description: Updates a report template that is specified by ID.
      operationId: reportUpdate
      parameters:
      - description: Report id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reports_update'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Report updated successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Update report information
      tags:
      - reports
  /reports/generated:
    get:
      description: Returns a list of generated reports.
      operationId: generatedReportsAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: Filters reports by their report template id.
        in: query
        name: report_template_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Filters reports by company id.
        in: query
        name: company_id
        required: false
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_41'
          description: Generated reports returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get list of generated reports
      tags:
      - generated reports
  /reports/generated/{id}:
    delete:
      description: Deletes a generated report.
      operationId: generatedReportDelete
      parameters:
      - description: Generated report id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Removed generated report.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Delete generated report
      tags:
      - generated reports
    get:
      description: Returns a generated report specified by ID.
      operationId: generatedReportGet
      parameters:
      - description: Generated report id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_42'
          description: Generated report returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get generated report
      tags:
      - generated reports
    put:
      description: Updates the name and description of a generated report.
      operationId: generatedReportEdit
      parameters:
      - description: Generated report id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generated_report_edit'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Updated generated report information.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Edit generated report
      tags:
      - generated reports
  /reports/generated/{id}/pdf:
    get:
      description: Downloads a generated single report in PDF format.
      operationId: generatedReportPdf
      parameters:
      - description: Generated report id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/pdf:
              schema:
                example: report.pdf
                format: binary
                type: string
          description: A PDF file returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get the report in the PDF format
      tags:
      - generated reports
  /credits:
    get:
      description: Returns credits list.
      operationId: creditsAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: Filter by company id.
        in: query
        name: company_id
        required: false
        schema:
          example: 1000
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_43'
          description: Returned list of credits successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get credits list
      tags:
      - credits
  /credits/summary:
    get:
      description: Returns a summary of available credits.
      operationId: creditsSummary
      parameters:
      - description: Filter by company id.
        in: query
        name: company_id
        required: false
        schema:
          example: 1000
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_44'
          description: Credits summary returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get summary of company's credits
      tags:
      - credits
  /credits/history:
    get:
      description: Returns all available credit history.
      operationId: creditsHistory
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: Device id filter.
        in: query
        name: device_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Pool id filter.
        in: query
        name: pool_id
        required: false
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_45'
          description: Credits history returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get credits history
      tags:
      - credits
  /credits/move/history:
    get:
      description: Returns all available credit pool move history.
      operationId: creditsMoveHistory
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Pool id filter.
        in: query
        name: pool_id
        required: false
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_46'
          description: Credits move history returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get credits pool move history
      tags:
      - credits
  /credits/{id}/report:
    get:
      description: Downloads a credit pool report in PDF format.
      operationId: creditReport
      parameters:
      - description: Credit id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/pdf:
              schema:
                example: report.pdf
                format: binary
                type: string
          description: A PDF file returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Return the pool report in the PDF format
      tags:
      - credits
  /credits/report:
    get:
      description: Downloads a credit usage report in PDF format.
      operationId: creditDateReport
      parameters:
      - description: Target company id.
        in: query
        name: company_id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Range start date.
        in: query
        name: start_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: Range end date.
        in: query
        name: end_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      responses:
        "200":
          content:
            application/pdf:
              schema:
                example: report.pdf
                format: binary
                type: string
          description: A PDF file returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Return credits usage report by dates.
      tags:
      - credits
  /credits/report/json:
    get:
      description: Returns credit usage report in JSON format.
      operationId: creditDateJsonReport
      parameters:
      - description: Target company id.
        in: query
        name: company_id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Range start date.
        in: query
        name: start_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: Range end date.
        in: query
        name: end_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_47'
          description: Credits move history returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Return credits usage report by dates.
      tags:
      - credits
  /credits/move:
    post:
      description: Moves credits from one company to another.
      operationId: creditsMove
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/credits_move'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Credits moved successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Move credits
      tags:
      - credits
  /credits/codes:
    get:
      description: Returns all created credit tokens.
      operationId: creditsTokensAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: Filter by company id.
        in: query
        name: company_id
        required: false
        schema:
          example: 1000
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_48'
          description: Credits tokens returned.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all credits tokens
      tags:
      - credits codes
    post:
      description: Creates a credit code.
      operationId: creditsTokensAdd
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/credits_tokens_add'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201_2'
          description: Code created.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Create credit code
      tags:
      - credits codes
  /credits/codes/activate:
    post:
      description: Activates a credit code.
      operationId: creditsTokensActivate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/credits_tokens_activate'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_49'
          description: Credit code activated and credits added.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Activate credit code
      tags:
      - credits codes
  /credits/codes/{id}:
    delete:
      description: Deletes a credit code. The associated credit(-s) will return to
        the company that created it.
      operationId: creditsTokensDelete
      parameters:
      - description: Token id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Credit code deleted.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Delete credit code
      tags:
      - credits codes
    put:
      description: Updates the comment of a credit code.
      operationId: creditsTokensEdit
      parameters:
      - description: Token id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/credits_token_edit'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Code updated.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Update credit code
      tags:
      - credits codes
  /alerts:
    get:
      description: Returns a list of all alerts.
      operationId: alertsAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: 'Filter entries by id. For example: 7441,5558,7410'
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: Company id filter.
        in: query
        name: company_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Alerts configs id filter.
        in: query
        name: alerts_configs_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Device id filter.
        in: query
        name: device_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Alerts type filter.
        in: query
        name: type
        required: false
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_50'
          description: Alerts returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all alerts
      tags:
      - alerts
  /alerts/{id}:
    delete:
      description: Deletes a device alert.
      operationId: alertsDelete
      parameters:
      - description: Alert id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Alert deleted successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
      security:
      - BearerAuth: []
      summary: Delete alert
      tags:
      - alerts
    get:
      description: Returns information about a specific alert.
      operationId: alertsGetSingle
      parameters:
      - description: Alert id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_51'
          description: Alert returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
      security:
      - BearerAuth: []
      summary: Get alert
      tags:
      - alerts
  /alerts/token:
    post:
      description: Creates a new alert token.
      operationId: alertsTokenAdd
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/alerts_token_add'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Token created.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Add alert token
      tags:
      - alerts
  /alerts-configurations:
    get:
      description: Returns a list of all available alert configurations.
      operationId: alertsConfigurationsGetAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Company id filter.
        in: query
        name: company_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: User id filter.
        in: query
        name: user_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Device id filter.
        in: query
        name: device_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Alerts type filter
        in: query
        name: type
        required: false
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_52'
          description: Alert configurations returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all alerts configurations
      tags:
      - alerts configurations
  /alerts-configurations/{id}:
    get:
      description: Returns a single alert configuration.
      operationId: alertsConfigurationsGetSingle
      parameters:
      - description: Alert configuration id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_53'
          description: Alert configuration returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
      security:
      - BearerAuth: []
      summary: Get alert configuration
      tags:
      - alerts configurations
    put:
      description: Edits a single alert configuration.
      operationId: alertsConfigurationsEdit
      parameters:
      - description: Alert configuration id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/alert_config_update'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Updated alert configuration.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Edit alert configuration
      tags:
      - alerts configurations
  /devices/alerts-configurations:
    get:
      description: Returns channel link to list of all alerts configurations of a
        vpn device.
      operationId: vpnDeviceAlertsConfigurationsGetChannelForAll
      parameters:
      - description: Device id (device must be vpn type).
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get link for vpn device's alerts configurations list
      tags:
      - alerts configurations
    post:
      description: Adds a new alert configuration for a device.
      operationId: alertsConfigurationsAdd
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/alert_config_add'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Add alert configuration
      tags:
      - alerts configurations
  /devices/{device_id}/alerts-configurations/{alert_id}:
    delete:
      description: Deletes an alert configuration from a device.
      operationId: alertsConfigurationsDelete
      parameters:
      - description: Device id
        in: path
        name: device_id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Alert config id
        in: path
        name: alert_id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Deleted alert configuration for a device.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Deletes alert configuration
      tags:
      - alerts configurations
  /email-configurations:
    get:
      description: Returns a list of all created email configurations.
      operationId: emailConfigurationsGetAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Company id filter.
        in: query
        name: company_id
        required: false
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_54'
          description: Email configurations returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all email configurations
      tags:
      - email configurations
    post:
      description: Adds a new email configuration. Used for alert creation.
      operationId: emaidlConfigurationsAdd
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/email_configs_add'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Email configuration created.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Add email configuration
      tags:
      - email configurations
  /email-configurations/{id}:
    delete:
      description: Deletes an email configuration.
      operationId: emailConfigurationsDelete
      parameters:
      - description: Email configuration id
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Email configuration deleted successfully.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_409'
          description: A conflict occurred.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Delete email configuration
      tags:
      - email configurations
    put:
      description: Edits an email configuration.
      operationId: emailConfigurationsEdit
      parameters:
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Email configuration id
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/email_configs_edit'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Email configuration updated successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Edit email configuration
      tags:
      - email configurations
  /files:
    get:
      description: Returns a list of all available files.
      operationId: filesGetAll
      parameters:
      - description: Device id filter. (Can have is_null and not_null, to know if
          it is device's file)
        in: query
        name: device_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_55'
          description: List of files returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get available files
      tags:
      - files
    post:
      description: Uploads a valid firmware or backup configuration file to RMS.
      operationId: filesAdd
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/files_add'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_56'
          description: Successfully uploaded file.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_409'
          description: A conflict occurred.
      security:
      - BearerAuth: []
      summary: Upload file to server
      tags:
      - files
  /files/{id}:
    delete:
      description: Deletes an uploaded file from RMS.
      operationId: filesDelete
      parameters:
      - description: The file identifier.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: File successfully deleted.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Delete a file
      tags:
      - files
    get:
      description: Get single file information.
      operationId: getFileInformation
      parameters:
      - description: The file identifier.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_57'
          description: List of files returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get single file information.
      tags:
      - files
    put:
      description: Edits the description of a given file.
      operationId: filesEdit
      parameters:
      - description: The file identifier.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/files_update'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: File updated.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_409'
          description: A conflict occurred.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Edit file
      tags:
      - files
  /files/{id}/download:
    get:
      description: Downloads file specified by id.
      operationId: fileDownload
      parameters:
      - description: The file identifier.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: string
      responses:
        "200":
          content:
            application/octet-stream:
              schema:
                example: file.fw
                format: binary
                type: string
          description: File downloaded.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Download a file
      tags:
      - files
  /files/download/zip:
    post:
      description: Downloads the given files in ZIP format.
      operationId: filesDownloadZip
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/files_download_zip'
      responses:
        "200":
          content:
            application/zip:
              schema:
                example: files.zip
                format: binary
                type: string
          description: Zip file downloaded.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Download archived files
      tags:
      - files
  /wireless:
    get:
      description: Returns a list of all devices whose wireless access points are
        monitored.
      operationId: wirelessGetAll
      parameters:
      - description: Filter of wireless id. (not_null will filter out null values)
        in: query
        name: wireless_id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_58'
          description: Wireless devices returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Retrieve wireless devices
      tags:
      - wireless
  /devices/{device_id}/wireless:
    get:
      description: Returns wireless access point information of a specific device.
      operationId: wirelessGetDevice
      parameters:
      - description: Id of device.
        in: path
        name: device_id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_59'
          description: Information returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Retrieve wireless device's information
      tags:
      - wireless
  /devices/{device_id}/wireless/graph:
    get:
      description: Returns a specific device's wireless access point graph information.
      operationId: wirelessGraph
      parameters:
      - description: List of wlan id seprated by commas.
        in: query
        name: wlan
        required: true
        schema:
          type: string
      - description: Id of device.
        in: path
        name: device_id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_60'
          description: Graph data returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get data wireless graph
      tags:
      - wireless
  /devices/tasks:
    get:
      description: Returns a list of all device task.
      operationId: deviceTaskAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Order elements by specified field. Multiple values are allowed
          with comma separation. The dash symbol before field name indicates desc
          sorting direction.
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: Company id filter.
        in: query
        name: company_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Type filter.
        in: query
        name: type
        required: false
        schema:
          type: string
      - description: Group id filter.
        in: query
        name: group_id
        required: false
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_61'
          description: Device tasks returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all device task
      tags:
      - device tasks
  /devices/tasks/{id}:
    delete:
      description: Deletes a device task.
      operationId: deviceTaskDelete
      parameters:
      - description: Device task id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Task deleted.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
      security:
      - BearerAuth: []
      summary: Delete device task
      tags:
      - device tasks
    put:
      description: Updates device task information.
      operationId: deviceTaskEdit
      parameters:
      - description: Device task id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/device_tasks_edit'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Task updated.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Update device task information
      tags:
      - device tasks
  /devices/tasks/groups:
    get:
      description: Returns a list of all device task groups.
      operationId: deviceTaskGroupAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Indicator to return only available fields for fields selection.
        in: query
        name: fields_only
        required: false
        schema:
          default: false
          type: boolean
      - description: Order elements by specified field. Multiple values are allowed
          with comma separation. The dash symbol before field name indicates desc
          sorting direction.
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: Company id filter.
        in: query
        name: company_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Name filter.
        in: query
        name: name
        required: false
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_62'
          description: Device task groups returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all device task groups
      tags:
      - device task groups
    post:
      description: Creates a device task group.
      operationId: deviceTaskGroupCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/device_task_groups_create'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Device task group created.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Create device task group
      tags:
      - device task groups
  /devices/tasks/groups/{id}:
    delete:
      description: Deletes a device task.
      operationId: deviceTaskDelete
      parameters:
      - description: Device task group id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Device task group deleted.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
      security:
      - BearerAuth: []
      summary: Delete device task
      tags:
      - device task groups
    get:
      description: Gets single device task group information.
      operationId: deviceTaskGroupSingleGet
      parameters:
      - description: Device task group id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_63'
          description: Device task group returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
      security:
      - BearerAuth: []
      summary: Get single device task group information
      tags:
      - device task groups
    post:
      description: Executes device task group.
      operationId: deviceTaskGroupExecute
      parameters:
      - description: Device task group id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/device_task_groups_execute'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Execute device task group
      tags:
      - device task groups
    put:
      description: Updates device task group information.
      operationId: deviceTaskGroupEdit
      parameters:
      - description: Device task group id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/device_task_groups_edit'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Device task group updated.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Update device task group information
      tags:
      - device task groups
  /devices/tasks/logs:
    get:
      description: Returns a list of all device task logs.
      operationId: deviceTaskLogsGetAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Order elements by specified field. Multiple values are allowed
          with comma separation. The dash symbol before field name indicates desc
          sorting direction.
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: Type filter.
        in: query
        name: type
        required: false
        schema:
          type: string
      - description: Group log id filter.
        in: query
        name: group_log_id
        required: false
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_64'
          description: Device task logs returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all device task logs
      tags:
      - device task logs
  /devices/tasks/logs/{id}:
    get:
      description: Returns a single device task log.
      operationId: deviceTaskLogGetSingle
      parameters:
      - description: Device task log id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_65'
          description: Device task log returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
      security:
      - BearerAuth: []
      summary: Get device task log
      tags:
      - device task logs
  /devices/tasks/groups/logs:
    get:
      description: Returns a list of all device task group logs.
      operationId: deviceTaskGroupLogsAll
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: List of fields to be returned, separated with commas. Available
          fields are those which can be returned, so to see them reference to response.
          Some endpoints have "fields only" function implemented, it returns all available
          fields.
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Order elements by specified field. Multiple values are allowed
          with comma separation. The dash symbol before field name indicates desc
          sorting direction.
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: Device id filter.
        in: query
        name: device_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Status filter.
        in: query
        name: status
        required: false
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_66'
          description: Device task group logs returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get all device task group logs
      tags:
      - device task group logs
  /devices/tasks/groups/logs/{id}:
    get:
      description: Returns a single device task log.
      operationId: deviceTaskGroupLogGetSingle
      parameters:
      - description: Device task group log id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_67'
          description: Device task group log returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
      security:
      - BearerAuth: []
      summary: Get device task log
      tags:
      - device task group logs
  /devices/{id}/command:
    post:
      description: Executes command for a device.
      operationId: devicesCommandExecute
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/execute_command'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Execute command for a device
      tags:
      - device commands
  /roles:
    get:
      description: Returns information about a available roles.
      operationId: getRolesAll
      parameters:
      - description: Company id.
        in: query
        name: company_id
        required: false
        schema:
          minimum: 1
          type: integer
      - description: Role type.
        in: query
        name: type
        required: false
        schema:
          enum:
          - default
          - custom
          type: string
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_68'
          description: Returned roles list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get available roles
      tags:
      - roles
    post:
      description: Create a single role.
      operationId: createRole
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/role_create'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Role created.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Create role
      tags:
      - roles
  /roles/{id}:
    delete:
      description: Delete a single role.
      operationId: deleteRole
      parameters:
      - description: Role id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Role successfully deleted.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Delete role
      tags:
      - roles
    get:
      description: Returns information about a single role.
      operationId: getRole
      parameters:
      - description: Role id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_69'
          description: Returned single role.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
      security:
      - BearerAuth: []
      summary: Get single role's information
      tags:
      - roles
    put:
      description: Update a single role.
      operationId: updateRole
      parameters:
      - description: Role id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/role_update'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Role updated.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Update role
      tags:
      - roles
  /roles/{id}/permissions:
    get:
      description: Returns information about a single roles permissions.
      operationId: getRolePermissions
      parameters:
      - description: Role id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_70'
          description: Returned roles permissions list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
      security:
      - BearerAuth: []
      summary: Get role's permission information
      tags:
      - roles
  /roles/permissions:
    put:
      description: Overwrites permissions for multiple roles.
      operationId: updateRolesPermissions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/roles_permissions_update'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Role updated.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_404'
          description: Resource not found.
      security:
      - BearerAuth: []
      summary: Overwrite permissions for multiple roles
      tags:
      - roles
  /companies/data:
    post:
      description: Exchange credits to RMS connect data.
      operationId: creditsExchangeToData
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/exchange_credits'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Credits exchanged.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Exchange credits to RMS connect data.
      tags:
      - RMS Connect data exchange
  /companies/data/history:
    get:
      description: Returns all company data purchases.
      operationId: companyDataPurchaseHistory
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: Filter by company id.
        in: query
        name: company_id
        required: false
        schema:
          example: 1000
          minimum: 1
          type: integer
      - description: Range start date.
        in: query
        name: start_date
        required: false
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: Range end date.
        in: query
        name: end_date
        required: false
        schema:
          example: Y-m-d H:i:s
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_71'
          description: Company data history returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get company data purchase history
      tags:
      - Company data purchase history
  /vpn/hubs:
    delete:
      description: Delete vpn hubs.
      operationId: deleteVPNhubs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vpn_hub_delete'
      responses:
        "0":
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: VPN hub deleted successfully.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: VPN hub deleted successfully.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Delete vpn hubs.
      tags:
      - vpn
    get:
      description: Get vpn hubs.
      operationId: getVPNhubs
      parameters:
      - description: Id of company.
        in: path
        name: company_id
        required: true
        schema:
          example: 1
          type: integer
      - description: VPN hub status.
        in: path
        name: enabled
        required: true
        schema:
          example: 1
          type: integer
      - description: Id of company.
        in: path
        name: tag_id
        required: true
        schema:
          example: 1
          type: integer
      - in: path
        name: quick_hub
        required: true
        schema:
          example: 1
          type: integer
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_72'
          description: VPN hub list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get vpn hubs.
      tags:
      - vpn
    post:
      description: Create vpn hubs.
      operationId: createVPNhubs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vpn_hub_add'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No company_id parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No company_id parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 10002:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No hub_name parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10002
                              type: object
                            value:
                              example: No hub_name parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -1:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Unable to create vpn configuration. Please try again.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: Unable to create vpn configuration. Please
                                try again.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -2:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Company has no data left.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -2
                              type: object
                            value:
                              example: Company has no data left.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -3:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Failed to create VPN hub.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -3
                              type: object
                            value:
                              example: Failed to create VPN hub.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -4:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Unable to generate IP.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -4
                              type: object
                            value:
                              example: Unable to generate IP.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: VPN hub created.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: VPN hub created.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -5:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Failed to create VPN hub.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -5
                              type: object
                            value:
                              example: Failed to create VPN hub.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
      security:
      - BearerAuth: []
      summary: Create vpn hubs.
      tags:
      - vpn
  /vpn/hubs/connect:
    post:
      description: Create quick vpn hubs.
      operationId: createQuickVPNHubs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vpn_quick_hub_add'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No company_id parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No company_id parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 10002:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No hub_name parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10002
                              type: object
                            value:
                              example: No hub_name parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -1:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Unable to create vpn configuration. Please try again.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: Unable to create vpn configuration. Please
                                try again.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -2:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Company has no data left.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -2
                              type: object
                            value:
                              example: Company has no data left.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -3:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Failed to create VPN hub.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -3
                              type: object
                            value:
                              example: Failed to create VPN hub.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -4:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Unable to generate IP.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -4
                              type: object
                            value:
                              example: Unable to generate IP.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: VPN hub created.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: VPN hub created.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -5:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Failed to create VPN hub.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -5
                              type: object
                            value:
                              example: Failed to create VPN hub.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
      security:
      - BearerAuth: []
      summary: Create quick vpn hubs.
      tags:
      - vpn
  /vpn/hubs/zones:
    get:
      description: Get vpn hub zones.
      operationId: getVPNHubsZones
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_73'
          description: Get available vpn hub locations.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get available vpn hub zones.
      tags:
      - vpn
  /vpn/hubs/{id}/info:
    get:
      description: Get vpn hubs information.
      operationId: getVPNHubsInfo
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      responses:
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseResponseModel'
                - description: Vpn hub info
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            server_ip:
                              description: VPN hub server ip.
                              example: 192.168.255.0
                              type: string
                            server_netmask:
                              description: VPN hub server mask.
                              type: string
                            bytes_received:
                              description: VPN hub session bytes received.
                              type: integer
                            state:
                              description: VPN hub state.
                              type: string
                            bytes_sent:
                              description: VPN hub session bytes sent.
                              type: integer
                            visual_name:
                              description: VPN hub name.
                              type: string
                            total_bytes_used:
                              description: Total VPN hub bytes used.
                              type: integer
                            company_id:
                              description: VPN hub company id
                              type: integer
                            description:
                              description: VPN hub description
                              type: string
                            enabled:
                              description: VPN hub status.
                              type: boolean
                            id:
                              description: VPN hub id.
                              type: integer
                            running:
                              description: VPN hub running.
                              type: boolean
                            number_of_sessions:
                              description: VPN hub number of sessions.
                              type: integer
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get vpn hubs information.
      tags:
      - vpn
  /vpn/hubs/{id}/sessions:
    get:
      description: Get vpn hubs sessions.
      operationId: getVPNHubsSession
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      responses:
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseResponseModel'
                - description: Vpn hub sessions
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            vpn_sessions:
                              description: VPN hub sessions array.
                              items:
                                description: VPN hub session object.
                                properties:
                                  name:
                                    description: VPN hub user name.
                                    type: string
                                  ip:
                                    description: VPN client public ip.
                                    type: string
                                  object_id:
                                    description: VPN hub user object id.
                                    type: integer
                                  bytes_used:
                                    description: VPN session bytes used.
                                    type: integer
                                  type:
                                    description: VPN hub user type ['device', 'custom_user',
                                      'rms_user']
                                    type: string
                                  connected_since:
                                    description: Session connected since.
                                    type: integer
                                  vpn_ip:
                                    description: VPN session ip.
                                    type: string
                                type: object
                              type: array
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -1:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: An error occurred. Please try again
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: An error occurred. Please try again
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get vpn hubs sessions.
      tags:
      - vpn
  /vpn/hubs/{id}/devices/rules:
    get:
      description: Get router vpn forwarding rules.
      operationId: getVPNHubsDevicesForwardingRules
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      - description: List of devices id as string.
        in: path
        name: device_id
        required: true
        schema:
          example: 1,2,3
          type: string
      responses:
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No hub_id parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No hub_id parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseResponseModel'
                - description: Get firewall options
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            lan:
                              description: VPN to lan zone forwarding status
                              type: boolean
                            wan:
                              description: VPN to wan zone forwarding status
                              type: boolean
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -1:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: An error occurred. Please try again
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: An error occurred. Please try again
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get router vpn forwarding rules.
      tags:
      - vpn
  /vpn/hubs/{id}/devices:
    delete:
      description: Delete device from VPN hub.
      operationId: deleteDeviceToVPNHubs
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vpn_hub_delete_device'
      responses:
        "10001":
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No hub_id parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No hub_id parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "-1":
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Unable to find VPN hub.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: Unable to find VPN hub.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "-2":
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Failed to delete RMS device. Please try again.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -2
                              type: object
                            value:
                              example: Failed to delete RMS device. Please try again.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "0":
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: User successfully removed from VPN hub.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: User successfully removed from VPN hub.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Delete device from VPN hub.
      tags:
      - vpn
    post:
      description: Add device to VPN hub.
      operationId: addDeviceToVPNHubs
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vpn_hub_add_device'
      responses:
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No hub_id parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No hub_id parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -1:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Failed to add device to VPN hub (try again)
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: Failed to add device to VPN hub (try again)
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: Device successfully added to VPN hub.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: Device successfully added to VPN hub.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Add device to VPN hub.
      tags:
      - vpn
  /vpn/hubs/{id}/devices/{device_id}/rules:
    post:
      description: Change device rules.
      operationId: changeDeviceToVPNHubsRules
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      - description: List of devices id as string.
        in: path
        name: device_id
        required: true
        schema:
          example: 1,2,3
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/store_device_rules'
      responses:
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No status parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No status parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 10002:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No network parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10002
                              type: object
                            value:
                              example: No network parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 10003:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No hub_id parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10003
                              type: object
                            value:
                              example: No hub_id parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -1:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Failed to find VPN hub.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: Failed to find VPN hub.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: Forwarding successfully $1
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: Forwarding successfully $1
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Change device rules.
      tags:
      - vpn
  /vpn/hubs/{id}/devices/{device_id}/sync:
    post:
      description: Sync VPN config to device.
      operationId: syncVPNConfigToDevice
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      - description: List of devices id as string.
        in: path
        name: device_id
        required: true
        schema:
          example: 1,2,3
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Sync VPN config to device.
      tags:
      - vpn
  /vpn/hubs/{id}:
    put:
      description: Update vpn hubs.
      operationId: updateVPNhubs
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vpn_hub_update'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Vpn hub update response
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Update vpn hubs.
      tags:
      - vpn
  /vpn/hubs/{id}/toggle:
    put:
      description: x.
      operationId: toggleVPNhubs
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vpn_hub_toggle'
      responses:
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No enabled parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No enabled parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -1:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Company has no data left.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: Company has no data left.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -2:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Failed to toggle VPN hub.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -2
                              type: object
                            value:
                              example: Failed to toggle VPN hub.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: VPN hub successfully $1.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: VPN hub successfully $1.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Toggle vpn hubs.
      tags:
      - vpn
  /vpn/hubs/{id}/settings:
    put:
      description: Change vpn hub settings.
      operationId: settingVPNhubs
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vpn_hub_settings'
      responses:
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No ip parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No ip parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 10002:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No netmask parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10002
                              type: object
                            value:
                              example: No netmask parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: VPN hub data successfully updated.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: VPN hub data successfully updated.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Change vpn hub settings.
      tags:
      - vpn
  /vpn/hubs/users:
    get:
      description: Get VPN hubs users.
      operationId: getVPNhubsUsers
      parameters:
      - description: Id of company.
        in: path
        name: company_id
        required: true
        schema:
          example: 1
          type: integer
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_74'
          description: VPN hub users list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get VPN hubs users.
      tags:
      - vpn users
    post:
      description: Create VPN hubs users.
      operationId: createVPNhubsUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vpn_hub_users_add'
      responses:
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No user_id parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No user_id parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -1:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Failed to find user.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: Failed to find user.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -2:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Unable to find RMS user (try again).
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -2
                              type: object
                            value:
                              example: Unable to find RMS user (try again).
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -3:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Unable to add user (try again).
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -3
                              type: object
                            value:
                              example: Unable to add user (try again).
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: User successfully added to VPN hub
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: User successfully added to VPN hub
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Create VPN hubs users.
      tags:
      - vpn users
  /vpn/hubs/users/config:
    get:
      description: Get VPN hubs users config.
      operationId: createVPNhubsCustomUsers
      parameters:
      - description: List of vpn hub users id as string.
        in: path
        name: vpn_hub_users
        required: true
        schema:
          example: 1,2,3
          type: string
      responses:
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseResponseModel'
                - description: Open vpn config
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            name:
                              description: OpenVPN confiugration file name.
                              example: Name-VpnHub.ovpn
                              type: string
                            content:
                              description: OpenVPN confugration file contents.
                              type: string
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get VPN hubs users config.
      tags:
      - vpn users
  /vpn/quick-hubs/{id}/users/config:
    get:
      description: Get quick VPN hubs users config.
      operationId: createQuickVPNHubsCustomUsers
      parameters:
      - description: Quick VPN hub ID.
        in: path
        name: id
        required: true
        schema:
          example: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get quick VPN hubs users config.
      tags:
      - vpn users
  /vpn/hubs/users/custom:
    post:
      description: Create VPN hubs custom users.
      operationId: createVPNhubsUsersConfig
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vpn_hub_custom_users_add'
      responses:
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No username parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No username parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -1:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Unable to create user (try again)
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: Unable to create user (try again)
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: User successfully added to VPN hub
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: User successfully added to VPN hub
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Create VPN hubs custom users.
      tags:
      - vpn users
  /vpn/hubs/users/{id}:
    delete:
      description: Delete vpn user from hub.
      operationId: deleteVPNhubsUsersConfig
      parameters:
      - description: Id of vpn hub user.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      responses:
        "-1":
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Unable to create user (try again).
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: Unable to create user (try again).
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "0":
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: User successfully removed from VPN hub.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: User successfully removed from VPN hub.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Delete vpn user from hub.
      tags:
      - vpn users
    post:
      description: Set users config.
      operationId: setVPNhubsUsersConfig
      parameters:
      - description: Id of vpn hub user.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vpn_hub_users_config'
      responses:
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No ip parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No ip parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -1:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Incorrect server IP.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: Incorrect server IP.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -2:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Failed to load taken ip addresses.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -2
                              type: object
                            value:
                              example: Failed to load taken ip addresses.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -3:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: IP is used by another client
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -3
                              type: object
                            value:
                              example: IP is used by another client
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -4:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: An error occurred. Please try again
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -4
                              type: object
                            value:
                              example: An error occurred. Please try again
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -5:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Unable to set static IP (try again).
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -5
                              type: object
                            value:
                              example: Unable to set static IP (try again).
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: Client IP is set.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: Client IP is set.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Set users config.
      tags:
      - vpn users
  /vpn/hubs/users/{id}/toggle:
    post:
      description: Toggle vpn user.
      operationId: toggleVPNUsers
      parameters:
      - description: Id of vpn hub user.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vpn_hub_users_toggle'
      responses:
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No enabled parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No enabled parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -1:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Toggled VPN user failed (try again).
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: Toggled VPN user failed (try again).
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: Successfully $1 VPN user.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: Successfully $1 VPN user.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Toggle vpn user.
      tags:
      - vpn users
  /vpn/hubs/{id}/dhcp:
    delete:
      description: Delete vpn dhcp options.
      operationId: deleteVPNDhcpOptions
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/delete_vpn_hub_dhcp_config'
      responses:
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No ip parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No ip parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 10002:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No type parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10002
                              type: object
                            value:
                              example: No type parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -1:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Wrong DHCP option type
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: Wrong DHCP option type
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: Successfully deleted DHCP option
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: Successfully deleted DHCP option
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Delete vpn dhcp options.
      tags:
      - vpn hub dhcp
    get:
      description: Get vpn dhcp options.
      operationId: getVPNDhcpOptions
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      responses:
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseResponseModel'
                - description: Get DHCP options
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            dhcp_option:
                              description: DHCP options in vpn hub.
                              items:
                                description: DHCP option
                                properties:
                                  ip:
                                    description: DHCP option ip
                                    example: 192.186.8.8
                                    type: string
                                  type:
                                    description: DHCP server type:["DNS || WINS"]
                                    example: DNS
                                    type: string
                                  state:
                                    description: State of dhcp option.
                                    type: string
                                type: object
                              type: array
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get vpn dhcp options.
      tags:
      - vpn hub dhcp
    post:
      description: Create vpn dhcp options.
      operationId: createVPNDhcpOptions
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/add_vpn_hub_dhcp_config'
      responses:
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No ip parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No ip parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 10002:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No type parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10002
                              type: object
                            value:
                              example: No type parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -1:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: Wrong DHCP option type
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -1
                              type: object
                            value:
                              example: Wrong DHCP option type
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: Successfully added DHCP option
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: Successfully added DHCP option
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Create vpn dhcp options.
      tags:
      - vpn hub dhcp
  /vpn/hubs/routes:
    get:
      description: Get vpn hubs routes.
      operationId: getVPNHubsRoutes
      parameters:
      - description: Id of vpn hub.
        in: path
        name: vpn_hub_id
        required: true
        schema:
          example: 1
          type: integer
      - description: Id of vpn hub user.
        in: path
        name: vpn_hub_user_id
        required: true
        schema:
          example: 1
          type: integer
      responses:
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseResponseModel'
                - description: Get Routes
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            hub_routes:
                              description: Array of VPN hub routes.
                              items:
                                description: Route object.
                                properties:
                                  ip:
                                    description: Route network ip.
                                    example: 192.168.1.0
                                    type: string
                                  state:
                                    description: Route state.
                                    type: string
                                  netmask:
                                    description: Route network mask.
                                    type: string
                                  via:
                                    description: VPN client id.
                                    type: integer
                                type: object
                              type: array
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get vpn hubs routes.
      tags:
      - vpn hub routes
    post:
      description: Create vpn hubs routes.
      operationId: createVPNHubsRoutes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vpn_hub_route_add'
      responses:
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No ip parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No ip parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 10002:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No netmask parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10002
                              type: object
                            value:
                              example: No netmask parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 10003:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No via parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10003
                              type: object
                            value:
                              example: No via parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -2:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: A route with same IP address and netmask already exists.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -2
                              type: object
                            value:
                              example: A route with same IP address and netmask already
                                exists.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / -3:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: An error occurred. Please try again.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: -3
                              type: object
                            value:
                              example: An error occurred. Please try again.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: Route successfully added.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: Route successfully added.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Create vpn hubs routes.
      tags:
      - vpn hub routes
  /vpn/quick-hubs/{id}/routes:
    get:
      description: Get quick vpn hubs routes.
      operationId: getQuickVPNHubsRoutes
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      responses:
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseResponseModel'
                - description: Get Routes
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            hub_routes:
                              description: Array of VPN hub routes.
                              items:
                                description: Route object.
                                properties:
                                  ip:
                                    description: Route network ip.
                                    example: 192.168.1.0
                                    type: string
                                  state:
                                    description: Route state.
                                    type: string
                                  netmask:
                                    description: Route network mask.
                                    type: string
                                  via:
                                    description: VPN client id.
                                    type: integer
                                type: object
                              type: array
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_75'
          description: VPN routes list.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get quick vpn hubs routes.
      tags:
      - vpn hub routes
  /vpn/hubs/routes/{id}:
    delete:
      description: Delete vpn hubs.
      operationId: deleteVPNHubsRoutes
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/vpn_hub_route_delete'
      responses:
        Status API / 10001:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No ip parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10001
                              type: object
                            value:
                              example: No ip parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 10002:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No netmask parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10002
                              type: object
                            value:
                              example: No netmask parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 10003:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseErrorModel'
                - description: No via parameter in data object.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            errorcode:
                              example: 10003
                              type: object
                            value:
                              example: No via parameter in data object.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        Status API / 0:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BaseSuccessModel'
                - description: Route successfully removed.
                  properties:
                    data:
                      properties:
                        "-1":
                          properties:
                            value:
                              example: Route successfully removed.
                              type: object
                          type: object
                      type: object
                  type: object
          description: Status channel message body.
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Delete vpn hubs.
      tags:
      - vpn hub routes
  /vpn/hubs/{id}/logs:
    get:
      description: Get vpn hub logs.
      operationId: getVPNhubLogs
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      - description: 'Start of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: start_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: 'End of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: end_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_76'
          description: Get VPN hub logs.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get vpn hub logs.
      tags:
      - vpn
  /vpn/hubs/{id}/logs/user-connections:
    get:
      description: Get vpn hub connection logs.
      operationId: getVPNHubConnectionLogs
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_77'
          description: Get VPN hub connection logs.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get vpn hub connection logs.
      tags:
      - vpn
  /vpn/hubs/{id}/users/{userID}/logs:
    get:
      description: Get vpn hub user logs.
      operationId: getVPNhubUserLogs
      parameters:
      - description: Id of vpn hub.
        in: query
        name: id
        required: true
        schema:
          example: 1
          type: integer
      - description: Id of vpn hub user.
        in: path
        name: hub_user_id
        required: true
        schema:
          example: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_78'
          description: Get VPN hub user logs.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get vpn hub user logs.
      tags:
      - vpn
  /devices/configurator/specification:
    get:
      description: Get available parameters to configure in device.
      operationId: getAvailableParametersToConfiguration
      parameters:
      - description: List of devices id as string.
        in: query
        name: device_id
        required: true
        schema:
          example: 1,2,3
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_79'
          description: Returns device API routes documentation file url.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get available parameters to configure in device.
      tags:
      - device multi configuration
  /devices/configurator/configuration:
    post:
      description: Get device configurations values.
      operationId: getDeviceConfigurationValues
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/get_configuration'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get device configurations values.
      tags:
      - device multi configuration
  /devices/configurator/configure:
    post:
      description: Send configuration to device.
      operationId: sendConfigurationTodevice
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/send_configuration'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Send configuration to device.
      tags:
      - device multi configuration
  /devices/configurator/templates:
    get:
      description: Returns a list of multi configuration templates.
      operationId: getMultiConfigurationTemplates
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_80'
          description: Devices configurations returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get multi configuration templates.
      tags:
      - device multi configuration templates
    post:
      description: Create multi configuration templates.
      operationId: createMultiConfigurationTemplates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_template'
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Create multi configuration templates.
      tags:
      - device multi configuration templates
  /devices/configurator/templates/{id}/use:
    post:
      description: Sends multi configuration template to devices list.
      operationId: sendMultiConfigurationTemplates
      parameters:
      - description: Multi configuration template id.
        in: path
        name: id
        required: true
        schema:
          description: Multi configuration template id.
          example: "1"
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/use_template'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: Learn more about how to use [Status API](/pages/status-api.html#introduction).
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Use multi configuration template on devices.
      tags:
      - device multi configuration templates
  /devices/{id}/configurator/logs:
    get:
      description: Get device configuration log list.
      operationId: getConfigurationLogList
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_81'
          description: Devices configuration log returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get device configuration log list.
      tags:
      - device multi configuration logs
  /devices/{id}/configurator/logs/{action_name}:
    get:
      description: Get device configuration log list.
      operationId: getConfigurationLogSingle
      parameters:
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          type: integer
      - description: Device id.
        in: path
        name: action_name
        required: true
        schema:
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_81'
          description: Devices configuration log returned successfully.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get device configuration log list.
      tags:
      - device multi configuration logs
  /devices/device-vpn-status:
    get:
      description: Returns a list of devices L2TP status.
      operationId: deviceVpnStatus
      parameters:
      - description: Device ID filter.
        in: query
        name: device_id
        required: false
        schema:
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_82'
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get devices L2TP status.
      tags:
      - device vpn status
  /automations:
    get:
      description: Returns automation information.
      operationId: getAutomations
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: Order elements by specified field. Multiple values are allowed
          with comma separation. The dash symbol before field name indicates desc
          sorting direction.
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: Company id filter.
        in: query
        name: company_id
        required: false
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_83'
          description: Automation information returned.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
      security:
      - BearerAuth: []
      summary: Get automations
      tags:
      - automations
    post:
      description: Create automation.
      operationId: createAutomation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automation_post_put'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Automation created.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
      security:
      - BearerAuth: []
      summary: Create automation
      tags:
      - automations
  /automations/{id}:
    delete:
      description: Delete automation.
      operationId: deleteAutomation
      parameters:
      - description: Automation id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Automation deleted.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
      security:
      - BearerAuth: []
      summary: Delete automation
      tags:
      - automations
    get:
      description: Returns automation information by it's id.
      operationId: getAutomation
      parameters:
      - description: Automation id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_83'
          description: Automation information returned.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
      security:
      - BearerAuth: []
      summary: Get automation
      tags:
      - automations
    put:
      description: Updates automation information by it's id.
      operationId: putAutomation
      parameters:
      - description: Automation id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automation_post_put'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Automation updated.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
      security:
      - BearerAuth: []
      summary: Update automation
      tags:
      - automations
  /devices/{id}/automations:
    get:
      description: Returns automations that are assigned to specific device.
      operationId: getDeviceAutomations
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Order elements by specified field. Multiple values are allowed
          with comma separation. The dash symbol before field name indicates desc
          sorting direction.
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: Device id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_83'
          description: Automation information returned.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_403'
          description: User does not have permission to perform this action.
      security:
      - BearerAuth: []
      summary: Get device automations
      tags:
      - automations
  /automations/{id}/logs:
    get:
      description: Returns a list of information about automation logs.
      operationId: automationLogsGet
      parameters:
      - description: Automation id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_84'
          description: Automation log information returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Returns information about automation logs.
      tags:
      - automations
  /automations/{id}/logs/{evaluation_id}:
    get:
      description: Returns a list of information about automation logs by evaluation
        id.
      operationId: automationLogsByEvaluationGet
      parameters:
      - description: Automation id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Evaluation id.
        in: path
        name: evaluation_id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_85'
          description: Automation log information by evaluation id returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Returns information about automation logs by evaluation id.
      tags:
      - automations
  /automations/{id}/devices:
    delete:
      description: Removes devices from automation.
      operationId: automationDeviceDelete
      parameters:
      - description: Automation id
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automations_id_devices_delete'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Automation devices unassigned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Removes devices from automation.
      tags:
      - automations
    get:
      description: Returns a list of information about automation devices.
      operationId: automationDeviceGet
      parameters:
      - description: Maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          minimum: 0
          type: integer
      - description: Offset number of results to return.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Search query.
        in: query
        name: q
        required: false
        schema:
          type: string
      - description: Order elements by specified field. Multiple values are allowed
          with comma separation. The dash symbol before field name indicates desc
          sorting direction.
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: Automation id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      - description: Device model filter.
        in: query
        name: model
        required: false
        schema:
          minimum: 1
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_86'
          description: Automation device information returned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Returns information about automation devices.
      tags:
      - automations
    put:
      description: Adds or removes devices by comparing currently assigned and given.
      operationId: automationDeviceUpdate
      parameters:
      - description: Automation id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automations_id_devices_delete'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Automation devices unassigned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Updates automation devices.
      tags:
      - automations
  /automations/activate:
    put:
      description: Enables/disables automation.
      operationId: automationActivation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automations_activation'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Automation activated.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Enables/disables automation.
      tags:
      - automations
  /automations/{id}/devices/activation:
    put:
      description: Enables/disables automation for a device.
      operationId: deviceAutomationActivation
      parameters:
      - description: Automation id.
        in: path
        name: id
        required: true
        schema:
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automations_devices_activation'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Automation devices activated.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Enables/disables automation for a device.
      tags:
      - automations
  /automations/devices/assign:
    put:
      description: Assigns devices to automation.
      operationId: assignAutomationDevices
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automations_devices_assign'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Automation devices assigned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Assign devices to automations
      tags:
      - automations
  /automations/devices/unassign:
    put:
      description: Deletes all devices from a specific automation.
      operationId: unassignAutomationDevices
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automations_devices_unassign'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Automation devices unassigned.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Unassign devices from automations
      tags:
      - automations
  /devices/automations/overwrite:
    put:
      description: Deletes all assigned automations and then assigns new designated
        ones.
      operationId: deviceAutomationsOverwrite
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/devices_automations_overwrite'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Device automations overwritten.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Overwrite automation devices
      tags:
      - automations
  /automations/devices/overwrite:
    put:
      description: Deletes all assigned devices and then assigns new designated ones.
      operationId: automationDevicesOverwrite
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/devices_automations_overwrite'
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_201'
          description: Device automations overwritten.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Overwrite automation devices
      tags:
      - automations
  /data-collect/configs:
    get:
      description: Returns available data collect configurations.
      operationId: getDataCollectList
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_87'
          description: Successful retrieval of data.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get data collect configs
      tags:
      - data collect
    post:
      description: This endpoint allows you to create or update the resource with
        detailed validation rules.
      requestBody:
        $ref: '#/components/requestBodies/inline_object_1'
        content:
          application/json:
            schema:
              properties:
                name:
                  maxLength: 255
                  nullable: true
                  type: string
                description:
                  maxLength: 255
                  nullable: true
                  type: string
                company_id:
                  description: The ID of the company (required).
                  type: integer
                api_version:
                  maxLength: 255
                  type: string
                api_system:
                  enum:
                  - rutos
                  - tswos
                  nullable: true
                  type: string
                period:
                  minimum: 1
                  type: integer
                enabled:
                  type: boolean
                device_documentation_id:
                  type: integer
                data:
                  description: testas
                  items:
                    $ref: '#/components/schemas/_data_collect_configs_data'
                  type: array
              required:
              - api_version
              - company_id
              - data
              - device_documentation_id
              - enabled
              - period
              type: object
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_88'
          description: Successfully created or updated resource.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Create or update resource
      tags:
      - data collect
  /data-collect/configs/{id}:
    delete:
      description: This endpoint allows you to update the resource with detailed validation
        rules.
      parameters:
      - description: ID of pet that needs to be updated
        in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_88'
          description: Successfully deleted resource.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Update data collect config
      tags:
      - data collect
    put:
      description: This endpoint allows you to update the resource with detailed validation
        rules.
      parameters:
      - description: ID of the config that needs to be updated.
        in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        $ref: '#/components/requestBodies/inline_object_2'
        content:
          application/json:
            schema:
              properties:
                name:
                  maxLength: 255
                  nullable: true
                  type: string
                description:
                  maxLength: 255
                  nullable: true
                  type: string
                company_id:
                  description: The ID of the company (required).
                  type: integer
                api_version:
                  maxLength: 255
                  type: string
                api_system:
                  enum:
                  - rutos
                  - tswos
                  nullable: true
                  type: string
                period:
                  minimum: 1
                  type: integer
                enabled:
                  type: boolean
                device_documentation_id:
                  type: integer
                data:
                  items:
                    $ref: '#/components/schemas/_data_collect_configs__id__data'
                  type: array
              required:
              - api_version
              - company_id
              - data
              - device_documentation_id
              - enabled
              - period
              type: object
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_88'
          description: Successfully created or updated resource.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Update data collect config
      tags:
      - data collect
  /data-collect/configs/assigned:
    get:
      description: Get assigned data collect configuration.
      parameters:
      - description: Filter data by device_id.
        in: query
        name: device_id
        required: false
        schema:
          format: int64
          type: integer
      - description: Filter data by config_id.
        in: query
        name: config_id
        required: false
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_89'
          description: Successful retrieval of data.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Get assigned data collect configuration.
      tags:
      - data collect
  /data-collect/configs/assign:
    put:
      description: Assign data collect template to device.
      operationId: assignConfigToDevice
      requestBody:
        $ref: '#/components/requestBodies/inline_object_3'
        content:
          application/json:
            schema:
              properties:
                configs:
                  items:
                    $ref: '#/components/schemas/_data_collect_configs_assign_configs'
                  minItems: 1
                  type: array
              type: object
        description: Configuration data to be updated.
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_88'
          description: Successfully created or updated resource.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Assign data collect template to device.
      tags:
      - data collect
  /data-collect/configs/{id}/unassign:
    put:
      description: Assign data collect template to device.
      operationId: unassignConfigFromDevice
      parameters:
      - description: ID of the config that you want to unassign.
        in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        $ref: '#/components/requestBodies/inline_object_4'
        content:
          application/json:
            schema:
              properties:
                device_id:
                  description: List of device IDs associated with the configuration
                  items:
                    description: A valid device ID owned by the user
                    type: integer
                  minItems: 1
                  type: array
              required:
              - device_id
              type: object
        description: Device data to be updated
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_88'
          description: Successfully created or updated resource.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Assign data collect template to device.
      tags:
      - data collect
  /data-collect/configs/logs:
    get:
      description: Returns monitoring data collection logs.
      operationId: getDataCollectLogs
      parameters:
      - description: Filter data by device_id.
        in: query
        name: device_id
        required: false
        schema:
          format: int64
          type: integer
      - description: Filter data by config_id.
        in: query
        name: config_id
        required: false
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_90'
          description: A list of logs and device configurations
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Get monitoring logs.
      tags:
      - data collect
  /devices/{id}/custom-data:
    get:
      description: Returns monitoring data collection logs.
      operationId: getDataCollectAll
      parameters:
      - description: 'Start of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: start_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: 'End of a range. Pattern: Y-m-d H:i:s'
        in: query
        name: end_date
        required: true
        schema:
          example: Y-m-d H:i:s
          type: string
      - description: Filter data by device_id.
        in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      - description: Filter data by config_id.
        in: query
        name: config_id
        required: false
        schema:
          format: int64
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_91'
          description: A list of logs and device configurations
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: All data collected .
      tags:
      - data collect
  /data-collect/data/graph:
    get:
      description: Single monitoring parameter grouped and counted values.
      operationId: getDataCollectGraph
      parameters:
      - description: |
          The colon (:) is used as a separator to divide the string into different parts: \
            Before the first colon: Config ID \
            Between the colons: URL \
            After the second colon: Parameter name
        example: 0:/modems/status:temperature
        in: query
        name: field
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_92'
          description: List of grouped and counted values.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Single monitoring parameter grouped and counted values.
      tags:
      - data collect
  /data-collect/data/values:
    get:
      description: Available monitoring single parameter values.
      operationId: getDataCollectValues
      parameters:
      - description: |
          The colon (:) is used as a separator to divide the string into different parts: \
            Before the first colon: Config ID \
            Between the colons: URL \
            After the second colon: Parameter name
        example: 0:/modems/status:temperature
        in: query
        name: field
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_93'
          description: List of available parameters values.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_422'
          description: Data was unprocessable. Displays errors list.
      security:
      - BearerAuth: []
      summary: Available monitoring single parameter values.
      tags:
      - data collect
  /devices/data/fields:
    get:
      description: Monitoring templates with parameters.
      operationId: getDataCollectFields
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_94'
          description: List of data monitoring templates with parameters.
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_400'
          description: User gave bad request body, so further actions are not possible.
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_401'
          description: User is not authorized to do this action.
      security:
      - BearerAuth: []
      summary: Monitoring templates with parameters.
      tags:
      - data collect
components:
  requestBodies:
    inline_object_1:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/inline_object_1'
      required: true
    inline_object:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/inline_object'
    inline_object_4:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/inline_object_4'
      required: true
    inline_object_3:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/inline_object_3'
      required: true
    inline_object_2:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/inline_object_2'
      required: true
  schemas:
    success_true:
      description: Determinate if something went wrong while executing request. True
        - request was successful, false - request was unsuccessful.
      example: true
      type: boolean
    created_at:
      description: Timestamp of entry's creation.
      example: 1995-06-08 04:20:07
      pattern: Y-m-d H:i:s
      type: string
    meta_total:
      description: Metadata wrapper. Can have many other metadata properties.
      example:
        total: 1420
      properties:
        total:
          description: Total number of entries found.
          example: 1420
          type: integer
      type: object
    success_false:
      description: Determinate if something went wrong while executing request. True
        - request was successful, false - request was unsuccessful.
      example: false
      type: boolean
    company_create:
      properties:
        name:
          example: Company
          maxLength: 200
          minLength: 3
          type: string
        parent_id:
          example: 125
          minimum: 1
          type: integer
      required:
      - name
      - parent_id
      type: object
    company_move:
      properties:
        source:
          description: Id of company to be moved.
          example: 12
          type: integer
        target:
          description: Id of company to be moved on.
          example: 9
          type: integer
      required:
      - source
      - target
      type: object
    company_update:
      properties:
        name:
          description: Company name.
          example: Company
          type: string
        email:
          description: Company email.
          example: ' some-mail@mail.com'
          format: email
          type: string
      required:
      - email
      - name
      type: object
    updated_at:
      description: Timestamp of entry's last update.
      example: 2020-02-20 09:10:59
      pattern: Y-m-d H:i:s
      type: string
    invite_user:
      properties:
        role:
          description: Role of invited user.
          enum:
          - admin
          - end_user
          - read_only
          example: end_user
          type: string
        email:
          description: Email by which user is invited.
          example: ' some-mail@mail.com'
          format: email
          type: string
        company_id:
          description: Id of company that user is invited to.
          example: 7811
          type: integer
      required:
      - company_id
      - email
      - role
      type: object
    tag_create:
      properties:
        name:
          description: Tag of name.
          example: Tag1
          maxLength: 100
          minLength: 3
          type: string
        company_id:
          description: Company id that tag will belong to.
          example: 125
          minimum: 1
          type: integer
        description:
          description: Tag description.
          example: Good tag
          maxLength: 200
          type: string
        color:
          description: Color of tag in HEX format.
          example: '#4287f5'
          maxLength: 7
          type: string
        actions:
          items:
            $ref: '#/components/schemas/tag_create_actions'
          maxItems: 4
          type: array
      required:
      - company_id
      - description
      - name
      type: object
    tag_update:
      properties:
        name:
          description: New tag name.
          example: TagNew
          type: string
        description:
          description: New tag description.
          example: Better tag 10/10 dentist would recommend.
          type: string
      type: object
    device_body:
      example:
        static_monitoring: 0
        io_monitoring: 60
        oc_output_cfg: oc_output_cfg
        accuracy: 6
        ecio_2: ecio_2
        rsrp: 2.027123
        modem_manufacturer_2: Quectel
        user_set_longitude: 14.269965
        monitoring_enabled: 1
        iccid_2: "11111111111111111111"
        operator_2: operator_2
        mqtt: 1
        analog_input: analog_input
        auto_extend_credit: 1
        model: RUT950
        id: 70810
        cell_tower_longitude: 14.269965
        rsrp_2: 4.145608
        management_credit_type: management_5y
        mnc_2: "146"
        imei_2: "111111111111111"
        received: 9
        cell_tower_latitude: 48.790625
        received_2: 3
        mcc_2: "246"
        tags:
        - company_id: 430
          color: '#4287f5'
          updated_at: 2020-02-20 09:10:59
          user_id: 4
          name: The tag
          description: Good tag
          created_at: 1995-06-08 04:20:07
          id: 11
          actions:
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
        - company_id: 430
          color: '#4287f5'
          updated_at: 2020-02-20 09:10:59
          user_id: 4
          name: The tag
          description: Good tag
          created_at: 1995-06-08 04:20:07
          id: 11
          actions:
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
        operator_number_2: "24602"
        analog_current_loop: analog_current_loop
        temperature_2: 360
        ddns_monitoring: 60
        company_name: Company
        bootloader_version: 3.0.1
        modem_manufacturer: Quectel
        cell_tower_latitude_2: 48.790625
        is_authenticated: 0
        mobile_ip_2: 0.0.0.0
        relay_output_2: 4
        relay_output_cfg: relay_output_cfg
        status: 1
        relay_output: relay_output
        fix_status: 3
        gps_time: 6
        batch_number: "0054"
        latitude: 48.790625
        created_at: 1995-06-08 04:20:07
        pin_state_2: READY
        sent_2: 7
        imsi: "246020102200857"
        product_code: RUT955H7VXXX
        mac: 00:00:00:00:00:00
        failed_auth_reason: 6
        updated_at: 2020-02-20 09:10:59
        vpn_monitoring: 0
        temperature: 360
        digital_input: 6
        credit_expire_date: 2000-01-23T04:56:07.000+00:00
        course: 2.8841621266687802
        sim_slot_2: 1
        rscp: rscp
        digital_isolated_input: 7
        firmware: RUT9XX_R_00.06.05.3
        network_state_2: Home
        modem_firmware: EC25EFAR02A08M4G
        sim_slot: 1
        user_set_latitude: 48.790625
        gps_monitoring: 300
        company_id: 7034
        connection_type: LTE
        cell_tower_longitude_2: 14.269965
        dry_wet_input1: 8
        ecio: ecio
        dry_wet_input0: 6
        dynamic_monitoring: 300
        activation_status: "11111"
        modem_model_2: EC25
        rsrq: 1.0246457
        router_uptime: 3060
        cell_tower_accuracy_2: 14.269965
        pin_state: READY
        is_facelift: 0
        data_credit_type_name: Free Connection Data pack 150GB 10y.
        mcc: "246"
        operator: operator
        lac: "146"
        iccid: "11111111111111111111"
        original_model: RUT950
        hotspot_monitoring: 300
        management_credit_type_name: Paid Management pack 5y.
        connection_state_2: connected
        signal: 5
        cell_id: "1037079"
        longitude: 14.269965
        satellites: 6
        rscp_2: rscp_2
        sent: 2
        sinr: 7.386282
        modem_firmware_2: EC25EFAR02A08M4G
        data_credit_type: data_150GB_10y
        wireless_monitoring: 60
        credit_enabled: 1
        credit_activated: 1
        last_update_at: 2000-01-23T04:56:07.000+00:00
        name: RUT Device 1
        connection_type_2: LTE
        network_state: Home
        digital_open_collector_output_4pin: 6
        wan_state: Mobile
        altitude: 10.542345
        description: s/n 0000000000, added at 2020-01-01
        connection_state: connected
        speed: 1.284659006116532
        data_credit_type_id: 6
        signal_2: 5
        imsi_2: "246020102200857"
        hardware_revision: "1307"
        connection_uptime_2: 3012
        mobile_ip: 0.0.0.0
        cell_tower_accuracy: 14.269965
        last_connection_at: 2000-01-23T04:56:07.000+00:00
        lac_2: "146"
        ddns_rules_count: 3
        wlan_mac: 00:00:00:00:00:00
        rsrq_2: 1.4894159
        mnc: "146"
        sim_state_2: inserted
        operator_number: "24602"
        connection_uptime: 3012
        digital_inout2: 9
        remaining_data: 1
        cell_id_2: "1037079"
        sim_state: inserted
        management_credit_type_id: 2
        digital_inout0: 5
        serial: "0000000000"
        sinr_2: 1.2315135
        modem_model: EC25
        digital_inout1: 9
        vpn_monitoring_instances_state: 1
        wan_ip: 0.0.0.0
        imei: "111111111111111"
        digital_non_isolated_input_4pin: 9
        open_collector_output: 1
      properties:
        id:
          description: Id of a device.
          example: 70810
          type: integer
        company_id:
          description: Company id that device belongs to.
          example: 7034
          type: integer
        model:
          description: Device model.
          example: RUT950
          type: string
        original_model:
          description: Device original model.
          example: RUT950
          type: string
        name:
          description: Name of device.
          example: RUT Device 1
          type: string
        description:
          description: Extra information for device.
          example: s/n 0000000000, added at 2020-01-01
          type: string
        serial:
          description: Device serial number.
          example: "0000000000"
          type: string
        mac:
          description: Device's mac.
          example: 00:00:00:00:00:00
          type: string
        wlan_mac:
          description: Device's wlan mac.
          example: 00:00:00:00:00:00
          type: string
        mqtt:
          description: Device's connection type. 0 - vpn. < 0 is mqtt version.
          example: 1
          type: integer
        dynamic_monitoring:
          description: Time interval in seconds that device's dynamic information
            is being monitored. (0 - disabled)
          example: 300
          type: integer
        static_monitoring:
          description: Time interval in seconds that device's static information is
            being monitored. (0 - disabled)
          example: 0
          type: integer
        io_monitoring:
          description: Time interval in seconds that device's I/O information is being
            monitored. (0 - disabled)
          example: 60
          type: integer
        gps_monitoring:
          description: Time interval in seconds that device's GPS information is being
            monitored. (0 - disabled)
          example: 300
          type: integer
        hotspot_monitoring:
          description: Time interval in seconds that device's hotspot information
            is being monitored. (0 - disabled)
          example: 300
          type: integer
        wireless_monitoring:
          description: Time interval in seconds that device's wireless information
            is being monitored. (0 - disabled)
          example: 60
          type: integer
        ddns_monitoring:
          description: Time interval in seconds that device's ddns information is
            being monitored. (0 - disabled)
          example: 60
          type: integer
        vpn_monitoring:
          description: Time interval in seconds that device's vpn information is being
            monitored. (0 - disabled)
          example: 0
          type: integer
        vpn_monitoring_instances_state:
          example: 1
          type: integer
        last_connection_at:
          description: Date at which device made last connection.
          format: date-time
          type: string
        activation_status:
          description: Device activation status.
          example: "11111"
          type: string
        is_facelift:
          description: Is device facelifted.
          enum:
          - 1
          - 0
          example: 0
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
        status:
          description: Device status. 0 - offline, 1 - online, 2 - pending, null -
            offline.
          example: 1
          nullable: true
          type: integer
        is_authenticated:
          description: Device authentication status.
          type: integer
        failed_auth_reason:
          description: Device authentication failed reason.
          type: integer
        credit_enabled:
          description: Is service credit enabled for this device.
          enum:
          - 1
          - 0
          example: 1
          type: integer
        credit_activated:
          description: Is service credit activated for this device.
          enum:
          - 1
          - 0
          example: 1
          type: integer
        credit_expire_date:
          description: Date at which activated credit will expire.
          format: date-time
          type: string
        monitoring_enabled:
          description: Is monitoring for this device is enabled.
          enum:
          - 1
          - 0
          example: 1
          type: integer
        auto_extend_credit:
          description: Is service credit auto extend is enabled for this device.
          enum:
          - 1
          - 0
          example: 1
          type: integer
        remaining_data:
          description: Remaining device data in bytes.
          type: integer
        company_name:
          description: Name of company that this device belongs to.
          example: Company
          type: string
        temperature:
          description: Device temperature. Temperature is in celsius.
          example: 360
          type: integer
        temperature_2:
          description: Device temperature. Temperature is in celsius.
          example: 360
          type: integer
        signal:
          description: Device signal strength.
          type: integer
        signal_2:
          description: Device signal strength.
          type: integer
        firmware:
          description: Device's current firmware.
          example: RUT9XX_R_00.06.05.3
          type: string
        bootloader_version:
          description: Version of device's bootloader.
          example: 3.0.1
          type: string
        cell_id:
          description: Operation tower id.
          example: "1037079"
          type: string
        cell_id_2:
          description: Operation tower id.
          example: "1037079"
          type: string
        connection_type:
          description: Mobile connection type.
          example: LTE
          type: string
        connection_type_2:
          description: Mobile connection type.
          example: LTE
          type: string
        connection_state:
          description: Device's mobile connection state.
          example: connected
          type: string
        connection_state_2:
          description: Device's mobile connection state.
          example: connected
          type: string
        connection_uptime:
          description: Time in seconds for how long connection was established.
          example: 3012
          type: integer
        connection_uptime_2:
          description: Time in seconds for how long connection was established.
          example: 3012
          type: integer
        iccid:
          description: Integrated circuit card identifier.
          example: "11111111111111111111"
          type: string
        iccid_2:
          description: Integrated circuit card identifier.
          example: "11111111111111111111"
          type: string
        lac:
          description: Location area identity.
          example: "146"
          type: string
        lac_2:
          description: Location area identity.
          example: "146"
          type: string
        mcc:
          description: Mobile country code.
          example: "246"
          type: string
        mcc_2:
          description: Mobile country code.
          example: "246"
          type: string
        mnc:
          description: Mobile network codes.
          example: "146"
          type: string
        mnc_2:
          description: Mobile network codes.
          example: "146"
          type: string
        sim_slot:
          description: Sim card slot in which sim card is activated.
          example: 1
          type: integer
        sim_slot_2:
          description: Sim card slot in which sim card is activated.
          example: 1
          type: integer
        sim_state:
          description: Sim card state.
          example: inserted
          type: string
        sim_state_2:
          description: Sim card state.
          example: inserted
          type: string
        pin_state:
          description: Pin state.
          example: READY
          type: string
        pin_state_2:
          description: Pin state.
          example: READY
          type: string
        operator:
          description: Mobile network operator name.
          type: string
        operator_2:
          description: Mobile network operator name.
          type: string
        operator_number:
          description: Sim card operator's number.
          example: "24602"
          type: string
        operator_number_2:
          description: Sim card operator's number.
          example: "24602"
          type: string
        router_uptime:
          description: Time in seconds that router was up.
          example: 3060
          type: integer
        wan_state:
          description: Wide area network state.
          example: Mobile
          type: string
        wan_ip:
          description: Wide area network ip.
          example: 0.0.0.0
          format: ipv4
          type: string
        mobile_ip:
          description: Mobile ip.
          example: 0.0.0.0
          format: ipv4
          type: string
        mobile_ip_2:
          description: Mobile ip.
          example: 0.0.0.0
          format: ipv4
          type: string
        network_state:
          description: State of network.
          example: Home
          type: string
        network_state_2:
          description: State of network.
          example: Home
          type: string
        sent:
          type: integer
        sent_2:
          type: integer
        received:
          type: integer
        received_2:
          type: integer
        rscp:
          description: Received Signal Code Power.
          type: string
        rscp_2:
          description: Received Signal Code Power.
          type: string
        ecio:
          description: The EC/IO is a measure of the quality/cleanliness of the signal
            from the tower to the modem and indicates the signal-to noise ratio.
          type: string
        ecio_2:
          description: The EC/IO is a measure of the quality/cleanliness of the signal
            from the tower to the modem and indicates the signal-to noise ratio.
          type: string
        rsrp:
          description: Reference Signals Received Power.
          format: float
          type: number
        rsrp_2:
          description: Reference Signals Received Power.
          format: float
          type: number
        sinr:
          description: Signal-to-Interference-plus-Noise Ratio.
          format: float
          type: number
        sinr_2:
          description: Signal-to-Interference-plus-Noise Ratio.
          format: float
          type: number
        rsrq:
          description: Reference Signal Received Quality.
          format: float
          type: number
        rsrq_2:
          description: Reference Signal Received Quality.
          format: float
          type: number
        imei:
          description: Device international mobile equipment identity number.
          example: "111111111111111"
          type: string
        imei_2:
          description: Device international mobile equipment identity number.
          example: "111111111111111"
          type: string
        batch_number:
          description: Device's batch number.
          example: "0054"
          type: string
        product_code:
          description: Device product code.
          example: RUT955H7VXXX
          type: string
        modem_manufacturer:
          description: Modem manufacturer.
          example: Quectel
          type: string
        modem_manufacturer_2:
          description: Modem manufacturer.
          example: Quectel
          type: string
        modem_model:
          description: Model of modem.
          example: EC25
          type: string
        modem_model_2:
          description: Model of modem.
          example: EC25
          type: string
        modem_firmware:
          description: Modem firmware version.
          example: EC25EFAR02A08M4G
          type: string
        modem_firmware_2:
          description: Modem firmware version.
          example: EC25EFAR02A08M4G
          type: string
        hardware_revision:
          description: Hardware revision.
          example: "1307"
          type: string
        imsi:
          description: International mobile subscriber identity number.
          example: "246020102200857"
          type: string
        imsi_2:
          description: International mobile subscriber identity number.
          example: "246020102200857"
          type: string
        digital_input:
          description: Digital input.
          nullable: true
          type: integer
        digital_isolated_input:
          description: Digital isolated input.
          nullable: true
          type: integer
        analog_input:
          description: Analog input.
          nullable: true
          type: string
        open_collector_output:
          description: Open collector output.
          nullable: true
          type: integer
        relay_output:
          description: Relay output
          nullable: true
          type: string
        oc_output_cfg:
          description: Open collector output configurations.
          nullable: true
          type: string
        relay_output_cfg:
          description: Relay output configurations.
          nullable: true
          type: string
        relay_output_2:
          description: Relay output status.
          nullable: true
          type: integer
        digital_inout0:
          description: Digital input and output 0 status.
          nullable: true
          type: integer
        digital_inout1:
          description: Digital input and output 1 status.
          nullable: true
          type: integer
        digital_inout2:
          description: Digital input and output 2 status.
          nullable: true
          type: integer
        dry_wet_input0:
          description: Dry wet input 1 status.
          nullable: true
          type: integer
        dry_wet_input1:
          description: Dry wet input 1 status.
          nullable: true
          type: integer
        digital_non_isolated_input_4pin:
          description: Digital non isolated input 4pin status.
          nullable: true
          type: integer
        digital_open_collector_output_4pin:
          description: Digital open collector output 4pin status.
          nullable: true
          type: integer
        analog_current_loop:
          description: Digital open collector output 4pin status.
          nullable: true
          type: string
        fix_status:
          description: Fix status.
          nullable: true
          type: integer
        satellites:
          description: Number of satellites.
          nullable: true
          type: integer
        latitude:
          description: Device location's latitude in Decimal degrees.
          example: 48.790625
          nullable: true
          type: number
        longitude:
          description: Device location's longitude in Decimal degrees.
          example: 14.269965
          nullable: true
          type: number
        altitude:
          description: Device location's altitude in Decimal degrees.
          example: 10.542345
          nullable: true
          type: number
        speed:
          description: Device speed.
          nullable: true
          type: number
        course:
          description: Device course.
          nullable: true
          type: number
        gps_time:
          description: Time in seconds for device gps uptime.
          nullable: true
          type: integer
        accuracy:
          description: Location accuracy.
          nullable: true
          type: integer
        user_set_latitude:
          description: Device latitude set by user in Decimal degrees.
          example: 48.790625
          nullable: true
          type: number
        user_set_longitude:
          description: Device longitude set by user in Decimal degrees.
          example: 14.269965
          nullable: true
          type: number
        cell_tower_latitude:
          description: Device location's latitude by cell tower information in Decimal
            degrees.
          example: 48.790625
          nullable: true
          type: number
        cell_tower_latitude_2:
          description: Device location's latitude by cell tower information in Decimal
            degrees.
          example: 48.790625
          nullable: true
          type: number
        cell_tower_longitude:
          description: Device location's longitude  by cell tower information in Decimal
            degrees.
          example: 14.269965
          nullable: true
          type: number
        cell_tower_longitude_2:
          description: Device location's longitude  by cell tower information in Decimal
            degrees.
          example: 14.269965
          nullable: true
          type: number
        cell_tower_accuracy:
          description: Device location's set by cell tower accuracy.
          example: 14.269965
          nullable: true
          type: number
        cell_tower_accuracy_2:
          description: Device location's set by cell tower accuracy.
          example: 14.269965
          nullable: true
          type: number
        last_update_at:
          description: When was device last updated at.
          format: date-time
          type: string
        management_credit_type:
          description: Credit type name.
          example: management_5y
          type: string
        management_credit_type_name:
          description: Credit type full name.
          example: Paid Management pack 5y.
          type: string
        management_credit_type_id:
          description: Credit type id.
          example: 2
          type: integer
        data_credit_type:
          description: Credit type name.
          example: data_150GB_10y
          type: string
        data_credit_type_name:
          description: Credit type full name.
          example: Free Connection Data pack 150GB 10y.
          type: string
        data_credit_type_id:
          description: Credit type id.
          example: 6
          type: integer
        ddns_rules_count:
          description: DDNS rules count on device.
          example: 3
          type: integer
        tags:
          description: Device's tags list.
          items:
            $ref: '#/components/schemas/device_body_tags'
          type: array
      type: object
    devices_update:
      properties:
        data:
          items:
            $ref: '#/components/schemas/devices_update_data'
          type: array
      required:
      - data
      type: object
    device_add:
      properties:
        data:
          description: Data wrapper.
          items:
            $ref: '#/components/schemas/device_add_data'
          type: array
      required:
      - data
      type: object
    devices_delete:
      properties:
        device_id:
          description: Array of devices to remove (ids only).
          items:
            example: 2745
            minimum: 1
            type: integer
          type: array
      required:
      - devices
      type: object
    device_update:
      properties:
        name:
          description: Device name.
          example: New device
          type: string
        description:
          description: Device new description.
          example: Device description.
          type: string
        dynamic_monitoring:
          description: Determinate at what interval dynamic monitoring will collect
            data. 0 - to turn off monitoring.
          example: 60
          minimum: 60
          type: integer
        static_monitoring:
          description: Determinate at what interval static monitoring will collect
            data. 0 - to turn off monitoring.
          example: 0
          minimum: 60
          type: integer
        hotspot_monitoring:
          description: Determinate at what interval hotspot monitoring will collect
            data. 0 - to turn off monitoring.
          example: 60
          minimum: 60
          type: integer
        io_monitoring:
          description: Determinate at what interval I/O monitoring will collect data.
            0 - to turn off monitoring.
          example: 60
          minimum: 60
          type: integer
        gps_monitoring:
          description: Determinate at what interval gps monitoring will collect data.
            0 - to turn off monitoring.
          example: 0
          minimum: 60
          type: integer
        wireless_monitoring:
          description: Determinate at what interval gps monitoring will collect data.
            0 - to turn off monitoring.
          example: 0
          minimum: 60
          type: integer
        vpn_monitoring:
          description: Determinate at what interval vpn monitoring will collect data.
            0 - to turn off monitoring.
          example: 0
          minimum: 60
          type: integer
        user_set_latitude:
          description: Device latitude in Decimal degrees.
          example: 54.898798
          format: float
          nullable: true
          type: number
        user_set_longitude:
          description: Device longitude in Decimal degrees.
          example: 23.964856
          format: float
          nullable: true
          type: number
        tag_id:
          description: Tags ids that device must have. If left empty will remove all
            tags.
          items:
            description: Id of a tag.
            example: 77
            minimum: 1
            type: integer
          type: array
      type: object
    device_import:
      properties:
        type:
          description: Uploaded file format.
          enum:
          - csv
          - xls
          type: string
        device_series:
          description: Device model series. Required when type is csv.
          enum:
          - rut
          - trb
          - tcr
          - tap
          - otd
          example: rut
          type: string
        company_id:
          description: Id of company that device will belong to.
          example: 5147
          type: integer
        auto_credit_enable:
          description: Should system automatically enable credits usage for these
            devices.
          example: true
          type: boolean
        add_without_password:
          description: This parameter is available for company administrators. Passwords
            can be ignored.
          example: true
          type: boolean
        firmware_file_id:
          description: Firmware file ID. Must be owner of the file and it must be
            compatible with series of device (device_series).
          example: 1125
          type: integer
        config_file_id:
          description: Config (backup) file ID. Must be owner of the file.
          example: 6210
          type: integer
        file:
          description: A csv or xls file that contains information about new devices.
          format: binary
          type: string
        tag_id:
          description: List of tags.
          items:
            description: Tag ID.
            type: integer
          type: array
      required:
      - auto_credit_enable
      - company_id
      - device_series
      - file
      - type
      type: object
    devices_monitoring:
      properties:
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/devices_monitoring_data'
          type: array
      required:
      - data
      type: object
    set_device_tags:
      properties:
        file:
          description: A csv file that contains information about devices.
          format: binary
          type: string
        first_parameter:
          description: First parameter used to describe every device in file.
          enum:
          - mac
          - serial
          example: mac
          type: string
        tag_id:
          description: List of tag ids.
          items:
            description: Tag id that will be set for devices in file.
            example: 7841
            type: integer
          type: array
      required:
      - file
      - first_parameter
      - tag_id
      type: object
    error_of_multi_status:
      description: Errors that occurred during bulk execution.
      items:
        properties:
          code:
            description: Constant code that indicates specific information about error.
            example: SOME_ERROR_CODE
            type: string
          source:
            description: Error source.
            example: "784551"
            nullable: true
            type: string
          message:
            description: Default error message.
            example: Not found.
            type: string
        type: object
      type: array
    device_assign_tags:
      properties:
        data:
          items:
            $ref: '#/components/schemas/device_assign_tags_data'
          type: array
      required:
      - data
      type: object
    device_overwrite_tags:
      properties:
        data:
          items:
            $ref: '#/components/schemas/device_overwrite_tags_data'
          type: array
      required:
      - data
      type: object
    device_unassign_tags:
      properties:
        data:
          items:
            $ref: '#/components/schemas/device_overwrite_tags_data'
          type: array
      required:
      - data
      type: object
    connect_webui:
      properties:
        duration:
          description: How long link will be active (in seconds).
          example: 400
          minimum: 10
          type: integer
      required:
      - duration
      type: object
    duration:
      description: How long link will be active (in seconds).
      example: 400
      minimum: 10
      type: integer
    connect_cli:
      properties:
        duration:
          description: How long link will be active (in seconds).
          example: 400
          minimum: 10
          type: integer
      required:
      - duration
      type: object
    rms_connect:
      properties:
        duration:
          description: How long link will be active (in seconds).
          example: 400
          minimum: 10
          type: integer
      required:
      - duration
      type: object
    rms_connect_status:
      properties:
        id:
          description: Array of access rule ids.
          items:
            description: ID of a access rule.
            example: 411
            type: integer
          type: array
      required:
      - id
      type: object
    mobile_device_create:
      properties:
        device_token:
          description: Firebase token.
          example: fdygykhgjl3gh5df6gj1f3hhgjffk1gfg1hj6f1h
          maxLength: 200
          type: string
        manufacturer:
          description: Mobile phone manufacturer.
          example: Sony
          maxLength: 100
          type: string
        model:
          description: Mobile phone model.
          example: J9210
          maxLength: 100
          type: string
        operating_system:
          description: Phone's operating system.
          enum:
          - android
          - ios
          example: android
          type: string
        hardware:
          description: Phone's hardware.
          example: qcom
          maxLength: 100
          type: string
        device_uuid:
          description: Phone's uuid, if none provided it will be generated.
          example: 62968a96-8212-44dd-a391-77c6d180cd62
          type: string
        screen_height:
          description: Height of phone screen.
          example: 2382
          minimum: 0
          type: integer
        screen_width:
          description: Width of phone screen.
          example: 1080
          minimum: 0
          type: integer
        battery:
          description: Battery left of mobile phone.
          example: 42
          type: integer
        latitude:
          description: Phone location - latitude.
          example: 58.10504
          type: number
        longitude:
          description: Phone location - longitude.
          example: 56.24008
          type: number
        cpu_usage:
          description: Phone's cpu usage.
          example: 80%
          type: string
        network_state:
          description: Phone's network state.
          example: LTE
          type: string
      required:
      - device_token
      - hardware
      - manufacturer
      - model
      - operating_system
      - screen_height
      - screen_width
      type: object
    mobile_device_edit:
      properties:
        battery:
          description: Battery left of mobile phone.
          example: 42
          type: integer
        latitude:
          description: Phone location - latitude.
          example: 58.10504
          type: number
        longitude:
          description: Phone location - longitude.
          example: 56.24008
          type: number
        cpu_usage:
          description: Phone's cpu usage.
          example: 80%
          type: string
        network_state:
          description: Phone's network state.
          example: LTE
          type: string
        tag_id:
          description: List of tags to set for this mobile device.
          items:
            description: Tag id.
            example: 1
            type: integer
          type: array
      type: object
    mobile_device_connection_create:
      properties:
        mobile_device_id:
          description: Mobile device from which connection will be made id.
          example: 10
          minimum: 1
          type: integer
        name:
          description: Connection name.
          example: Connection 1
          type: string
        ip:
          description: Connection ip address.
          example: 127.0.0.1
          type: string
        port:
          description: Connection port.
          example: "8080"
          type: string
        protocol:
          description: Connection protocol.
          enum:
          - http
          - https
          - rdp
          - vnc
          - ssh
          example: ssh
          type: string
      required:
      - ip
      - mobile_device_id
      - name
      - port
      - protocol
      type: object
    mobile_device_connection_edit:
      properties:
        mobile_device_id:
          description: Mobile device from which connection will be made id.
          example: 10
          minimum: 1
          type: integer
        name:
          description: Connection name.
          example: Connection 1
          type: string
        ip:
          description: Connection ip address.
          example: 127.0.0.1
          type: string
        port:
          description: Connection port.
          example: "8080"
          type: string
        protocol:
          description: Connection protocol.
          enum:
          - http
          - https
          - rdp
          - vnc
          - ssh
          example: ssh
          type: string
      type: object
    mobile_device_connection_access_create:
      properties:
        mobile_device_connection_id:
          description: Mobile device connection to which access will be made id.
          example: 10
          minimum: 1
          type: integer
        duration:
          description: For how long will that access will be available.
          example: 360
          type: integer
      required:
      - mobile_device_id
      - name
      type: object
    device_remote_access_post:
      properties:
        data:
          items:
            $ref: '#/components/schemas/device_remote_access_post_data'
          required:
          - destination_ip
          - destination_port
          - device_id
          - name
          type: array
      required:
      - data
      type: object
    devices_remote_access_delete:
      properties:
        id:
          description: Array of access id to remove (ids only).
          items:
            example: 2745
            minimum: 1
            type: integer
          type: array
      required:
      - id
      type: object
    devices_remote_access_update:
      properties:
        device_id:
          description: Device id.
          example: 1
          minimum: 1
          type: integer
        name:
          description: Name of remote access (alpha_dash only).
          example: The_name
          maxLength: 50
          minLength: 3
          type: string
        destination_ip:
          description: Destination ip.
          example: 127.0.0.1
          format: ipv4
          type: string
        destination_port:
          description: Destination port.
          example: 8000
          maxLength: 65535
          minLength: 0
          type: integer
        protocol:
          description: Connection protocol
          enum:
          - http
          - https
          - ssh
          - rdp
          - vnc
          type: string
        credentials_required:
          description: Set if credentials be required on connect
          example: false
          type: boolean
        tag_id:
          description: Test
          example:
          - 1
          - 2
          items:
            type: integer
          type: array
      type: object
    device_action:
      properties:
        action:
          description: Action to be executed for given devices list.
          enum:
          - download_troubleshoot
          - download_eventslog
          - download_backup
          - update_metrics_data
          - reboot
          example: download_troubleshoot
          type: string
        device_id:
          description: Array full of devices ids.
          items:
            description: Device id.
            example: 46920
            type: integer
          type: array
      required:
      - action
      - device_id
      type: object
    set_updates:
      properties:
        data:
          items:
            $ref: '#/components/schemas/set_updates_data'
          type: array
      required:
      - data
      type: object
    cancel_updates:
      properties:
        data:
          items:
            $ref: '#/components/schemas/cancel_updates_data'
          type: array
      required:
      - data
      type: object
    cancel_action:
      properties:
        device_id:
          description: List of devices ID. Cancels all device actions.
          items:
            description: Device ID
            type: integer
          type: array
        job_id:
          description: List of jobs ID. Cancel specific job.
          items:
            description: Job ID
            type: integer
          type: array
      type: object
    deleted_at:
      description: Timestamp of entry's deletion.
      example: 2012-12-12 12:12:12
      pattern: Y-m-d H:i:s
      type: string
    device_passwords_upload:
      properties:
        file:
          description: A csv file that contains serials and passwords.
          format: binary
          type: string
        show_password:
          description: Show changed password in summary
          example: false
          type: bool
      required:
      - file
      type: object
    meta_channel:
      description: Metadata wrapper. Can have many other metadata properties.
      example:
        channel: private-status.1.6AY8tkkgOAu2AFaoNtUeBhykaJIcTx8y6AY8tkkgOAu2AFaoNtUeBhykaJIcTx8y
      properties:
        channel:
          description: Status channel id.
          example: private-status.1.6AY8tkkgOAu2AFaoNtUeBhykaJIcTx8y6AY8tkkgOAu2AFaoNtUeBhykaJIcTx8y
          type: string
      type: object
    generate_password:
      properties:
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/generate_password_data'
          type: array
      required:
      - devices
      - length
      - use_special
      type: object
    set_passwords:
      properties:
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/set_passwords_data'
          type: array
      required:
      - devices
      - password
      - password_confirmation
      type: object
    add_device_credit:
      properties:
        data:
          items:
            $ref: '#/components/schemas/add_device_credit_data'
          type: array
      required:
      - credit_type_id
      - data
      type: object
    user_add:
      properties:
        username:
          description: User name
          example: Username123
          type: string
        password:
          description: Password
          example: Password123
          format: password
          type: string
      required:
      - password
      - username
      type: object
    reports_add:
      properties:
        name:
          description: Report name.
          example: Report1
          maximum: 100
          type: string
        description:
          description: Report description.
          example: Description of report1
          maximum: 200
          type: string
        type:
          description: Type of report.
          enum:
          - single
          - periodic
          example: single
          type: string
        period:
          description: Period of report.
          enum:
          - day
          - week
          - month
          - custom
          example: day
          type: string
        parameters:
          description: Available report parameters
          example:
          - router_uptime
          - temperature
          - connection_uptime
          - connection_type
          - operator
          - data_usage
          - signal
          items:
            type: string
          type: array
        applied_by:
          description: What report applies to.
          enum:
          - device
          - company
          - tag
          example: device
          type: string
        apply_list:
          description: List of items ids that this report applies to.
          items:
            description: Id of applied_by value.
            example: 1
            type: integer
          type: array
        start_date:
          description: Period start date. Required if period is set to custom.
          example: ' 2019-08-22 00:00:00 '
          pattern: Y-m-d H:i:s
          type: string
        end_date:
          description: Period end date. Required if period is set to custom.
          example: ' 2019-08-30 00:00:00 '
          pattern: Y-m-d H:i:s
          type: string
      required:
      - applied_by
      - apply_list
      - parameters
      - period
      - type
      type: object
    reports_update:
      properties:
        name:
          description: Report name.
          example: Report1
          maximum: 100
          type: string
        description:
          description: Report description.
          example: Description of report1
          maximum: 200
          type: string
        type:
          description: Type of report.
          enum:
          - single
          - periodic
          example: single
          type: string
        period:
          description: Period of report.
          enum:
          - day
          - week
          - month
          - custom
          example: day
          type: string
        parameters:
          description: Available report parameters
          example:
          - router_uptime
          - temperature
          - connection_uptime
          - connection_type
          - operator
          - data_usage
          - signal
          items:
            type: string
          type: array
        applied_by:
          description: What report applies to.
          enum:
          - device
          - company
          - tag
          example: device
          type: string
        is_active:
          description: Is report active. Required if type is periodic.
          example: false
          type: boolean
        apply_list:
          description: List of items ids that this report applies to.
          items:
            description: Id of applied_by value.
            example: 1
            type: integer
          type: array
        start_date:
          description: Period start date. Required if period is set to custom.
          example: ' 2019-08-22 00:00:00 '
          pattern: Y-m-d H:i:s
          type: string
        end_date:
          description: Period end date. Required if period is set to custom.
          example: ' 2019-08-30 00:00:00 '
          pattern: Y-m-d H:i:s
          type: string
      type: object
    generated_report_edit:
      properties:
        name:
          description: Name of report (required if description is empty).
          example: Report3000
          type: string
        description:
          description: Description of report (required if name is empty).
          example: Report3000 description
          type: string
      required:
      - description
      - name
      type: object
    credits_move:
      properties:
        source:
          description: Id of company from which credits will be moved.
          example: 6951
          minimum: 1
          type: integer
        target:
          description: Id of company to which credits will be moved.
          example: 4717
          minimum: 1
          type: integer
        amount:
          description: Number of credits to be moved.
          example: 10
          type: integer
        credit_type_name:
          description: Credit type name.
          example: credit
          type: string
      required:
      - amount
      - credit_type_name
      - from_company_id
      - to_company_id
      type: object
    credits_tokens_add:
      properties:
        amount:
          description: Number of cretids to add to credit code.
          example: 4
          type: integer
        comment:
          description: Comment.
          example: Some example comment
          type: string
        company_id:
          description: Company_id.
          example: 458
          minimum: 1
          type: integer
        credit_type_name:
          description: Credit type name.
          enum:
          - credit
          - management_5y
          - management_10y
          - data_150GB_10y
          example: credit
          type: string
      required:
      - amount
      - credit_type_name
      type: object
    credits_tokens_activate:
      properties:
        code:
          description: Activation code.
          example: ly0f38erw5otka1sq497dimb2pu6jvhg
          type: string
      required:
      - code
      type: object
    credits_token_edit:
      properties:
        comment:
          description: A comment.
          example: Please, do not mind me.
          maxLength: 1000
          type: string
      type: object
    alerts_token_add:
      properties:
        token:
          description: Alert token.
          example: eyJ0eXAiOiJKV1bGciOiJSUzI1NiJ9.eyJpciLCJhdWQiOiIxMjcCJp6MTU2NTI3MTk0OSwianRpIjoLCJpZCI
          type: string
      required:
      - token
      type: object
    alert_config_update:
      properties:
        subject:
          description: Subject.
          example: Example subject
          type: string
        message:
          description: Message.
          example: Example message
          type: string
        enable:
          description: Enable alert config.
          example: true
          type: boolean
        redundancy_enable:
          description: Redundancy enable.
          example: true
          type: boolean
        redundancy_interval:
          description: Redundancy interval in minutes.
          example: 1
          type: integer
        smtp_config_id:
          description: Simple Mail Transfer Protocol configuration id.
          example: 1
          type: integer
      type: object
    alert_config_add:
      properties:
        data:
          description: Data wrapper.
          items:
            $ref: '#/components/schemas/alert_config_add_data'
          type: array
      required:
      - data
      type: object
    email_configs_add:
      properties:
        name:
          description: Email name.
          example: '@example.lt'
          type: string
        host:
          description: Host name.
          example: sslo-ovh.net
          type: string
        port:
          description: Port number.
          example: 587
          type: integer
        email:
          description: Email address.
          example: example@mail.lt
          type: string
        username:
          description: Username.
          example: example.username
          type: string
        password:
          description: Password.
          example: Password123
          format: password
          type: string
      required:
      - email
      - host
      - name
      - password
      - port
      - username
      type: object
    email_configs_edit:
      properties:
        name:
          description: Email name.
          example: '@example.lt'
          type: string
        host:
          description: Host name.
          example: some.host.com
          type: string
        port:
          description: Port number.
          example: 587
          type: integer
        email:
          description: Email address.
          example: example@mail.lt
          type: string
        username:
          description: Username.
          example: example.username
          type: string
        password:
          description: Password.
          example: Password123
          format: password
          type: string
      type: object
    files_add:
      properties:
        type:
          description: Type of file.
          enum:
          - config
          - firmware
          - device_task_manager_file
          type: string
        description:
          description: Description of the file.
          example: Some info
          type: string
        company_id:
          description: Id of the company.
          example: 2
          type: integer
        file:
          description: A file.
          format: binary
          type: string
      required:
      - file
      - type
      type: object
    files_update:
      properties:
        description:
          description: Updated description of the file.
          maxLength: 255
          type: string
      required:
      - description
      type: object
    files_download_zip:
      properties:
        files:
          description: Array of files ids.
          items:
            example: 1548
            type: integer
          type: array
      required:
      - files
      type: object
    device_tasks_edit:
      properties:
        name:
          description: Name of task.
          example: Task 1
          type: string
        order:
          description: Device task order in group.
          example: 2
          minimum: 0
          type: integer
        stop_on_failure:
          description: Stop this task on failure.
          example: true
          type: boolean
        timeout:
          description: Task timeout in seconds.
          example: 10
          maximum: 300
          minimum: 1
          type: integer
      required:
      - name
      - order
      - stop_on_failure
      - timeout
      type: object
    device_task_groups_create:
      properties:
        name:
          description: Task group name.
          example: Task group 1
          type: string
        failed_tag_id:
          description: The list of tags will be added once the task is failed.
          items:
            description: Tag ID.
            type: integer
          type: array
        success_tag_id:
          description: The list of tags will be added once the task is completed successfully.
          items:
            description: Tag ID.
            type: integer
          type: array
        tasks:
          description: List of task for this group.
          items:
            $ref: '#/components/schemas/device_task_groups_create_tasks'
          type: array
      required:
      - name
      - tasks
      type: object
    device_task_groups_edit:
      properties:
        name:
          description: Task group name.
          example: Task group 1
          type: string
        tasks:
          description: List of task for this group.
          items:
            $ref: '#/components/schemas/device_task_groups_create_tasks'
          type: array
      type: object
    device_task_groups_execute:
      properties:
        device_id:
          items:
            description: Device id that task group will be executed on.
            example: 1
            type: integer
          type: array
        tasks:
          items:
            $ref: '#/components/schemas/device_task_groups_execute_tasks'
          type: array
      required:
      - device_id
      type: object
    execute_command:
      properties:
        command:
          description: Command to be executed in device.
          example: echo 'hello world';
          type: string
      required:
      - command
      type: object
    role_body:
      example:
        permissions_count: 56
        company_id: 55
        updated_at: 2000-01-23T04:56:07.000+00:00
        company_name: Company name
        name: name
        description: Admin role can do anything.
        created_at: 2000-01-23T04:56:07.000+00:00
        id: 70810
        title: Admin role
      properties:
        id:
          description: Id of a role.
          example: 70810
          type: integer
        title:
          description: Role title.
          example: Admin role
          type: string
        name:
          type: string
        company_name:
          description: Determines the name to which company role belongs to.
          example: Company name
          type: string|null
        company_id:
          description: Determines to which company role belongs to. Null for default
            roles.
          example: 55
          type: integer|null
        description:
          description: Role description
          example: Admin role can do anything.
          type: string
        permissions_count:
          description: Number of assigned permissions to role.
          example: 56
          type: integer
        updated_at:
          description: Date at which role was updated.
          format: date-time
          type: string
        created_at:
          description: Date at which roles was created.
          format: date-time
          type: string
      type: object
    role_create:
      properties:
        title:
          description: Title of a role.
          example: Admin role
          type: string
        description:
          description: Description of a role.
          example: Admin role can do anything
          type: string
        company_id:
          description: Array of company ids.
          items:
            example: 12
            type: integer
          type: array
        permission_id:
          description: Array of permission ids.
          items:
            example: 35
            type: integer
          type: array
      required:
      - company_id
      - permission_id
      - title
      type: object
    role_update:
      properties:
        id:
          description: Id of the role
          example: 35
          type: integer
        title:
          description: Title of a role.
          example: Admin role
          type: string
        description:
          description: Description of a role.
          example: Admin role can do anything
          type: string
        permission_id:
          description: Array of permission ids.
          items:
            example: 35
            type: integer
          type: array
      required:
      - id
      type: object
    permission_body:
      example:
        name: view_devices
        description: description
        created_at: 2000-01-23T04:56:07.000+00:00
        id: 70810
        title: Allows to view devices
        category: Devices
      properties:
        id:
          description: Id of a permission.
          example: 70810
          type: integer
        title:
          description: Permission description
          example: Allows to view devices
          type: string
        description:
          type: string
        name:
          description: Permission name
          example: view_devices
          type: string
        category:
          description: Permission category
          example: Devices
          type: string
        created_at:
          description: Date at which permission was added.
          format: date-time
          type: string
      type: object
    roles_permissions_update:
      properties:
        role_id:
          description: Array of role ids.
          items:
            example: 10
            type: integer
          type: array
        permission_id:
          description: Array of permission ids.
          items:
            example: 35
            type: integer
          type: array
      required:
      - permission_id
      - role_id
      type: object
    exchange_credits:
      properties:
        company_id:
          description: Company ID in which credits exchange be made.
          example: 1
          type: integer
        credits:
          description: Amount of credits that will be exchanged.
          type: integer
      required:
      - company_id
      - credits
      type: object
    vpn_hub_add:
      properties:
        name:
          description: VPN hub name
          example: VPN
          type: string
        company_id:
          description: Company ID that the VPN Hub will belong to
          example: 1241
          type: integer
        description:
          description: VPN hub description.
          example: Some example comment
          type: string
        hub_zone:
          description: VPN hub server location.
          enum:
          - frankfurt-1
          - bahrain-1
          example: frankfurt-1
          type: string
        vpn_type:
          enum:
          - tap
          - tun
          type: string
        tag_id:
          description: Vpn hub tags list.
          items:
            example: 1
            minimum: 1
            type: integer
          type: array
      required:
      - hub_zone
      - name
      type: object
    BaseErrorModel:
      allOf:
      - $ref: '#/components/schemas/BaseResponseModel'
      - $ref: '#/components/schemas/BaseErrorModel_allOf'
    BaseResponseModel:
      properties:
        data:
          $ref: '#/components/schemas/BaseResponseModel_data'
        event:
          description: Static value that represents a request type.
          example: status
          type: string
      required:
      - data
      - event
      type: object
    BaseSuccessModel:
      allOf:
      - $ref: '#/components/schemas/BaseResponseModel'
      - $ref: '#/components/schemas/BaseSuccessModel_allOf'
    vpn_hub_delete:
      properties:
        id:
          description: VPN hub id list.
          items:
            example: 1
            minimum: 1
            type: integer
          type: array
      required:
      - id
      type: object
    vpn_quick_hub_add:
      properties:
        company_id:
          description: Company id of vpn hub.
          example: 1
          type: integer
        hub_name:
          description: VPN hub name
          type: string
        description:
          description: VPN hub description.
          example: Some example comment
          type: string
        hub_zone:
          description: VPN hub server location.
          enum:
          - frankfurt-1
          - bahrain-1
          example: frankfurt-1
          type: string
        endpoint:
          description: endpoint
          items:
            type: object
          properties:
            device_id:
              description: Device ID.
              example: 1
              type: integer
            routes:
              description: Routes.
              items:
                type: object
              properties:
                ip:
                  description: IP address
                  example: 1.1.1.1
                  type: string
                name:
                  description: Route name
                  type: string
                netmask:
                  description: Netmask address
                  example: 1.1.1.1
                  type: string
              required:
              - ip
              - name
              - netmask
              type: array
          required:
          - device_id
          type: array
        tag_id:
          description: Vpn hub tags list.
          items:
            example: 1
            minimum: 1
            type: integer
          type: array
      required:
      - company_id
      - endpoint
      - hub_name
      - hub_zone
      type: object
    vpn_hub_add_device:
      properties:
        device_id:
          description: VPN hub id list.
          items:
            example: 1
            minimum: 1
            type: integer
          type: array
      required:
      - device_id
      type: object
    vpn_hub_delete_device:
      properties:
        device_id:
          description: VPN hub id list.
          items:
            example: 1
            minimum: 1
            type: integer
          type: array
      required:
      - device_id
      type: object
    store_device_rules:
      properties:
        network:
          enum:
          - wan
          - lan
          example: lan
          type: string
        status:
          description: enable / disable
          type: boolean
      required:
      - network
      - status
      type: object
    vpn_hub_update:
      properties:
        tag_id:
          description: VPN hub id list.
          items:
            example: 1
            minimum: 1
            type: integer
          type: array
        description:
          description: Update VPN hub description.
          type: string
      type: object
    vpn_hub_toggle:
      properties:
        enabled:
          type: boolean
        duration:
          description: Quick hub duration length.
          type: integer
      type: object
    vpn_hub_settings:
      properties:
        netmask:
          description: Netmask
          type: string
        ip:
          type: string
      required:
      - ip
      - netmask
      type: object
    vpn_hub_users_add:
      properties:
        vpn_hub_id:
          description: VPN hub id.
          type: integer
        user_id:
          description: RMS user id.
          type: integer
      required:
      - user_id
      - vpn_hub_id
      type: object
    vpn_hub_custom_users_add:
      properties:
        vpn_hub_id:
          description: VPN hub id.
          type: integer
        username:
          description: VPN hub username.
          type: string
      required:
      - username
      - vpn_hub_id
      type: object
    vpn_hub_users_config:
      properties:
        mode:
          description: VPN hub id.
          enum:
          - static
          - dhcp
          type: string
        ip_address:
          description: Ip address.
          type: string
      required:
      - mode
      type: object
    vpn_hub_users_toggle:
      properties:
        enabled:
          type: boolean
      required:
      - enabled
      type: object
    add_vpn_hub_dhcp_config:
      properties:
        ip_address:
          description: ip address.
          type: string
        type:
          description: type.
          enum:
          - DNS
          - WINS
          type: string
      required:
      - ip_address
      - type
      type: object
    delete_vpn_hub_dhcp_config:
      properties:
        ip_address:
          description: ip address.
          type: string
        type:
          description: type.
          enum:
          - DNS
          - WINS
          type: string
      required:
      - ip_address
      - type
      type: object
    vpn_hub_route_add:
      properties:
        vpn_hub_id:
          description: Id of vpn hub.
          type: integer
        ip_address:
          description: Ip address.
          type: string
        netmask:
          description: Netmask.
          type: string
        vpn_hub_user_id:
          description: Id of vpn hub user.
          type: integer
      required:
      - ip_address
      - netmask
      - vpn_hub_id
      - vpn_hub_user_id
      type: object
    vpn_hub_route_delete:
      properties:
        ip_address:
          description: Ip address.
          type: string
        netmask:
          description: Netmask.
          type: string
        vpn_hub_user_id:
          description: Id of vpn hub user.
          type: integer
      required:
      - ip_address
      - netmask
      - vpn_hub_user_id
      type: object
    get_configuration:
      properties:
        device_id:
          description: The ID of the device.
          type: integer
        endpoints:
          description: The endpoints to be validated.
          items:
            $ref: '#/components/schemas/get_configuration_endpoints'
          type: array
      required:
      - device_id
      type: object
    send_configuration:
      properties:
        configuration:
          description: The configuration to be validated.
          items:
            $ref: '#/components/schemas/send_configuration_configuration'
          type: array
      type: object
    create_template:
      properties:
        company_id:
          description: The ID of the company that owns the template
          type: integer
        name:
          description: The name of the template
          type: string
        version:
          description: The version number of the template (in the format x.y.z)
          type: string
        template:
          items:
            $ref: '#/components/schemas/create_template_template'
          type: array
      required:
      - company_id
      - name
      - template
      - version
      type: object
    use_template:
      properties:
        device_id:
          items:
            description: Device id
            example: 7841
            type: integer
          type: array
      required:
      - device_id
      type: object
    automation_body:
      example:
        devices_count: 5
        company_id: 10
        total_triggered_count: 6
        conditions_body_version: conditions_body_version
        delay_repetitions_count: 4
        cooldown_duration: 60
        description: Automation that does something.
        created_at: created_at
        data_group: data_group
        delay_enabled: true
        enabled: true
        active_devices_count: 2
        period_latest_reset: period_latest_reset
        period_trigger_limit: 5
        user_id: 0
        name: Test automation
        cooldown_enabled: true
        automation_version: automation_version
        id: 12
        period_triggered_count: 1
        conditions_body:
        - '{}'
        delay_duration: 60
      properties:
        id:
          description: Id of the automation.
          example: 12
          type: integer
        name:
          description: Name of the automation.
          example: Test automation
          type: string
        description:
          description: Description of the automation.
          example: Automation that does something.
          type: string
        data_group:
          description: Data group of the parameters.
          type: string
        company_id:
          description: Company id that automation belongs.
          example: 10
          type: integer
        user_id:
          description: User id that created automation.
          type: integer
        cooldown_duration:
          description: Cooldown duration for the automation. In seconds.
          example: 60
          type: integer
        cooldown_enabled:
          description: Value indicating if cooldown is enabled.
          example: true
          type: boolean
        delay_enabled:
          description: Value indicating if delay is enabled.
          example: true
          type: boolean
        delay_repetitions_count:
          description: Number of delay repetitions.
          example: 4
          type: integer
        delay_duration:
          description: Delay duration.
          example: 60
          type: integer
        automation_version:
          description: Version of the automation.
          type: string
        conditions_body_version:
          description: Version of the conditions body.
          type: string
        total_triggered_count:
          description: Total count of times the automation has been triggered.
          type: integer
        period_triggered_count:
          description: Count of times the automation has been triggered in the current
            period.
          type: integer
        period_trigger_limit:
          description: Trigger limit for the automation in the current period.
          type: integer
        enabled:
          description: Value indicating if the automation is enabled.
          example: true
          type: boolean
        devices_count:
          description: Total count of devices assigned to the automation.
          type: integer
        active_devices_count:
          description: Count of active devices assigned to the automation.
          type: integer
        period_latest_reset:
          description: Date and time of the latest period reset
          type: string
        created_at:
          description: Date and time of when automation was created.
          type: string
        conditions_body:
          items:
            properties:
              type:
                description: The condition type.
                enum:
                - if
                example: if
                type: string
              expression:
                items:
                  properties:
                    parameter:
                      description: Condition parameter
                      example: temperature
                      type: string
                    operator:
                      description: The operator.
                      example: ==
                      type: string
                    value:
                      description: The value.
                      example: 10
                    joins_with:
                      description: The join condition.
                      example: '&&'
                      type: string
                  type: object
                maxItems: 4
                type: array
              actions:
                items:
                  properties:
                    name:
                      description: The action name.
                      enum:
                      - SendEmail
                      - ExportBackup
                      - ExportTroubleshoot
                      - ExportEventsLog
                      - Reboot
                      - TaskManagerAction
                      - SendNotification
                      example: SendEmail
                      type: string
                    options:
                      properties:
                        smtp_config_id:
                          description: The SMTP configuration ID.
                          example: 123
                          type: integer
                        subject:
                          description: The email subject.
                          example: Hello
                          type: string
                        message:
                          description: The email message.
                          example: Some message
                          type: string
                        receiving_emails:
                          description: The list of receiving emails.
                          items:
                            example: example@example.com
                            type: string
                          maxItems: 1
                          minItems: 1
                          type: array
                      type: object
                    tag:
                      description: Action tag
                      example: cond_0.SendEmail.3333333
                      type: string
                  type: object
                maxItems: 10
                type: array
              tag:
                description: Condition tag
                example: cond_0
                type: string
              conditions:
                items:
                  properties:
                    type:
                      description: The condition type.
                      enum:
                      - if
                      - else
                      example: if
                      type: string
                    expression:
                      description: The expression array.
                      items:
                        properties:
                          parameter:
                            description: Condition parameter.
                            example: temperature
                            type: string
                          operator:
                            description: The operator.
                            example: ==
                            type: string
                          value:
                            description: The value.
                            example: some_value
                          joins_with:
                            description: The join condition.
                            example: '&&'
                            type: string
                        type: object
                      maxItems: 4
                      type: array
                    actions:
                      description: The actions array.
                      items:
                        properties:
                          name:
                            description: The action name.
                            enum:
                            - SendEmail
                            - ExportBackup
                            - ExportTroubleshoot
                            - ExportEventsLog
                            - Reboot
                            - TaskManagerAction
                            - SendNotification
                            example: SendEmail
                            type: string
                          options:
                            properties:
                              smtp_config_id:
                                description: The SMTP configuration ID.
                                example: 123
                                type: integer
                              subject:
                                description: The email subject.
                                example: Hello
                                type: string
                              message:
                                description: The email message.
                                example: Some message
                                type: string
                              receiving_emails:
                                description: The list of receiving emails.
                                items:
                                  example: example@example.com
                                  type: string
                                maxItems: 1
                                minItems: 1
                                type: array
                            type: object
                          tag:
                            description: Action tag
                            example: cond_1.SendEmail.22222
                            type: string
                        type: object
                      maxItems: 10
                      type: array
                    tag:
                      description: Condition tag
                      example: cond_1
                      type: string
                    conditions:
                      description: The nested conditions array.
                      items:
                        properties:
                          type:
                            description: The condition type.
                            enum:
                            - if
                            - else
                            example: if
                            type: string
                          expression:
                            description: The expression array.
                            items:
                              properties:
                                parameter:
                                  description: The parameter.
                                  example: some_parameter
                                  type: string
                                operator:
                                  description: The operator.
                                  example: ==
                                  type: string
                                value:
                                  description: The value.
                                  example: some_value
                                joins_with:
                                  description: The join condition.
                                  example: '&&'
                                  type: string
                              type: object
                            maxItems: 4
                            type: array
                          actions:
                            description: The actions array.
                            items:
                              properties:
                                name:
                                  description: The action name.
                                  enum:
                                  - SendEmail
                                  - ExportBackup
                                  - ExportTroubleshoot
                                  - ExportEventsLog
                                  - Reboot
                                  - TaskManagerAction
                                  - SendNotification
                                  example: SendEmail
                                  type: string
                                options:
                                  properties:
                                    smtp_config_id:
                                      description: The SMTP configuration ID.
                                      example: 123
                                      type: integer
                                    subject:
                                      description: The email subject.
                                      example: Hello
                                      type: string
                                    message:
                                      description: The email message.
                                      example: Some message
                                      type: string
                                    receiving_emails:
                                      description: The list of receiving emails.
                                      items:
                                        example: example@example.com
                                        type: string
                                      maxItems: 1
                                      minItems: 1
                                      type: array
                                  type: object
                                tag:
                                  description: Action tag
                                  example: cond_2.SendEmail.11111
                                  type: string
                              type: object
                            maxItems: 10
                            type: array
                          tag:
                            description: Condition tag
                            example: cond_2
                            type: string
                        type: object
                      maxItems: 2
                      type: array
                  type: object
                maxItems: 2
                type: array
            type: object
          maxItems: 1
          type: array
      type: object
    automation_post_put:
      properties:
        name:
          description: Name of the automation.
          example: Test automation
          type: string
        description:
          description: Description of the automation.
          example: Automation that does something.
          type: string
        company_id:
          description: Company id that automation belongs.
          example: 10
          type: integer
        cooldown_duration:
          description: Cooldown duration for the automation. In seconds.
          example: 60
          type: integer
        cooldown_enabled:
          description: Value indicating if cooldown is enabled.
          example: true
          type: boolean
        delay_enabled:
          description: Value indicating if delay is enabled.
          example: true
          type: boolean
        delay_repetitions_count:
          description: Number of delay repetitions.
          example: 4
          type: integer
        delay_duration:
          description: Delay duration.
          example: 60
          type: integer
        enabled:
          description: Value indicating if the automation is enabled.
          example: true
          type: boolean
        conditions_body:
          items:
            properties:
              type:
                description: The condition type.
                enum:
                - if
                example: if
                type: string
              expression:
                items:
                  properties:
                    parameter:
                      description: Condition parameter
                      example: temperature
                      type: string
                    operator:
                      description: The operator.
                      example: ==
                      type: string
                    value:
                      description: The value.
                      example: 10
                    joins_with:
                      description: The join condition.
                      example: '&&'
                      type: string
                  type: object
                maxItems: 4
                type: array
              actions:
                items:
                  properties:
                    name:
                      description: The action name.
                      enum:
                      - SendEmail
                      - ExportBackup
                      - ExportTroubleshoot
                      - ExportEventsLog
                      - Reboot
                      - TaskManagerAction
                      - SendNotification
                      example: SendEmail
                      type: string
                    options:
                      oneOf:
                      - $ref: '#/components/schemas/send_email_action_options'
                      - $ref: '#/components/schemas/send_notification_action_options'
                      - $ref: '#/components/schemas/task_manager_action_options'
                  type: object
                maxItems: 10
                type: array
              conditions:
                items:
                  properties:
                    type:
                      description: The condition type.
                      enum:
                      - if
                      - else
                      example: if
                      type: string
                    expression:
                      description: The expression array.
                      items:
                        properties:
                          parameter:
                            description: Condition parameter.
                            example: temperature
                            type: string
                          operator:
                            description: The operator.
                            example: ==
                            type: string
                          value:
                            description: The value.
                            example: some_value
                          joins_with:
                            description: The join condition.
                            example: '&&'
                            type: string
                        type: object
                      maxItems: 4
                      type: array
                    actions:
                      description: The actions array.
                      items:
                        properties:
                          name:
                            description: The action name.
                            enum:
                            - SendEmail
                            - ExportBackup
                            - ExportTroubleshoot
                            - ExportEventsLog
                            - Reboot
                            - TaskManagerAction
                            - SendNotification
                            example: SendEmail
                            type: string
                          options:
                            oneOf:
                            - $ref: '#/components/schemas/send_email_action_options'
                            - $ref: '#/components/schemas/send_notification_action_options'
                            - $ref: '#/components/schemas/task_manager_action_options'
                        type: object
                      maxItems: 10
                      type: array
                    conditions:
                      description: The nested conditions array.
                      items:
                        properties:
                          type:
                            description: The condition type.
                            enum:
                            - if
                            - else
                            example: if
                            type: string
                          expression:
                            description: The expression array.
                            items:
                              properties:
                                parameter:
                                  description: The parameter.
                                  example: some_parameter
                                  type: string
                                operator:
                                  description: The operator.
                                  example: ==
                                  type: string
                                value:
                                  description: The value.
                                  example: some_value
                                joins_with:
                                  description: The join condition.
                                  example: '&&'
                                  type: string
                              type: object
                            maxItems: 4
                            type: array
                          actions:
                            description: The actions array.
                            items:
                              properties:
                                name:
                                  description: The action name.
                                  enum:
                                  - SendEmail
                                  - ExportBackup
                                  - ExportTroubleshoot
                                  - ExportEventsLog
                                  - Reboot
                                  - TaskManagerAction
                                  - SendNotification
                                  example: SendEmail
                                  type: string
                                options:
                                  oneOf:
                                  - $ref: '#/components/schemas/send_email_action_options'
                                  - $ref: '#/components/schemas/send_notification_action_options'
                                  - $ref: '#/components/schemas/task_manager_action_options'
                              type: object
                            maxItems: 10
                            type: array
                        type: object
                      maxItems: 2
                      type: array
                  type: object
                maxItems: 2
                type: array
            type: object
          maxItems: 1
          type: array
      type: object
    automation_log_body:
      example:
        evaluation_id: gaTqiZMFfFd9LYbHhylh
        device_name: RUT Device 1
        evaluated_parameters:
        - value: "35"
          key: temperature
        - value: "35"
          key: temperature
        company_id: 1534
        device_id: 7034
        evaluated_conditions:
        - value: true
          key: cond_0
        - value: true
          key: cond_0
        serial: "0000000000"
        company_name: Regular company
        overall_status: success
        created_at: 2000-01-23T04:56:07.000+00:00
        conditions_body:
        - '{}'
        mac: 00:00:00:00:00:00
      properties:
        company_id:
          description: Company id of device.
          example: 1534
          type: integer
        company_name:
          description: Company name of device.
          example: Regular company
          type: string
        created_at:
          description: Date at which log was created.
          format: date-time
          type: string
        device_id:
          description: Device id.
          example: 7034
          type: integer
        device_name:
          description: Name of device.
          example: RUT Device 1
          type: string
        evaluated_conditions:
          description: Conditions that were evaluated.
          items:
            $ref: '#/components/schemas/automation_log_body_evaluated_conditions'
          type: array
        evaluated_parameters:
          description: Parameters that were evaluated.
          items:
            $ref: '#/components/schemas/automation_log_body_evaluated_parameters'
          type: array
        evaluation_id:
          description: Evaluation id.
          example: gaTqiZMFfFd9LYbHhylh
          type: string
        mac:
          description: Device's mac.
          example: 00:00:00:00:00:00
          type: string
        overall_status:
          description: Defines overall status of all actions based on same evaluation
            performed at certain time.
          example: success
          type: string
        serial:
          description: Device serial number.
          example: "0000000000"
          type: string
        conditions_body:
          items:
            properties:
              type:
                description: The condition type.
                enum:
                - if
                example: if
                type: string
              expression:
                items:
                  properties:
                    parameter:
                      description: Condition parameter
                      example: temperature
                      type: string
                    operator:
                      description: The operator.
                      example: ==
                      type: string
                    value:
                      description: The value.
                      example: 10
                    joins_with:
                      description: The join condition.
                      example: '&&'
                      type: string
                  type: object
                maxItems: 4
                type: array
              actions:
                items:
                  properties:
                    name:
                      description: The action name.
                      enum:
                      - SendEmail
                      - ExportBackup
                      - ExportTroubleshoot
                      - ExportEventsLog
                      - Reboot
                      - TaskManagerAction
                      - SendNotification
                      example: SendEmail
                      type: string
                    options:
                      properties:
                        smtp_config_id:
                          description: The SMTP configuration ID.
                          example: 123
                          type: integer
                        subject:
                          description: The email subject.
                          example: Hello
                          type: string
                        message:
                          description: The email message.
                          example: Some message
                          type: string
                        receiving_emails:
                          description: The list of receiving emails.
                          items:
                            example: example@example.com
                            type: string
                          maxItems: 1
                          minItems: 1
                          type: array
                      type: object
                    tag:
                      description: Action tag
                      example: cond_0.SendEmail.3333333
                      type: string
                  type: object
                maxItems: 10
                type: array
              tag:
                description: Condition tag
                example: cond_0
                type: string
              conditions:
                items:
                  properties:
                    type:
                      description: The condition type.
                      enum:
                      - if
                      - else
                      example: if
                      type: string
                    expression:
                      description: The expression array.
                      items:
                        properties:
                          parameter:
                            description: Condition parameter.
                            example: temperature
                            type: string
                          operator:
                            description: The operator.
                            example: ==
                            type: string
                          value:
                            description: The value.
                            example: some_value
                          joins_with:
                            description: The join condition.
                            example: '&&'
                            type: string
                        type: object
                      maxItems: 4
                      type: array
                    actions:
                      description: The actions array.
                      items:
                        properties:
                          name:
                            description: The action name.
                            enum:
                            - SendEmail
                            - ExportBackup
                            - ExportTroubleshoot
                            - ExportEventsLog
                            - Reboot
                            - TaskManagerAction
                            - SendNotification
                            example: SendEmail
                            type: string
                          options:
                            properties:
                              smtp_config_id:
                                description: The SMTP configuration ID.
                                example: 123
                                type: integer
                              subject:
                                description: The email subject.
                                example: Hello
                                type: string
                              message:
                                description: The email message.
                                example: Some message
                                type: string
                              receiving_emails:
                                description: The list of receiving emails.
                                items:
                                  example: example@example.com
                                  type: string
                                maxItems: 1
                                minItems: 1
                                type: array
                            type: object
                          tag:
                            description: Action tag
                            example: cond_1.SendEmail.22222
                            type: string
                        type: object
                      maxItems: 10
                      type: array
                    tag:
                      description: Condition tag
                      example: cond_1
                      type: string
                    conditions:
                      description: The nested conditions array.
                      items:
                        properties:
                          type:
                            description: The condition type.
                            enum:
                            - if
                            - else
                            example: if
                            type: string
                          expression:
                            description: The expression array.
                            items:
                              properties:
                                parameter:
                                  description: The parameter.
                                  example: some_parameter
                                  type: string
                                operator:
                                  description: The operator.
                                  example: ==
                                  type: string
                                value:
                                  description: The value.
                                  example: some_value
                                joins_with:
                                  description: The join condition.
                                  example: '&&'
                                  type: string
                              type: object
                            maxItems: 4
                            type: array
                          actions:
                            description: The actions array.
                            items:
                              properties:
                                name:
                                  description: The action name.
                                  enum:
                                  - SendEmail
                                  - ExportBackup
                                  - ExportTroubleshoot
                                  - ExportEventsLog
                                  - Reboot
                                  - TaskManagerAction
                                  - SendNotification
                                  example: SendEmail
                                  type: string
                                options:
                                  properties:
                                    smtp_config_id:
                                      description: The SMTP configuration ID.
                                      example: 123
                                      type: integer
                                    subject:
                                      description: The email subject.
                                      example: Hello
                                      type: string
                                    message:
                                      description: The email message.
                                      example: Some message
                                      type: string
                                    receiving_emails:
                                      description: The list of receiving emails.
                                      items:
                                        example: example@example.com
                                        type: string
                                      maxItems: 1
                                      minItems: 1
                                      type: array
                                  type: object
                                tag:
                                  description: Action tag
                                  example: cond_2.SendEmail.11111
                                  type: string
                              type: object
                            maxItems: 10
                            type: array
                          tag:
                            description: Condition tag
                            example: cond_2
                            type: string
                        type: object
                      maxItems: 2
                      type: array
                  type: object
                maxItems: 2
                type: array
            type: object
          maxItems: 1
          type: array
      type: object
    automation_log_evaluationId_body:
      example:
        evaluation_id: gaTqiZMFfFd9LYbHhylh
        company_id: 1534
        device_id: 7034
        overall_status: success
        created_at: 2000-01-23T04:56:07.000+00:00
        mac: 00:00:00:00:00:00
        device_name: RUT Device 1
        evaluated_parameters:
        - value: "35"
          key: temperature
        - value: "35"
          key: temperature
        action_status_message: Succeeded
        evaluated_conditions:
        - value: true
          key: cond_0
        - value: true
          key: cond_0
        serial: "0000000000"
        company_name: Regular company
        conditions:
        - '{}'
        action_status: 1
      properties:
        action_status:
          description: Action status.
          example: 1
          type: integer
        action_status_message:
          description: Action status message
          example: Succeeded
          type: string
        company_id:
          description: Company id of device.
          example: 1534
          type: integer
        company_name:
          description: Company name of device.
          example: Regular company
          type: string
        created_at:
          description: Date at which log was created.
          format: date-time
          type: string
        device_id:
          description: Device id.
          example: 7034
          type: integer
        device_name:
          description: Name of device.
          example: RUT Device 1
          type: string
        evaluated_conditions:
          description: Conditions that were evaluated.
          items:
            $ref: '#/components/schemas/automation_log_body_evaluated_conditions'
          type: array
        evaluated_parameters:
          description: Parameters that were evaluated.
          items:
            $ref: '#/components/schemas/automation_log_body_evaluated_parameters'
          type: array
        evaluation_id:
          description: Evaluation id.
          example: gaTqiZMFfFd9LYbHhylh
          type: string
        mac:
          description: Device's mac.
          example: 00:00:00:00:00:00
          type: string
        overall_status:
          description: Defines overall status of all actions based on same evaluation
            performed at certain time.
          example: success
          type: string
        serial:
          description: Device serial number.
          example: "0000000000"
          type: string
        conditions:
          items:
            properties:
              type:
                description: The condition type.
                enum:
                - if
                example: if
                type: string
              expression:
                items:
                  properties:
                    parameter:
                      description: Condition parameter
                      example: temperature
                      type: string
                    operator:
                      description: The operator.
                      example: ==
                      type: string
                    value:
                      description: The value.
                      example: 10
                    joins_with:
                      description: The join condition.
                      example: '&&'
                      type: string
                  type: object
                maxItems: 4
                type: array
              actions:
                items:
                  properties:
                    name:
                      description: The action name.
                      enum:
                      - SendEmail
                      - ExportBackup
                      - ExportTroubleshoot
                      - ExportEventsLog
                      - Reboot
                      - TaskManagerAction
                      - SendNotification
                      example: SendEmail
                      type: string
                    options:
                      properties:
                        smtp_config_id:
                          description: The SMTP configuration ID.
                          example: 123
                          type: integer
                        subject:
                          description: The email subject.
                          example: Hello
                          type: string
                        message:
                          description: The email message.
                          example: Some message
                          type: string
                        receiving_emails:
                          description: The list of receiving emails.
                          items:
                            example: example@example.com
                            type: string
                          maxItems: 1
                          minItems: 1
                          type: array
                      type: object
                    tag:
                      description: Action tag
                      example: cond_0.SendEmail.3333333
                      type: string
                  type: object
                maxItems: 10
                type: array
              tag:
                description: Condition tag
                example: cond_0
                type: string
              conditions:
                items:
                  properties:
                    type:
                      description: The condition type.
                      enum:
                      - if
                      - else
                      example: if
                      type: string
                    expression:
                      description: The expression array.
                      items:
                        properties:
                          parameter:
                            description: Condition parameter.
                            example: temperature
                            type: string
                          operator:
                            description: The operator.
                            example: ==
                            type: string
                          value:
                            description: The value.
                            example: some_value
                          joins_with:
                            description: The join condition.
                            example: '&&'
                            type: string
                        type: object
                      maxItems: 4
                      type: array
                    actions:
                      description: The actions array.
                      items:
                        properties:
                          name:
                            description: The action name.
                            enum:
                            - SendEmail
                            - ExportBackup
                            - ExportTroubleshoot
                            - ExportEventsLog
                            - Reboot
                            - TaskManagerAction
                            - SendNotification
                            example: SendEmail
                            type: string
                          options:
                            properties:
                              smtp_config_id:
                                description: The SMTP configuration ID.
                                example: 123
                                type: integer
                              subject:
                                description: The email subject.
                                example: Hello
                                type: string
                              message:
                                description: The email message.
                                example: Some message
                                type: string
                              receiving_emails:
                                description: The list of receiving emails.
                                items:
                                  example: example@example.com
                                  type: string
                                maxItems: 1
                                minItems: 1
                                type: array
                            type: object
                          tag:
                            description: Action tag
                            example: cond_1.SendEmail.22222
                            type: string
                        type: object
                      maxItems: 10
                      type: array
                    tag:
                      description: Condition tag
                      example: cond_1
                      type: string
                    conditions:
                      description: The nested conditions array.
                      items:
                        properties:
                          type:
                            description: The condition type.
                            enum:
                            - if
                            - else
                            example: if
                            type: string
                          expression:
                            description: The expression array.
                            items:
                              properties:
                                parameter:
                                  description: The parameter.
                                  example: some_parameter
                                  type: string
                                operator:
                                  description: The operator.
                                  example: ==
                                  type: string
                                value:
                                  description: The value.
                                  example: some_value
                                joins_with:
                                  description: The join condition.
                                  example: '&&'
                                  type: string
                              type: object
                            maxItems: 4
                            type: array
                          actions:
                            description: The actions array.
                            items:
                              properties:
                                name:
                                  description: The action name.
                                  enum:
                                  - SendEmail
                                  - ExportBackup
                                  - ExportTroubleshoot
                                  - ExportEventsLog
                                  - Reboot
                                  - TaskManagerAction
                                  - SendNotification
                                  example: SendEmail
                                  type: string
                                options:
                                  properties:
                                    smtp_config_id:
                                      description: The SMTP configuration ID.
                                      example: 123
                                      type: integer
                                    subject:
                                      description: The email subject.
                                      example: Hello
                                      type: string
                                    message:
                                      description: The email message.
                                      example: Some message
                                      type: string
                                    receiving_emails:
                                      description: The list of receiving emails.
                                      items:
                                        example: example@example.com
                                        type: string
                                      maxItems: 1
                                      minItems: 1
                                      type: array
                                  type: object
                                tag:
                                  description: Action tag
                                  example: cond_2.SendEmail.11111
                                  type: string
                              type: object
                            maxItems: 10
                            type: array
                          tag:
                            description: Condition tag
                            example: cond_2
                            type: string
                        type: object
                      maxItems: 2
                      type: array
                  type: object
                maxItems: 2
                type: array
            type: object
          maxItems: 1
          type: array
      type: object
    device_body_2:
      example:
        device_id: 7034
        total_triggered_count: 3012
        created_at: 2000-01-23T04:56:07.000+00:00
        enabled: false
        mac: 00:00:00:00:00:00
        automation_id: 5634
        period_latest_reset: 2000-01-23T04:56:07.000+00:00
        device_name: RUT Device 1
        period_trigger_limit: 25
        last_triggered_at: 2000-01-23T04:56:07.000+00:00
        serial: "0000000000"
        period_triggered_count: 58
        firmware: RUT9XX_R_00.06.05.3
      properties:
        device_id:
          description: Device id.
          example: 7034
          type: integer
        automation_id:
          description: Automation id that device is assigned to.
          example: 5634
          type: integer
        total_triggered_count:
          description: Total number of times a device triggered any automations.
          example: 3012
          type: integer
        period_triggered_count:
          description: Number of times device triggered any automation before next
            reset.
          example: 58
          type: integer
        period_trigger_limit:
          description: Maximum Number of times device can trigger automations until
            next reset.
          example: 25
          type: integer
        period_latest_reset:
          description: Date at which latest reset happened.
          format: date-time
          type: string
        last_triggered_at:
          description: Date at which last time device triggered automation.
          format: date-time
          type: string
        created_at:
          description: Date at which device was assigned to automation.
          format: date-time
          type: string
        enabled:
          description: Is automation enabled for this device.
          example: false
          type: boolean
        mac:
          description: Device's mac.
          example: 00:00:00:00:00:00
          type: string
        serial:
          description: Device serial number.
          example: "0000000000"
          type: string
        device_name:
          description: Name of device.
          example: RUT Device 1
          type: string
        firmware:
          description: Device's current firmware.
          example: RUT9XX_R_00.06.05.3
          type: string
      type: object
    automations_id_devices_delete:
      items:
        properties:
          devices:
            description: List of device ids.
            items:
              description: Device id.
              example: 7841
              type: integer
            type: array
        required:
        - devices
        type: object
      type: array
    automations_activation:
      items:
        properties:
          enable:
            description: Enable/disable automation.
            example: true
            type: boolean
          automations:
            description: List of automation ids.
            items:
              description: Automations id.
              example: 7841
              type: integer
            type: array
        required:
        - automations
        - enabled
        type: object
      type: array
    automations_devices_activation:
      items:
        properties:
          enable:
            description: Enable/disable automation for device.
            example: true
            type: boolean
          devices:
            description: List of device ids.
            items:
              description: Device id.
              example: 7841
              type: integer
            type: array
        required:
        - devices
        - enabled
        type: object
      type: array
    automations_devices_assign:
      properties:
        data:
          items:
            $ref: '#/components/schemas/automations_devices_assign_data'
          type: array
      required:
      - data
      type: object
    automations_devices_unassign:
      properties:
        data:
          items:
            $ref: '#/components/schemas/automations_devices_unassign_data'
          type: array
      required:
      - data
      type: object
    devices_automations_overwrite:
      properties:
        data:
          items:
            $ref: '#/components/schemas/devices_automations_overwrite_data'
          type: array
      required:
      - data
      type: object
    conditions_body:
      items:
        properties:
          type:
            description: The condition type.
            enum:
            - if
            example: if
            type: string
          expression:
            items:
              properties:
                parameter:
                  description: Condition parameter
                  example: temperature
                  type: string
                operator:
                  description: The operator.
                  example: ==
                  type: string
                value:
                  description: The value.
                  example: 10
                joins_with:
                  description: The join condition.
                  example: '&&'
                  type: string
              type: object
            maxItems: 4
            type: array
          actions:
            items:
              properties:
                name:
                  description: The action name.
                  enum:
                  - SendEmail
                  - ExportBackup
                  - ExportTroubleshoot
                  - ExportEventsLog
                  - Reboot
                  - TaskManagerAction
                  - SendNotification
                  example: SendEmail
                  type: string
                options:
                  properties:
                    smtp_config_id:
                      description: The SMTP configuration ID.
                      example: 123
                      type: integer
                    subject:
                      description: The email subject.
                      example: Hello
                      type: string
                    message:
                      description: The email message.
                      example: Some message
                      type: string
                    receiving_emails:
                      description: The list of receiving emails.
                      items:
                        example: example@example.com
                        type: string
                      maxItems: 1
                      minItems: 1
                      type: array
                  type: object
                tag:
                  description: Action tag
                  example: cond_0.SendEmail.3333333
                  type: string
              type: object
            maxItems: 10
            type: array
          tag:
            description: Condition tag
            example: cond_0
            type: string
          conditions:
            items:
              properties:
                type:
                  description: The condition type.
                  enum:
                  - if
                  - else
                  example: if
                  type: string
                expression:
                  description: The expression array.
                  items:
                    properties:
                      parameter:
                        description: Condition parameter.
                        example: temperature
                        type: string
                      operator:
                        description: The operator.
                        example: ==
                        type: string
                      value:
                        description: The value.
                        example: some_value
                      joins_with:
                        description: The join condition.
                        example: '&&'
                        type: string
                    type: object
                  maxItems: 4
                  type: array
                actions:
                  description: The actions array.
                  items:
                    properties:
                      name:
                        description: The action name.
                        enum:
                        - SendEmail
                        - ExportBackup
                        - ExportTroubleshoot
                        - ExportEventsLog
                        - Reboot
                        - TaskManagerAction
                        - SendNotification
                        example: SendEmail
                        type: string
                      options:
                        properties:
                          smtp_config_id:
                            description: The SMTP configuration ID.
                            example: 123
                            type: integer
                          subject:
                            description: The email subject.
                            example: Hello
                            type: string
                          message:
                            description: The email message.
                            example: Some message
                            type: string
                          receiving_emails:
                            description: The list of receiving emails.
                            items:
                              example: example@example.com
                              type: string
                            maxItems: 1
                            minItems: 1
                            type: array
                        type: object
                      tag:
                        description: Action tag
                        example: cond_1.SendEmail.22222
                        type: string
                    type: object
                  maxItems: 10
                  type: array
                tag:
                  description: Condition tag
                  example: cond_1
                  type: string
                conditions:
                  description: The nested conditions array.
                  items:
                    properties:
                      type:
                        description: The condition type.
                        enum:
                        - if
                        - else
                        example: if
                        type: string
                      expression:
                        description: The expression array.
                        items:
                          properties:
                            parameter:
                              description: The parameter.
                              example: some_parameter
                              type: string
                            operator:
                              description: The operator.
                              example: ==
                              type: string
                            value:
                              description: The value.
                              example: some_value
                            joins_with:
                              description: The join condition.
                              example: '&&'
                              type: string
                          type: object
                        maxItems: 4
                        type: array
                      actions:
                        description: The actions array.
                        items:
                          properties:
                            name:
                              description: The action name.
                              enum:
                              - SendEmail
                              - ExportBackup
                              - ExportTroubleshoot
                              - ExportEventsLog
                              - Reboot
                              - TaskManagerAction
                              - SendNotification
                              example: SendEmail
                              type: string
                            options:
                              properties:
                                smtp_config_id:
                                  description: The SMTP configuration ID.
                                  example: 123
                                  type: integer
                                subject:
                                  description: The email subject.
                                  example: Hello
                                  type: string
                                message:
                                  description: The email message.
                                  example: Some message
                                  type: string
                                receiving_emails:
                                  description: The list of receiving emails.
                                  items:
                                    example: example@example.com
                                    type: string
                                  maxItems: 1
                                  minItems: 1
                                  type: array
                              type: object
                            tag:
                              description: Action tag
                              example: cond_2.SendEmail.11111
                              type: string
                          type: object
                        maxItems: 10
                        type: array
                      tag:
                        description: Condition tag
                        example: cond_2
                        type: string
                    type: object
                  maxItems: 2
                  type: array
              type: object
            maxItems: 2
            type: array
        type: object
      maxItems: 1
      type: array
    conditions_body_2:
      items:
        properties:
          type:
            description: The condition type.
            enum:
            - if
            example: if
            type: string
          expression:
            items:
              properties:
                parameter:
                  description: Condition parameter
                  example: temperature
                  type: string
                operator:
                  description: The operator.
                  example: ==
                  type: string
                value:
                  description: The value.
                  example: 10
                joins_with:
                  description: The join condition.
                  example: '&&'
                  type: string
              type: object
            maxItems: 4
            type: array
          actions:
            items:
              properties:
                name:
                  description: The action name.
                  enum:
                  - SendEmail
                  - ExportBackup
                  - ExportTroubleshoot
                  - ExportEventsLog
                  - Reboot
                  - TaskManagerAction
                  - SendNotification
                  example: SendEmail
                  type: string
                options:
                  oneOf:
                  - $ref: '#/components/schemas/send_email_action_options'
                  - $ref: '#/components/schemas/send_notification_action_options'
                  - $ref: '#/components/schemas/task_manager_action_options'
              type: object
            maxItems: 10
            type: array
          conditions:
            items:
              properties:
                type:
                  description: The condition type.
                  enum:
                  - if
                  - else
                  example: if
                  type: string
                expression:
                  description: The expression array.
                  items:
                    properties:
                      parameter:
                        description: Condition parameter.
                        example: temperature
                        type: string
                      operator:
                        description: The operator.
                        example: ==
                        type: string
                      value:
                        description: The value.
                        example: some_value
                      joins_with:
                        description: The join condition.
                        example: '&&'
                        type: string
                    type: object
                  maxItems: 4
                  type: array
                actions:
                  description: The actions array.
                  items:
                    properties:
                      name:
                        description: The action name.
                        enum:
                        - SendEmail
                        - ExportBackup
                        - ExportTroubleshoot
                        - ExportEventsLog
                        - Reboot
                        - TaskManagerAction
                        - SendNotification
                        example: SendEmail
                        type: string
                      options:
                        oneOf:
                        - $ref: '#/components/schemas/send_email_action_options'
                        - $ref: '#/components/schemas/send_notification_action_options'
                        - $ref: '#/components/schemas/task_manager_action_options'
                    type: object
                  maxItems: 10
                  type: array
                conditions:
                  description: The nested conditions array.
                  items:
                    properties:
                      type:
                        description: The condition type.
                        enum:
                        - if
                        - else
                        example: if
                        type: string
                      expression:
                        description: The expression array.
                        items:
                          properties:
                            parameter:
                              description: The parameter.
                              example: some_parameter
                              type: string
                            operator:
                              description: The operator.
                              example: ==
                              type: string
                            value:
                              description: The value.
                              example: some_value
                            joins_with:
                              description: The join condition.
                              example: '&&'
                              type: string
                          type: object
                        maxItems: 4
                        type: array
                      actions:
                        description: The actions array.
                        items:
                          properties:
                            name:
                              description: The action name.
                              enum:
                              - SendEmail
                              - ExportBackup
                              - ExportTroubleshoot
                              - ExportEventsLog
                              - Reboot
                              - TaskManagerAction
                              - SendNotification
                              example: SendEmail
                              type: string
                            options:
                              oneOf:
                              - $ref: '#/components/schemas/send_email_action_options'
                              - $ref: '#/components/schemas/send_notification_action_options'
                              - $ref: '#/components/schemas/task_manager_action_options'
                          type: object
                        maxItems: 10
                        type: array
                    type: object
                  maxItems: 2
                  type: array
              type: object
            maxItems: 2
            type: array
        type: object
      maxItems: 1
      type: array
    send_email_action_options:
      properties:
        smtp_config_id:
          description: The SMTP configuration ID.
          example: 123
          type: integer
        subject:
          description: The email subject.
          example: Hello
          type: string
        message:
          description: The email message.
          example: Some message
          type: string
        receiving_emails:
          description: The list of receiving emails.
          items:
            example: example@example.com
            type: string
          maxItems: 1
          minItems: 1
          type: array
      required:
      - message
      - receiving_emails
      - subject
      type: object
    send_notification_action_options:
      properties:
        message:
          description: The email message.
          example: Some message
          type: string
        receiving_users:
          description: The list of receiving emails.
          items:
            example: example@example.com
            type: string
          maxItems: 1
          minItems: 1
          type: array
      required:
      - message
      - receiving_users
      type: object
    task_manager_action_options:
      properties:
        task_group_id:
          description: The email message.
          example: Some message
          type: string
      required:
      - task_group_id
      type: object
    inline_response_200_data:
      example:
        parent_name: Parent
        users_count: 2
        devices_count: 7
        credits_left: 100
        level: 1
        parent_id: 5012
        name: Company
        created_at: 1995-06-08 04:20:07
        can_use_parent_license: 0
        id: 6963
        remaining_data: 6
      properties:
        id:
          description: Company id
          example: 6963
          type: integer
        name:
          description: Name of company
          example: Company
          type: string
        level:
          description: Company hierarchy level.
          example: 1
          type: integer
        parent_id:
          description: Company's parent company id.
          example: 5012
          type: integer
        parent_name:
          description: Company's parent company name.
          example: Parent
          type: string
        users_count:
          description: Count of users that belong to this company.
          example: 2
          type: integer
        devices_count:
          description: Number of devices that company has.
          example: 7
          type: integer
        credits_left:
          description: Number of credits that company still owns.
          example: 100
          type: integer
        can_use_parent_license:
          description: Allow parent companies use parent credits.
          type: integer
        remaining_data:
          description: Remaining company data in bytes.
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200:
      example:
        data:
        - parent_name: Parent
          users_count: 2
          devices_count: 7
          credits_left: 100
          level: 1
          parent_id: 5012
          name: Company
          created_at: 1995-06-08 04:20:07
          can_use_parent_license: 0
          id: 6963
          remaining_data: 6
        - parent_name: Parent
          users_count: 2
          devices_count: 7
          credits_left: 100
          level: 1
          parent_id: 5012
          name: Company
          created_at: 1995-06-08 04:20:07
          can_use_parent_license: 0
          id: 6963
          remaining_data: 6
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_401_errors:
      properties:
        code:
          description: Constant code that indicates specific information about error.
          example: SOME_ERROR_CODE
          type: string
        source:
          description: Source of error.
          nullable: true
          type: string
        message:
          description: Response message.
          example: Unauthorized.
          type: string
    inline_response_401:
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: false
          type: boolean
        errors:
          items:
            $ref: '#/components/schemas/inline_response_401_errors'
          type: array
    inline_response_201:
      example:
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
    inline_response_422_errors:
      properties:
        code:
          description: Constant code that indicates specific information about error.
          example: SOME_ERROR_CODE
          type: string
        source:
          description: Error source.
          example: email
          nullable: true
          type: string
        message:
          description: Default error message.
          example: Invalid email
          type: string
    inline_response_422:
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: false
          type: boolean
        errors:
          description: Lists and describes all parameters errors.
          items:
            $ref: '#/components/schemas/inline_response_422_errors'
          type: array
    inline_response_400_errors:
      properties:
        code:
          description: Constant code that indicates specific information about error.
          example: SOME_ERROR_CODE
          type: string
        source:
          description: Source of error.
          nullable: true
          type: string
        message:
          description: Response message.
          example: Bad request.
          type: string
    inline_response_400:
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: false
          type: boolean
        errors:
          items:
            $ref: '#/components/schemas/inline_response_400_errors'
          type: array
    inline_response_200_1_data:
      example:
        parent_name: Parent
        users_count: 2
        devices_count: 7
        credits_left: 100
        level: 2
        parent_id: 5012
        name: Company
        created_at: 1995-06-08 04:20:07
        id: 6963
      properties:
        id:
          description: Company id
          example: 6963
          type: integer
        name:
          description: Name of company
          example: Company
          type: string
        level:
          description: Company hierarchy level.
          example: 2
          type: integer
        parent_id:
          description: Company's parent company id.
          example: 5012
          type: integer
        parent_name:
          description: Company's parent company name.
          example: Parent
          type: string
        users_count:
          description: Count of users that belong to this company.
          example: 2
          type: integer
        devices_count:
          description: Number of devices that company has.
          example: 7
          type: integer
        credits_left:
          description: Number of credits that company still owns.
          example: 100
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_1:
      example:
        data:
          parent_name: Parent
          users_count: 2
          devices_count: 7
          credits_left: 100
          level: 2
          parent_id: 5012
          name: Company
          created_at: 1995-06-08 04:20:07
          id: 6963
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_1_data'
    inline_response_403_errors:
      properties:
        code:
          description: Constant code that indicates specific information about error.
          example: SOME_ERROR_CODE
          type: string
        source:
          description: Source of error.
          nullable: true
          type: string
        message:
          description: Response message.
          example: Forbidden.
          type: string
    inline_response_403:
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: false
          type: boolean
        errors:
          items:
            $ref: '#/components/schemas/inline_response_403_errors'
          type: array
    inline_response_200_2_meta:
      example:
        channel: private-status.1.6AY8tkkgOAu2AFaoNtUeBhykaJIcTx8y6AY8tkkgOAu2AFaoNtUeBhykaJIcTx8y
      properties:
        channel:
          description: Status channel id.
          example: private-status.1.6AY8tkkgOAu2AFaoNtUeBhykaJIcTx8y6AY8tkkgOAu2AFaoNtUeBhykaJIcTx8y
          type: string
    inline_response_200_2:
      example:
        success: true
        meta:
          channel: private-status.1.6AY8tkkgOAu2AFaoNtUeBhykaJIcTx8y6AY8tkkgOAu2AFaoNtUeBhykaJIcTx8y
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        meta:
          $ref: '#/components/schemas/inline_response_200_2_meta'
    inline_response_200_3_company:
      description: User's company.
      example:
        level: 6
        parent_id: 0
        name: Company
        id: 1
      properties:
        id:
          description: Company id.
          example: 1
          type: integer
        name:
          description: Company name.
          example: Company
          nullable: true
          type: string
        parent_id:
          description: Parent company id.
          type: integer
        level:
          type: integer
    inline_response_200_3_role:
      description: User's role.
      example:
        name: admin
        id: 1
        title: title
      properties:
        id:
          description: Role id.
          example: 1
          type: integer
        name:
          description: Role name.
          example: admin
          nullable: true
          type: string
        title:
          description: Role title.
          type: string
    inline_response_200_3_token:
      description: Token used to authenticate user.
      example:
        sub: "1"
        first_party: true
        nbf: 1600059843
        iss: rms_auth_server
        exp: 1603213443
        iat: 1600059843
        jti: ce10b915d25618176f1d8d5d6b5f4055cfd13743cb46da8b7f50996fd8d7df694af3e30c3e3dc313
        client_id: 94f9f6ba-c41d-12ea-b3de-0142ac130214
      properties:
        jti:
          description: Token id.
          example: ce10b915d25618176f1d8d5d6b5f4055cfd13743cb46da8b7f50996fd8d7df694af3e30c3e3dc313
          type: string
        iss:
          description: Token issuer.
          example: rms_auth_server
          type: string
        iat:
          description: When token was issued at. Unix timestamp.
          example: 1600059843
          type: integer
        nbf:
          description: To use token not before given unix timestamp.
          example: 1600059843
          type: integer
        exp:
          description: Unix timestamp of when token will expire.
          example: 1603213443
          type: integer
        sub:
          description: Token's subject. Subject is user and therefore in ths claim
            user id is being hold.
          example: "1"
          type: string
        client_id:
          description: Id (uuid) of client that issued token.
          example: 94f9f6ba-c41d-12ea-b3de-0142ac130214
          type: string
        first_party:
          type: boolean
    inline_response_200_3:
      example:
        mfa_type: email
        last_login_at: 2020-09-14 05:04:03
        email_verified: true
        role:
          name: admin
          id: 1
          title: title
        avatar_path: avatars/2_1599042044.png
        last_name: Doe
        token:
          sub: "1"
          first_party: true
          nbf: 1600059843
          iss: rms_auth_server
          exp: 1603213443
          iat: 1600059843
          jti: ce10b915d25618176f1d8d5d6b5f4055cfd13743cb46da8b7f50996fd8d7df694af3e30c3e3dc313
          client_id: 94f9f6ba-c41d-12ea-b3de-0142ac130214
        success: true
        terms_conditions: true
        permissions:
        - view_devices
        - view_devices
        scope:
        - devices:read
        - devices:read
        company:
          level: 6
          parent_id: 0
          name: Company
          id: 1
        id: 1
        first_name: Jon
        email: jhon.doe@mail.com
        username: jhon.doe
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        id:
          description: User's id.
          example: 1
          type: integer
        first_name:
          description: User's first name.
          example: Jon
          nullable: true
          type: string
        last_name:
          description: User's last name.
          example: Doe
          nullable: true
          type: string
        avatar_path:
          description: User's avatar path.
          example: avatars/2_1599042044.png
          nullable: true
          type: string
        username:
          description: User's username.
          example: jhon.doe
          nullable: true
          type: string
        email:
          description: User's email.
          example: jhon.doe@mail.com
          type: string
        mfa_type:
          description: User's multi factor authentication type. If null mfa is not
            enabled.
          enum:
          - email
          - teltonika_id
          - totp
          nullable: true
          type: string
        terms_conditions:
          description: Have user accepted to terms and conditions.
          example: true
          type: boolean
        last_login_at:
          description: User's last login timestamp.
          example: 2020-09-14 05:04:03
          type: string
        email_verified:
          description: Have user verified his/hers email.
          example: true
          type: boolean
        company:
          $ref: '#/components/schemas/inline_response_200_3_company'
        role:
          $ref: '#/components/schemas/inline_response_200_3_role'
        token:
          $ref: '#/components/schemas/inline_response_200_3_token'
        scope:
          description: List of scopes that are given by authorization server.
          items:
            description: A scope.
            example: devices:read
            type: string
          type: array
        permissions:
          description: List of permissions that user have.
          items:
            description: A permission.
            example: view_devices
            type: string
          type: array
    inline_response_200_4_data:
      example:
        role: 2
        company_id: 7117
        updated_at: 2020-02-20 09:10:59
        company_name: THE_COMPANY
        created_at: 1995-06-08 04:20:07
        id: 257
        email: some-mail@mail.com
        username: usr257
      properties:
        id:
          description: User id.
          example: 257
          type: integer
        username:
          description: Username.
          example: usr257
          type: string
        email:
          description: User's email.
          example: some-mail@mail.com
          format: email
          type: string
        role:
          description: User's role.
          example: 2
          type: integer
        company_id:
          description: User's company id.
          example: 7117
          type: integer
        company_name:
          description: User's company name.
          example: THE_COMPANY
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_4_meta:
      example:
        _total: 451
      properties:
        _total:
          description: Total number of entries found.
          example: 451
          type: integer
    inline_response_200_4:
      example:
        data:
        - role: 2
          company_id: 7117
          updated_at: 2020-02-20 09:10:59
          company_name: THE_COMPANY
          created_at: 1995-06-08 04:20:07
          id: 257
          email: some-mail@mail.com
          username: usr257
        - role: 2
          company_id: 7117
          updated_at: 2020-02-20 09:10:59
          company_name: THE_COMPANY
          created_at: 1995-06-08 04:20:07
          id: 257
          email: some-mail@mail.com
          username: usr257
        success: true
        meta:
          _total: 451
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_4_data'
          type: array
        meta:
          $ref: '#/components/schemas/inline_response_200_4_meta'
    inline_response_200_5_data:
      example:
        company_level: 0
        company_parent_id: 6
        role: Admin
        company_id: 7117
        updated_at: 2020-02-20 09:10:59
        role_id: 2
        company_name: THE_COMPANY
        created_at: 1995-06-08 04:20:07
        id: 257
        email: some-mail@mail.com
        username: usr257
      properties:
        id:
          description: User id.
          example: 257
          type: integer
        username:
          description: Username.
          example: usr257
          type: string
        email:
          description: User's email.
          example: some-mail@mail.com
          format: email
          type: string
        role_id:
          description: User's role id.
          example: 2
          type: integer
        role:
          description: User's role.
          example: Admin
          type: string
        company_id:
          description: User's company id.
          example: 7117
          type: integer
        company_name:
          description: User's company name.
          example: THE_COMPANY
          type: string
        company_level:
          description: Company level in hierarchy.
          type: integer
        company_parent_id:
          description: ID of parent company.
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_5:
      example:
        data:
          company_level: 0
          company_parent_id: 6
          role: Admin
          company_id: 7117
          updated_at: 2020-02-20 09:10:59
          role_id: 2
          company_name: THE_COMPANY
          created_at: 1995-06-08 04:20:07
          id: 257
          email: some-mail@mail.com
          username: usr257
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_5_data'
    inline_response_404_errors:
      properties:
        code:
          description: Constant code that indicates specific information about error.
          example: SOME_ERROR_CODE
          type: string
        source:
          description: Source of error.
          nullable: true
          type: string
        message:
          description: Response message.
          example: Not found.
          type: string
    inline_response_404:
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: false
          type: boolean
        errors:
          items:
            $ref: '#/components/schemas/inline_response_404_errors'
          type: array
    inline_response_200_6_data:
      example:
        role: end_user
        company_id: 7117
        role_id: 2
        bounce_status: bounce_status
        company_name: THE_COMPANY
        created_at: 1995-06-08 04:20:07
        role_title: role_title
        id: 257
        email: some-mail@mail.com
      properties:
        id:
          description: User invite id.
          example: 257
          type: integer
        email:
          description: Invited user's email.
          example: some-mail@mail.com
          format: email
          type: string
        role_id:
          description: Role id that user will get after sign up with invite.
          example: 2
          type: integer
        role:
          description: Role (name) that user will get after sign up with invite.
          example: end_user
          type: string
        role_title:
          description: User role title.
          type: string
        bounce_status:
          description: Email delivery error message.
          type: string
        company_id:
          description: Id of company that user was invited to.
          example: 7117
          type: integer
        company_name:
          description: Name of company that user was invited to.
          example: THE_COMPANY
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_6:
      example:
        data:
        - role: end_user
          company_id: 7117
          role_id: 2
          bounce_status: bounce_status
          company_name: THE_COMPANY
          created_at: 1995-06-08 04:20:07
          role_title: role_title
          id: 257
          email: some-mail@mail.com
        - role: end_user
          company_id: 7117
          role_id: 2
          bounce_status: bounce_status
          company_name: THE_COMPANY
          created_at: 1995-06-08 04:20:07
          role_title: role_title
          id: 257
          email: some-mail@mail.com
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_6_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_7_actions:
      example:
        tag_id: 1
        action: firmware_upload
        created_at: 2024-11-07 13:34:35
        source_id: 1
        source_name: RUT30X_R_00.07.00_WEBUI.bin
      properties:
        tag_id:
          description: ID of tag.
          example: 1
          type: integer
        action:
          description: Name of action assigned to tag.
          example: firmware_upload
          type: string
        source_id:
          description: ID of item used in tag action.
          example: 1
          type: integer
        source_name:
          description: Name of item used in tag action. E.g firmware name or Task
            name.
          example: RUT30X_R_00.07.00_WEBUI.bin
          type: string
        created_at:
          description: Tag action creation date.
          example: 2024-11-07 13:34:35
          type: string
    inline_response_200_7_data:
      example:
        devices_count: 7
        company_id: 5012
        color: '#4287f5'
        updated_at: 2020-02-20 09:10:59
        company_name: Company
        name: Tag1
        description: Good tag, 9/10 dentists would recommend.
        created_at: 1995-06-08 04:20:07
        id: 6963
        actions:
        - tag_id: 1
          action: firmware_upload
          created_at: 2024-11-07 13:34:35
          source_id: 1
          source_name: RUT30X_R_00.07.00_WEBUI.bin
        - tag_id: 1
          action: firmware_upload
          created_at: 2024-11-07 13:34:35
          source_id: 1
          source_name: RUT30X_R_00.07.00_WEBUI.bin
        - tag_id: 1
          action: firmware_upload
          created_at: 2024-11-07 13:34:35
          source_id: 1
          source_name: RUT30X_R_00.07.00_WEBUI.bin
        - tag_id: 1
          action: firmware_upload
          created_at: 2024-11-07 13:34:35
          source_id: 1
          source_name: RUT30X_R_00.07.00_WEBUI.bin
      properties:
        id:
          description: Tag id.
          example: 6963
          type: integer
        company_id:
          description: Name of company that tag belongs to.
          example: 5012
          type: integer
        company_name:
          description: Name of company.
          example: Company
          type: string
        name:
          description: Tag name.
          example: Tag1
          type: string
        description:
          description: Tag description.
          example: Good tag, 9/10 dentists would recommend.
          type: string
        devices_count:
          description: Number of devices that tag has.
          example: 7
          type: integer
        color:
          description: Color of tag in HEX format.
          example: '#4287f5'
          maxLength: 7
          type: string
        actions:
          items:
            $ref: '#/components/schemas/inline_response_200_7_actions'
          maxItems: 4
          type: array
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_7:
      example:
        data:
        - devices_count: 7
          company_id: 5012
          color: '#4287f5'
          updated_at: 2020-02-20 09:10:59
          company_name: Company
          name: Tag1
          description: Good tag, 9/10 dentists would recommend.
          created_at: 1995-06-08 04:20:07
          id: 6963
          actions:
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
        - devices_count: 7
          company_id: 5012
          color: '#4287f5'
          updated_at: 2020-02-20 09:10:59
          company_name: Company
          name: Tag1
          description: Good tag, 9/10 dentists would recommend.
          created_at: 1995-06-08 04:20:07
          id: 6963
          actions:
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
          - tag_id: 1
            action: firmware_upload
            created_at: 2024-11-07 13:34:35
            source_id: 1
            source_name: RUT30X_R_00.07.00_WEBUI.bin
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Wrapped array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_7_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_409_errors:
      properties:
        code:
          description: Constant code that indicates specific information about error.
          example: SOME_ERROR_CODE
          type: string
        source:
          description: Source of error.
          nullable: true
          type: string
        message:
          description: Response message.
          example: Already in use.
          type: string
    inline_response_409:
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: false
          type: boolean
        errors:
          items:
            $ref: '#/components/schemas/inline_response_409_errors'
          type: array
    inline_response_200_8_data:
      description: Tag data.
      example:
        color: '#4287f5'
        updated_at: 2020-02-20 09:10:59
        name: Tag1
        description: Good tag, 9/10 dentists would recommend.
        created_at: 1995-06-08 04:20:07
        id: 6963
      properties:
        id:
          description: Tag id.
          example: 6963
          type: integer
        name:
          description: Tag name.
          example: Tag1
          type: string
        description:
          description: Tag description.
          example: Good tag, 9/10 dentists would recommend.
          type: string
        color:
          description: Color of tag in HEX format.
          example: '#4287f5'
          maxLength: 7
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_8:
      example:
        data:
          color: '#4287f5'
          updated_at: 2020-02-20 09:10:59
          name: Tag1
          description: Good tag, 9/10 dentists would recommend.
          created_at: 1995-06-08 04:20:07
          id: 6963
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_8_data'
    inline_response_200_9:
      example:
        data:
        - static_monitoring: 0
          io_monitoring: 60
          oc_output_cfg: oc_output_cfg
          accuracy: 6
          ecio_2: ecio_2
          rsrp: 2.027123
          modem_manufacturer_2: Quectel
          user_set_longitude: 14.269965
          monitoring_enabled: 1
          iccid_2: "11111111111111111111"
          operator_2: operator_2
          mqtt: 1
          analog_input: analog_input
          auto_extend_credit: 1
          model: RUT950
          id: 70810
          cell_tower_longitude: 14.269965
          rsrp_2: 4.145608
          management_credit_type: management_5y
          mnc_2: "146"
          imei_2: "111111111111111"
          received: 9
          cell_tower_latitude: 48.790625
          received_2: 3
          mcc_2: "246"
          tags:
          - company_id: 430
            color: '#4287f5'
            updated_at: 2020-02-20 09:10:59
            user_id: 4
            name: The tag
            description: Good tag
            created_at: 1995-06-08 04:20:07
            id: 11
            actions:
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
          - company_id: 430
            color: '#4287f5'
            updated_at: 2020-02-20 09:10:59
            user_id: 4
            name: The tag
            description: Good tag
            created_at: 1995-06-08 04:20:07
            id: 11
            actions:
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
          operator_number_2: "24602"
          analog_current_loop: analog_current_loop
          temperature_2: 360
          ddns_monitoring: 60
          company_name: Company
          bootloader_version: 3.0.1
          modem_manufacturer: Quectel
          cell_tower_latitude_2: 48.790625
          is_authenticated: 0
          mobile_ip_2: 0.0.0.0
          relay_output_2: 4
          relay_output_cfg: relay_output_cfg
          status: 1
          relay_output: relay_output
          fix_status: 3
          gps_time: 6
          batch_number: "0054"
          latitude: 48.790625
          created_at: 1995-06-08 04:20:07
          pin_state_2: READY
          sent_2: 7
          imsi: "246020102200857"
          product_code: RUT955H7VXXX
          mac: 00:00:00:00:00:00
          failed_auth_reason: 6
          updated_at: 2020-02-20 09:10:59
          vpn_monitoring: 0
          temperature: 360
          digital_input: 6
          credit_expire_date: 2000-01-23T04:56:07.000+00:00
          course: 2.8841621266687802
          sim_slot_2: 1
          rscp: rscp
          digital_isolated_input: 7
          firmware: RUT9XX_R_00.06.05.3
          network_state_2: Home
          modem_firmware: EC25EFAR02A08M4G
          sim_slot: 1
          user_set_latitude: 48.790625
          gps_monitoring: 300
          company_id: 7034
          connection_type: LTE
          cell_tower_longitude_2: 14.269965
          dry_wet_input1: 8
          ecio: ecio
          dry_wet_input0: 6
          dynamic_monitoring: 300
          activation_status: "11111"
          modem_model_2: EC25
          rsrq: 1.0246457
          router_uptime: 3060
          cell_tower_accuracy_2: 14.269965
          pin_state: READY
          is_facelift: 0
          data_credit_type_name: Free Connection Data pack 150GB 10y.
          mcc: "246"
          operator: operator
          lac: "146"
          iccid: "11111111111111111111"
          original_model: RUT950
          hotspot_monitoring: 300
          management_credit_type_name: Paid Management pack 5y.
          connection_state_2: connected
          signal: 5
          cell_id: "1037079"
          longitude: 14.269965
          satellites: 6
          rscp_2: rscp_2
          sent: 2
          sinr: 7.386282
          modem_firmware_2: EC25EFAR02A08M4G
          data_credit_type: data_150GB_10y
          wireless_monitoring: 60
          credit_enabled: 1
          credit_activated: 1
          last_update_at: 2000-01-23T04:56:07.000+00:00
          name: RUT Device 1
          connection_type_2: LTE
          network_state: Home
          digital_open_collector_output_4pin: 6
          wan_state: Mobile
          altitude: 10.542345
          description: s/n 0000000000, added at 2020-01-01
          connection_state: connected
          speed: 1.284659006116532
          data_credit_type_id: 6
          signal_2: 5
          imsi_2: "246020102200857"
          hardware_revision: "1307"
          connection_uptime_2: 3012
          mobile_ip: 0.0.0.0
          cell_tower_accuracy: 14.269965
          last_connection_at: 2000-01-23T04:56:07.000+00:00
          lac_2: "146"
          ddns_rules_count: 3
          wlan_mac: 00:00:00:00:00:00
          rsrq_2: 1.4894159
          mnc: "146"
          sim_state_2: inserted
          operator_number: "24602"
          connection_uptime: 3012
          digital_inout2: 9
          remaining_data: 1
          cell_id_2: "1037079"
          sim_state: inserted
          management_credit_type_id: 2
          digital_inout0: 5
          serial: "0000000000"
          sinr_2: 1.2315135
          modem_model: EC25
          digital_inout1: 9
          vpn_monitoring_instances_state: 1
          wan_ip: 0.0.0.0
          imei: "111111111111111"
          digital_non_isolated_input_4pin: 9
          open_collector_output: 1
        - static_monitoring: 0
          io_monitoring: 60
          oc_output_cfg: oc_output_cfg
          accuracy: 6
          ecio_2: ecio_2
          rsrp: 2.027123
          modem_manufacturer_2: Quectel
          user_set_longitude: 14.269965
          monitoring_enabled: 1
          iccid_2: "11111111111111111111"
          operator_2: operator_2
          mqtt: 1
          analog_input: analog_input
          auto_extend_credit: 1
          model: RUT950
          id: 70810
          cell_tower_longitude: 14.269965
          rsrp_2: 4.145608
          management_credit_type: management_5y
          mnc_2: "146"
          imei_2: "111111111111111"
          received: 9
          cell_tower_latitude: 48.790625
          received_2: 3
          mcc_2: "246"
          tags:
          - company_id: 430
            color: '#4287f5'
            updated_at: 2020-02-20 09:10:59
            user_id: 4
            name: The tag
            description: Good tag
            created_at: 1995-06-08 04:20:07
            id: 11
            actions:
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
          - company_id: 430
            color: '#4287f5'
            updated_at: 2020-02-20 09:10:59
            user_id: 4
            name: The tag
            description: Good tag
            created_at: 1995-06-08 04:20:07
            id: 11
            actions:
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
          operator_number_2: "24602"
          analog_current_loop: analog_current_loop
          temperature_2: 360
          ddns_monitoring: 60
          company_name: Company
          bootloader_version: 3.0.1
          modem_manufacturer: Quectel
          cell_tower_latitude_2: 48.790625
          is_authenticated: 0
          mobile_ip_2: 0.0.0.0
          relay_output_2: 4
          relay_output_cfg: relay_output_cfg
          status: 1
          relay_output: relay_output
          fix_status: 3
          gps_time: 6
          batch_number: "0054"
          latitude: 48.790625
          created_at: 1995-06-08 04:20:07
          pin_state_2: READY
          sent_2: 7
          imsi: "246020102200857"
          product_code: RUT955H7VXXX
          mac: 00:00:00:00:00:00
          failed_auth_reason: 6
          updated_at: 2020-02-20 09:10:59
          vpn_monitoring: 0
          temperature: 360
          digital_input: 6
          credit_expire_date: 2000-01-23T04:56:07.000+00:00
          course: 2.8841621266687802
          sim_slot_2: 1
          rscp: rscp
          digital_isolated_input: 7
          firmware: RUT9XX_R_00.06.05.3
          network_state_2: Home
          modem_firmware: EC25EFAR02A08M4G
          sim_slot: 1
          user_set_latitude: 48.790625
          gps_monitoring: 300
          company_id: 7034
          connection_type: LTE
          cell_tower_longitude_2: 14.269965
          dry_wet_input1: 8
          ecio: ecio
          dry_wet_input0: 6
          dynamic_monitoring: 300
          activation_status: "11111"
          modem_model_2: EC25
          rsrq: 1.0246457
          router_uptime: 3060
          cell_tower_accuracy_2: 14.269965
          pin_state: READY
          is_facelift: 0
          data_credit_type_name: Free Connection Data pack 150GB 10y.
          mcc: "246"
          operator: operator
          lac: "146"
          iccid: "11111111111111111111"
          original_model: RUT950
          hotspot_monitoring: 300
          management_credit_type_name: Paid Management pack 5y.
          connection_state_2: connected
          signal: 5
          cell_id: "1037079"
          longitude: 14.269965
          satellites: 6
          rscp_2: rscp_2
          sent: 2
          sinr: 7.386282
          modem_firmware_2: EC25EFAR02A08M4G
          data_credit_type: data_150GB_10y
          wireless_monitoring: 60
          credit_enabled: 1
          credit_activated: 1
          last_update_at: 2000-01-23T04:56:07.000+00:00
          name: RUT Device 1
          connection_type_2: LTE
          network_state: Home
          digital_open_collector_output_4pin: 6
          wan_state: Mobile
          altitude: 10.542345
          description: s/n 0000000000, added at 2020-01-01
          connection_state: connected
          speed: 1.284659006116532
          data_credit_type_id: 6
          signal_2: 5
          imsi_2: "246020102200857"
          hardware_revision: "1307"
          connection_uptime_2: 3012
          mobile_ip: 0.0.0.0
          cell_tower_accuracy: 14.269965
          last_connection_at: 2000-01-23T04:56:07.000+00:00
          lac_2: "146"
          ddns_rules_count: 3
          wlan_mac: 00:00:00:00:00:00
          rsrq_2: 1.4894159
          mnc: "146"
          sim_state_2: inserted
          operator_number: "24602"
          connection_uptime: 3012
          digital_inout2: 9
          remaining_data: 1
          cell_id_2: "1037079"
          sim_state: inserted
          management_credit_type_id: 2
          digital_inout0: 5
          serial: "0000000000"
          sinr_2: 1.2315135
          modem_model: EC25
          digital_inout1: 9
          vpn_monitoring_instances_state: 1
          wan_ip: 0.0.0.0
          imei: "111111111111111"
          digital_non_isolated_input_4pin: 9
          open_collector_output: 1
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/device_body'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_10:
      example:
        data:
          static_monitoring: 0
          io_monitoring: 60
          oc_output_cfg: oc_output_cfg
          accuracy: 6
          ecio_2: ecio_2
          rsrp: 2.027123
          modem_manufacturer_2: Quectel
          user_set_longitude: 14.269965
          monitoring_enabled: 1
          iccid_2: "11111111111111111111"
          operator_2: operator_2
          mqtt: 1
          analog_input: analog_input
          auto_extend_credit: 1
          model: RUT950
          id: 70810
          cell_tower_longitude: 14.269965
          rsrp_2: 4.145608
          management_credit_type: management_5y
          mnc_2: "146"
          imei_2: "111111111111111"
          received: 9
          cell_tower_latitude: 48.790625
          received_2: 3
          mcc_2: "246"
          tags:
          - company_id: 430
            color: '#4287f5'
            updated_at: 2020-02-20 09:10:59
            user_id: 4
            name: The tag
            description: Good tag
            created_at: 1995-06-08 04:20:07
            id: 11
            actions:
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
          - company_id: 430
            color: '#4287f5'
            updated_at: 2020-02-20 09:10:59
            user_id: 4
            name: The tag
            description: Good tag
            created_at: 1995-06-08 04:20:07
            id: 11
            actions:
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
            - tag_id: 1
              action: firmware_upload
              created_at: 2024-11-07 13:34:35
              source_id: 1
              source_name: RUT30X_R_00.07.00_WEBUI.bin
          operator_number_2: "24602"
          analog_current_loop: analog_current_loop
          temperature_2: 360
          ddns_monitoring: 60
          company_name: Company
          bootloader_version: 3.0.1
          modem_manufacturer: Quectel
          cell_tower_latitude_2: 48.790625
          is_authenticated: 0
          mobile_ip_2: 0.0.0.0
          relay_output_2: 4
          relay_output_cfg: relay_output_cfg
          status: 1
          relay_output: relay_output
          fix_status: 3
          gps_time: 6
          batch_number: "0054"
          latitude: 48.790625
          created_at: 1995-06-08 04:20:07
          pin_state_2: READY
          sent_2: 7
          imsi: "246020102200857"
          product_code: RUT955H7VXXX
          mac: 00:00:00:00:00:00
          failed_auth_reason: 6
          updated_at: 2020-02-20 09:10:59
          vpn_monitoring: 0
          temperature: 360
          digital_input: 6
          credit_expire_date: 2000-01-23T04:56:07.000+00:00
          course: 2.8841621266687802
          sim_slot_2: 1
          rscp: rscp
          digital_isolated_input: 7
          firmware: RUT9XX_R_00.06.05.3
          network_state_2: Home
          modem_firmware: EC25EFAR02A08M4G
          sim_slot: 1
          user_set_latitude: 48.790625
          gps_monitoring: 300
          company_id: 7034
          connection_type: LTE
          cell_tower_longitude_2: 14.269965
          dry_wet_input1: 8
          ecio: ecio
          dry_wet_input0: 6
          dynamic_monitoring: 300
          activation_status: "11111"
          modem_model_2: EC25
          rsrq: 1.0246457
          router_uptime: 3060
          cell_tower_accuracy_2: 14.269965
          pin_state: READY
          is_facelift: 0
          data_credit_type_name: Free Connection Data pack 150GB 10y.
          mcc: "246"
          operator: operator
          lac: "146"
          iccid: "11111111111111111111"
          original_model: RUT950
          hotspot_monitoring: 300
          management_credit_type_name: Paid Management pack 5y.
          connection_state_2: connected
          signal: 5
          cell_id: "1037079"
          longitude: 14.269965
          satellites: 6
          rscp_2: rscp_2
          sent: 2
          sinr: 7.386282
          modem_firmware_2: EC25EFAR02A08M4G
          data_credit_type: data_150GB_10y
          wireless_monitoring: 60
          credit_enabled: 1
          credit_activated: 1
          last_update_at: 2000-01-23T04:56:07.000+00:00
          name: RUT Device 1
          connection_type_2: LTE
          network_state: Home
          digital_open_collector_output_4pin: 6
          wan_state: Mobile
          altitude: 10.542345
          description: s/n 0000000000, added at 2020-01-01
          connection_state: connected
          speed: 1.284659006116532
          data_credit_type_id: 6
          signal_2: 5
          imsi_2: "246020102200857"
          hardware_revision: "1307"
          connection_uptime_2: 3012
          mobile_ip: 0.0.0.0
          cell_tower_accuracy: 14.269965
          last_connection_at: 2000-01-23T04:56:07.000+00:00
          lac_2: "146"
          ddns_rules_count: 3
          wlan_mac: 00:00:00:00:00:00
          rsrq_2: 1.4894159
          mnc: "146"
          sim_state_2: inserted
          operator_number: "24602"
          connection_uptime: 3012
          digital_inout2: 9
          remaining_data: 1
          cell_id_2: "1037079"
          sim_state: inserted
          management_credit_type_id: 2
          digital_inout0: 5
          serial: "0000000000"
          sinr_2: 1.2315135
          modem_model: EC25
          digital_inout1: 9
          vpn_monitoring_instances_state: 1
          wan_ip: 0.0.0.0
          imei: "111111111111111"
          digital_non_isolated_input_4pin: 9
          open_collector_output: 1
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/device_body'
    inline_response_200_11_data_tags:
      example:
        company_id: 430
        updated_at: 2020-02-20 09:10:59
        user_id: 4
        name: The tag
        description: Good tag
        created_at: 1995-06-08 04:20:07
        id: 11
      properties:
        id:
          description: Tag id.
          example: 11
          type: integer
        name:
          description: Tag name.
          example: The tag
          type: string
        description:
          description: Tag description.
          example: Good tag
          type: string
        user_id:
          description: Tag creators id.
          example: 4
          type: integer
        company_id:
          description: Company's that id belongs to id.
          example: 430
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_11_data:
      example:
        static_monitoring: 0
        io_monitoring: 60
        pin_state: READY
        oc_output_cfg: oc_output_cfg
        accuracy: 4
        is_facelift: 0
        mcc: "246"
        lac: "146"
        iccid: "11111111111111111111"
        monitoring_enabled: 1
        hotspot_monitoring: 300
        mqtt: 1
        analog_input: analog_input
        auto_extend_credit: 1
        model: RUT
        id: 70810
        signal: 0
        cell_id: "1037079"
        longitude: 7.061401241503109
        satellites: 5
        credit_type: Free
        tags:
        - company_id: 430
          updated_at: 2020-02-20 09:10:59
          user_id: 4
          name: The tag
          description: Good tag
          created_at: 1995-06-08 04:20:07
          id: 11
        - company_id: 430
          updated_at: 2020-02-20 09:10:59
          user_id: 4
          name: The tag
          description: Good tag
          created_at: 1995-06-08 04:20:07
          id: 11
        wireless_monitoring: 60
        credit_enabled: 1
        credit_activated: 1
        company_name: Company
        bootloader_version: 3.0.1
        last_update_at: 2000-01-23T04:56:07.000+00:00
        name: RUT Device 1
        modem_manufacturer: Quectel
        is_authenticated: 1
        network_state: Home
        relay_output_cfg: relay_output_cfg
        status: true
        wan_state: Mobile
        relay_output: relay_output
        fix_status: 0
        gps_time: 2
        batch_number: "0054"
        latitude: 2.3021358869347655
        description: s/n 7841019896, added at 2020-02-13
        created_at: 1995-06-08 04:20:07
        imsi: "246020102200857"
        connection_state: connected
        product_code: RUT955H7VXXX
        mac: 00:00:00:00:00:00
        speed: 9.301444243932576
        hardware_revision: "1307"
        failed_auth_reason: 1
        mobile_ip: 10.20.133.143
        updated_at: 2020-02-20 09:10:59
        temperature: 360
        digital_input: 6
        last_connection_at: 2000-01-23T04:56:07.000+00:00
        credit_expire_date: 2000-01-23T04:56:07.000+00:00
        course: 3.616076749251911
        digital_isolated_input: 1
        firmware: RUT9XX_R_00.06.05.3
        modem_firmware: EC25EFAR02A08M4G
        wlan_mac: 00:00:00:00:00:00
        sim_slot: 1
        gps_monitoring: 300
        mnc: "146"
        company_id: 7034
        connection_type: LTE
        operator_number: "24602"
        connection_uptime: 3012
        sim_state: inserted
        dynamic_monitoring: 300
        activation_status: "11111"
        serial: "7841019896"
        modem_model: EC25
        router_uptime: 3060
        wan_ip: 10.20.133.143
        imei: "111111111111111"
        open_collector_output: 5
      properties:
        id:
          description: Id of a device.
          example: 70810
          type: integer
        company_id:
          description: Company id that device belongs to.
          example: 7034
          type: integer
        model:
          description: Device model.
          example: RUT
          type: string
        name:
          description: Name of device.
          example: RUT Device 1
          type: string
        description:
          description: Extra information for device.
          example: s/n 7841019896, added at 2020-02-13
          type: string
        serial:
          description: Device serial number.
          example: "7841019896"
          type: string
        mac:
          description: Device's mac.
          example: 00:00:00:00:00:00
          type: string
        wlan_mac:
          description: Device's wlan mac.
          example: 00:00:00:00:00:00
          type: string
        mqtt:
          description: Device's connection type. 0 - vpn. < 0 is mqtt version.
          example: 1
          type: integer
        dynamic_monitoring:
          description: Time interval in seconds that device's dynamic information
            is being monitored. (0 - disabled)
          example: 300
          type: integer
        static_monitoring:
          description: Time interval in seconds that device's static information is
            being monitored. (0 - disabled)
          example: 0
          type: integer
        io_monitoring:
          description: Time interval in seconds that device's I/O information is being
            monitored. (0 - disabled)
          example: 60
          type: integer
        gps_monitoring:
          description: Time interval in seconds that device's GPS information is being
            monitored. (0 - disabled)
          example: 300
          type: integer
        hotspot_monitoring:
          description: Time interval in seconds that device's hotspot information
            is being monitored. (0 - disabled)
          example: 300
          type: integer
        wireless_monitoring:
          description: Time interval in seconds that device's wireless information
            is being monitored. (0 - disabled)
          example: 60
          type: integer
        last_connection_at:
          description: Date at which device made last connection.
          format: date-time
          type: string
        activation_status:
          description: Device activation status.
          example: "11111"
          type: string
        is_facelift:
          description: IS device facelifted.
          enum:
          - 1
          - 0
          example: 0
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
        status:
          description: Device status. false - offline, true - online.
          example: true
          type: boolean
        is_authenticated:
          description: Device authentication status.
          example: 1
          type: integer
        failed_auth_reason:
          description: Device failed authentication reason.
          example: 1
          type: integer
        credit_enabled:
          description: Is service credit enabled for this device.
          enum:
          - 1
          - 0
          example: 1
          type: integer
        credit_activated:
          description: Is service credit activated for this device.
          enum:
          - 1
          - 0
          example: 1
          type: integer
        credit_expire_date:
          description: Date at which activated credit will expire.
          format: date-time
          type: string
        monitoring_enabled:
          description: Is monitoring for this device is enabled.
          enum:
          - 1
          - 0
          example: 1
          type: integer
        auto_extend_credit:
          description: Is service credit auto extend is enabled for this device.
          enum:
          - 1
          - 0
          example: 1
          type: integer
        company_name:
          description: Name of company that this device belongs to.
          example: Company
          type: string
        temperature:
          description: Device temperature. Temperature is in celsius.
          example: 360
          type: integer
        signal:
          description: Device signal strength.
          type: integer
        firmware:
          description: Device's current firmware.
          example: RUT9XX_R_00.06.05.3
          type: string
        bootloader_version:
          description: Version of device's bootloader.
          example: 3.0.1
          type: string
        cell_id:
          description: Operation tower id.
          example: "1037079"
          type: string
        connection_type:
          description: Mobile connection type.
          example: LTE
          type: string
        connection_state:
          description: Device's mobile connection state.
          example: connected
          type: string
        connection_uptime:
          description: Time in seconds for how long connection was established.
          example: 3012
          type: integer
        iccid:
          description: Integrated circuit card identifier.
          example: "11111111111111111111"
          type: string
        lac:
          description: Location area identity.
          example: "146"
          type: string
        mcc:
          description: Mobile country code.
          example: "246"
          type: string
        mnc:
          description: Mobile network codes.
          example: "146"
          type: string
        sim_slot:
          description: Sim card slot in which sim card is activated.
          example: 1
          type: integer
        sim_state:
          description: Sim card state.
          example: inserted
          type: string
        pin_state:
          description: Pin state.
          example: READY
          type: string
        operator_number:
          description: Sim card operator's number.
          example: "24602"
          type: string
        router_uptime:
          description: Router uptime in seconds.
          example: 3060
          type: integer
        wan_state:
          description: Wide area network state.
          example: Mobile
          type: string
        wan_ip:
          description: Wide area network ip.
          example: 10.20.133.143
          format: ipv4
          type: string
        mobile_ip:
          description: Mobile ip.
          example: 10.20.133.143
          format: ipv4
          type: string
        network_state:
          description: State of network.
          example: Home
          type: string
        imei:
          description: Device international mobile equipment identity number.
          example: "111111111111111"
          type: string
        batch_number:
          description: Device's batch number.
          example: "0054"
          type: string
        product_code:
          description: product_code
          example: RUT955H7VXXX
          type: string
        modem_manufacturer:
          description: Modem manufacturer.
          example: Quectel
          type: string
        modem_model:
          description: Model of modem.
          example: EC25
          type: string
        modem_firmware:
          description: Product code.
          example: EC25EFAR02A08M4G
          type: string
        hardware_revision:
          description: Hardware revision.
          example: "1307"
          type: string
        imsi:
          description: International mobile subscriber identity number.
          example: "246020102200857"
          type: string
        digital_input:
          description: Digital input.
          nullable: true
          type: integer
        digital_isolated_input:
          description: Digital isolated input.
          nullable: true
          type: integer
        analog_input:
          description: Analog input.
          nullable: true
          type: string
        open_collector_output:
          description: Open collector output.
          nullable: true
          type: integer
        relay_output:
          description: Relay output
          nullable: true
          type: string
        oc_output_cfg:
          description: Open collector output configurations.
          nullable: true
          type: string
        relay_output_cfg:
          description: Relay output configurations.
          nullable: true
          type: string
        fix_status:
          description: Fix status.
          example: 0
          nullable: true
          type: integer
        satellites:
          description: Number of satellites.
          nullable: true
          type: integer
        latitude:
          description: Device's location's latitude in Decimal degrees.
          nullable: true
          type: number
        longitude:
          description: Device's location's longitude in Decimal degrees.
          nullable: true
          type: number
        speed:
          description: Device speed.
          nullable: true
          type: number
        course:
          description: Device course.
          nullable: true
          type: number
        gps_time:
          description: Time in seconds for device gps uptime.
          nullable: true
          type: integer
        accuracy:
          description: Accuracy.
          nullable: true
          type: integer
        last_update_at:
          description: When was device last updated at.
          format: date-time
          type: string
        credit_type:
          description: What kind of credits is currently activated.
          enum:
          - Paid
          - Free
          example: Free
          type: string
        tags:
          description: Device's tags list.
          items:
            $ref: '#/components/schemas/inline_response_200_11_data_tags'
          type: array
    inline_response_200_11:
      example:
        data:
          static_monitoring: 0
          io_monitoring: 60
          pin_state: READY
          oc_output_cfg: oc_output_cfg
          accuracy: 4
          is_facelift: 0
          mcc: "246"
          lac: "146"
          iccid: "11111111111111111111"
          monitoring_enabled: 1
          hotspot_monitoring: 300
          mqtt: 1
          analog_input: analog_input
          auto_extend_credit: 1
          model: RUT
          id: 70810
          signal: 0
          cell_id: "1037079"
          longitude: 7.061401241503109
          satellites: 5
          credit_type: Free
          tags:
          - company_id: 430
            updated_at: 2020-02-20 09:10:59
            user_id: 4
            name: The tag
            description: Good tag
            created_at: 1995-06-08 04:20:07
            id: 11
          - company_id: 430
            updated_at: 2020-02-20 09:10:59
            user_id: 4
            name: The tag
            description: Good tag
            created_at: 1995-06-08 04:20:07
            id: 11
          wireless_monitoring: 60
          credit_enabled: 1
          credit_activated: 1
          company_name: Company
          bootloader_version: 3.0.1
          last_update_at: 2000-01-23T04:56:07.000+00:00
          name: RUT Device 1
          modem_manufacturer: Quectel
          is_authenticated: 1
          network_state: Home
          relay_output_cfg: relay_output_cfg
          status: true
          wan_state: Mobile
          relay_output: relay_output
          fix_status: 0
          gps_time: 2
          batch_number: "0054"
          latitude: 2.3021358869347655
          description: s/n 7841019896, added at 2020-02-13
          created_at: 1995-06-08 04:20:07
          imsi: "246020102200857"
          connection_state: connected
          product_code: RUT955H7VXXX
          mac: 00:00:00:00:00:00
          speed: 9.301444243932576
          hardware_revision: "1307"
          failed_auth_reason: 1
          mobile_ip: 10.20.133.143
          updated_at: 2020-02-20 09:10:59
          temperature: 360
          digital_input: 6
          last_connection_at: 2000-01-23T04:56:07.000+00:00
          credit_expire_date: 2000-01-23T04:56:07.000+00:00
          course: 3.616076749251911
          digital_isolated_input: 1
          firmware: RUT9XX_R_00.06.05.3
          modem_firmware: EC25EFAR02A08M4G
          wlan_mac: 00:00:00:00:00:00
          sim_slot: 1
          gps_monitoring: 300
          mnc: "146"
          company_id: 7034
          connection_type: LTE
          operator_number: "24602"
          connection_uptime: 3012
          sim_state: inserted
          dynamic_monitoring: 300
          activation_status: "11111"
          serial: "7841019896"
          modem_model: EC25
          router_uptime: 3060
          wan_ip: 10.20.133.143
          imei: "111111111111111"
          open_collector_output: 5
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_11_data'
    inline_response_200_12:
      example:
        data:
        - 14785
        - 14785
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: List of devices ids.
          items:
            description: Id of device.
            example: 14785
            type: integer
          type: array
    inline_response_207:
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: List of devices ids.
          items:
            description: Id of device.
            example: 14785
            type: integer
          type: array
        errors:
          description: Errors that occurred during bulk execution.
          items:
            properties:
              code:
                description: Constant code that indicates specific information about
                  error.
                example: SOME_ERROR_CODE
                type: string
              source:
                description: Error source.
                example: "784551"
                nullable: true
                type: string
              message:
                description: Default error message.
                example: Not found.
                type: string
            type: object
          type: array
    inline_response_200_13_data:
      example:
        company_id: 4798
        user_id: 4798
        serial: "1234567890"
        log: 'Uploaded firmware file does not match the one in RMS. [Code: -1]'
        ip: Ip of log origin.
        created_at: 1995-06-08 04:20:07
        id: 39532
        type: Update firmware
        user_agent: Some browser 35.7
        status: true
      properties:
        id:
          description: Id of log.
          example: 39532
          type: integer
        company_id:
          description: Id of company that this log belongs to.
          example: 4798
          type: integer
        user_id:
          description: Id of user who was responsable for this log.
          example: 4798
          type: integer
        serial:
          description: Serial number of device.
          example: "1234567890"
          type: string
        type:
          description: Log type.
          example: Update firmware
          type: string
        status:
          description: Was action logged successful.
          example: true
          type: boolean
        log:
          description: Log text.
          example: 'Uploaded firmware file does not match the one in RMS. [Code: -1]'
          type: string
        user_agent:
          description: User agent information.
          example: Some browser 35.7
          type: string
        ip:
          description: 10.0.10.205
          example: Ip of log origin.
          format: ipv4
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_13:
      example:
        data:
        - company_id: 4798
          user_id: 4798
          serial: "1234567890"
          log: 'Uploaded firmware file does not match the one in RMS. [Code: -1]'
          ip: Ip of log origin.
          created_at: 1995-06-08 04:20:07
          id: 39532
          type: Update firmware
          user_agent: Some browser 35.7
          status: true
        - company_id: 4798
          user_id: 4798
          serial: "1234567890"
          log: 'Uploaded firmware file does not match the one in RMS. [Code: -1]'
          ip: Ip of log origin.
          created_at: 1995-06-08 04:20:07
          id: 39532
          type: Update firmware
          user_agent: Some browser 35.7
          status: true
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_13_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_14_data:
      example:
        active: 1
        created_at: 1995-06-08 04:20:07
        ttl: 69
        link_id: 6963
        url: https://rms.teltonika-networks.com/proxy?rms_token=5e5d022dafdf8&q=
      properties:
        link_id:
          description: Id of a link.
          example: 6963
          type: integer
        url:
          description: Link's url.
          example: https://rms.teltonika-networks.com/proxy?rms_token=5e5d022dafdf8&q=
          format: uri
          type: string
        ttl:
          description: Time to live - how long will link be active.
          example: 69
          type: integer
        active:
          description: Link status.
          example: 1
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_14:
      example:
        data:
        - active: 1
          created_at: 1995-06-08 04:20:07
          ttl: 69
          link_id: 6963
          url: https://rms.teltonika-networks.com/proxy?rms_token=5e5d022dafdf8&q=
        - active: 1
          created_at: 1995-06-08 04:20:07
          ttl: 69
          link_id: 6963
          url: https://rms.teltonika-networks.com/proxy?rms_token=5e5d022dafdf8&q=
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_14_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_object:
      properties:
        url:
          description: RMS Connect connection url.
          example: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.proxy1-connect.rms.teltonika-networks.com
          type: string
      required:
      - url
      type: object
    inline_response_200_15_data:
      example:
        input_data: 21084
        start_time: 1599041994
        company_name: CompanyName
        end_time: 1599043679
        id: 1
        output_data: 85861
        ttl: 1000
        url: https://e0dcb7ac5ca9d902229526f90e1d1a59.demorms.teltonika-networks.com
        username: Username
      properties:
        id:
          description: ID of RMS connect session.
          example: 1
          type: integer
        start_time:
          description: Session start time.
          example: 1599041994
          type: integer
        end_time:
          description: Session end time.
          example: 1599043679
          type: integer
        input_data:
          description: Input data usage.
          example: 21084
          type: integer
        output_data:
          description: Output data usage.
          example: 85861
          type: integer
        username:
          description: User used in RMS connect session.
          example: Username
          type: string
        company_name:
          description: Device company name.
          example: CompanyName
          type: string
        url:
          description: RMS connect url
          example: https://e0dcb7ac5ca9d902229526f90e1d1a59.demorms.teltonika-networks.com
          type: string
        ttl:
          description: RMS connect session time to live
          example: 1000
          type: integer
    inline_response_200_15:
      example:
        data:
          input_data: 21084
          start_time: 1599041994
          company_name: CompanyName
          end_time: 1599043679
          id: 1
          output_data: 85861
          ttl: 1000
          url: https://e0dcb7ac5ca9d902229526f90e1d1a59.demorms.teltonika-networks.com
          username: Username
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_15_data'
    inline_response_200_16_data:
      example:
        input_data: 21084
        start_time: 2000-01-23T04:56:07.000+00:00
        company_name: CompanyName
        end_time: 2000-01-23T04:56:07.000+00:00
        id: 1
        type: webui
        output_data: 85861
        username: Username
      properties:
        id:
          description: ID of RMS connect session.
          example: 1
          type: integer
        type:
          description: Connection type
          example: webui
          type: string
        start_time:
          description: Session start time.
          format: date-time
          type: string
        end_time:
          description: Session end time.
          format: date-time
          type: string
        input_data:
          description: Input data usage.
          example: 21084
          type: integer
        output_data:
          description: Output data usage.
          example: 85861
          type: integer
        username:
          description: User used in RMS connect session.
          example: Username
          type: string
        company_name:
          description: Device company name.
          example: CompanyName
          type: string
    inline_response_200_16:
      example:
        data:
        - input_data: 21084
          start_time: 2000-01-23T04:56:07.000+00:00
          company_name: CompanyName
          end_time: 2000-01-23T04:56:07.000+00:00
          id: 1
          type: webui
          output_data: 85861
          username: Username
        - input_data: 21084
          start_time: 2000-01-23T04:56:07.000+00:00
          company_name: CompanyName
          end_time: 2000-01-23T04:56:07.000+00:00
          id: 1
          type: webui
          output_data: 85861
          username: Username
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        meta:
          $ref: '#/components/schemas/meta_total'
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_16_data'
          type: array
    inline_response_200_17_tags:
      example:
        name: The tag
        id: "1"
      properties:
        id:
          description: Tag id
          example: "1"
          type: string
        name:
          description: Tag name
          example: The tag
          type: string
    inline_response_200_17_data:
      example:
        user_email: user_email
        screen_width: 1080
        company_id: 5012
        user_username: user_username
        latitude: 58.10504
        created_at: 1995-06-08 04:20:07
        battery: 42
        device_uuid: 62968a96-8212-44dd-a391-77c6d180cd62
        manufacturer: Sony
        tags:
        - name: The tag
          id: "1"
        - name: The tag
          id: "1"
        screen_height: 2382
        updated_at: 2020-02-20 09:10:59
        user_id: 1
        company_name: company_name
        device_token: fdygykhgjl3gh5df6gj1f3hhgjffk1gfg1hj6f1h
        operating_system: android
        model: J9210
        id: 6963
        network_state: LTE
        cpu_usage: 80%
        hardware: qcom
        longitude: 56.24008
      properties:
        id:
          description: Mobile device id.
          example: 6963
          type: integer
        user_id:
          description: Creator of mobile device id.
          example: 1
          type: integer
        company_id:
          description: Id of company that mobile device belongs to.
          example: 5012
          type: integer
        user_username:
          type: string
        user_email:
          type: string
        company_name:
          type: string
        device_token:
          description: Firebase token.
          example: fdygykhgjl3gh5df6gj1f3hhgjffk1gfg1hj6f1h
          type: string
        device_uuid:
          description: Phone's uuid, if none provided it will be generated.
          example: 62968a96-8212-44dd-a391-77c6d180cd62
          type: string
        manufacturer:
          description: Mobile phone manufacturer.
          example: Sony
          type: string
        model:
          description: Mobile phone model.
          example: J9210
          type: string
        operating_system:
          description: Phone's operating system.
          example: android
          type: string
        hardware:
          description: Phone's hardware.
          example: qcom
          type: string
        screen_height:
          description: Height of phone screen.
          example: 2382
          type: integer
        screen_width:
          description: Width of phone screen.
          example: 1080
          type: integer
        battery:
          description: Battery left of mobile phone.
          example: 42
          type: integer
        latitude:
          description: Phone location - latitude.
          example: 58.10504
          type: number
        longitude:
          description: Phone location - longitude.
          example: 56.24008
          type: number
        cpu_usage:
          description: Phone's cpu usage.
          example: 80%
          type: string
        network_state:
          description: Phone's network state.
          example: LTE
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
        tags:
          items:
            $ref: '#/components/schemas/inline_response_200_17_tags'
          type: array
    inline_response_200_17:
      example:
        data:
        - user_email: user_email
          screen_width: 1080
          company_id: 5012
          user_username: user_username
          latitude: 58.10504
          created_at: 1995-06-08 04:20:07
          battery: 42
          device_uuid: 62968a96-8212-44dd-a391-77c6d180cd62
          manufacturer: Sony
          tags:
          - name: The tag
            id: "1"
          - name: The tag
            id: "1"
          screen_height: 2382
          updated_at: 2020-02-20 09:10:59
          user_id: 1
          company_name: company_name
          device_token: fdygykhgjl3gh5df6gj1f3hhgjffk1gfg1hj6f1h
          operating_system: android
          model: J9210
          id: 6963
          network_state: LTE
          cpu_usage: 80%
          hardware: qcom
          longitude: 56.24008
        - user_email: user_email
          screen_width: 1080
          company_id: 5012
          user_username: user_username
          latitude: 58.10504
          created_at: 1995-06-08 04:20:07
          battery: 42
          device_uuid: 62968a96-8212-44dd-a391-77c6d180cd62
          manufacturer: Sony
          tags:
          - name: The tag
            id: "1"
          - name: The tag
            id: "1"
          screen_height: 2382
          updated_at: 2020-02-20 09:10:59
          user_id: 1
          company_name: company_name
          device_token: fdygykhgjl3gh5df6gj1f3hhgjffk1gfg1hj6f1h
          operating_system: android
          model: J9210
          id: 6963
          network_state: LTE
          cpu_usage: 80%
          hardware: qcom
          longitude: 56.24008
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Wrapped array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_17_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_18:
      example:
        data:
          user_email: user_email
          screen_width: 1080
          company_id: 5012
          user_username: user_username
          latitude: 58.10504
          created_at: 1995-06-08 04:20:07
          battery: 42
          device_uuid: 62968a96-8212-44dd-a391-77c6d180cd62
          manufacturer: Sony
          tags:
          - name: The tag
            id: "1"
          - name: The tag
            id: "1"
          screen_height: 2382
          updated_at: 2020-02-20 09:10:59
          user_id: 1
          company_name: company_name
          device_token: fdygykhgjl3gh5df6gj1f3hhgjffk1gfg1hj6f1h
          operating_system: android
          model: J9210
          id: 6963
          network_state: LTE
          cpu_usage: 80%
          hardware: qcom
          longitude: 56.24008
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_17_data'
    inline_response_200_19_data:
      example:
        mobile_device_model: JFX501
        company_id: 0
        destination_port: "8080"
        created_at: 1995-06-08 04:20:07
        mobile_device_token: fdygykhgjl3gh5df6gj1f3hhgjffk1gfg1hj6f1h
        protocol: ssh
        destination_ip: 127.0.0.1
        mobile_device_uuid: mobile_device_uuid
        updated_at: 2020-02-20 09:10:59
        mobile_device_id: 7810
        company_name: company_name
        name: Test1
        disabled: 6
        id: 6963
      properties:
        id:
          description: Mobile device connection id.
          example: 6963
          type: integer
        mobile_device_id:
          description: Mobile device id.
          example: 7810
          type: integer
        mobile_device_model:
          description: Name of mobile device model.
          example: JFX501
          type: string
        company_id:
          type: integer
        company_name:
          type: string
        name:
          description: Name of mobile device connection.
          example: Test1
          type: string
        protocol:
          description: Connection's protocol.
          example: ssh
          type: string
        destination_ip:
          description: Connection's destination ip.
          example: 127.0.0.1
          type: string
        destination_port:
          description: Connection's destination port.
          example: "8080"
          type: string
        disabled:
          type: integer
        mobile_device_token:
          description: Mobile device push token.
          example: fdygykhgjl3gh5df6gj1f3hhgjffk1gfg1hj6f1h
          type: string
        mobile_device_uuid:
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_19:
      example:
        data:
        - mobile_device_model: JFX501
          company_id: 0
          destination_port: "8080"
          created_at: 1995-06-08 04:20:07
          mobile_device_token: fdygykhgjl3gh5df6gj1f3hhgjffk1gfg1hj6f1h
          protocol: ssh
          destination_ip: 127.0.0.1
          mobile_device_uuid: mobile_device_uuid
          updated_at: 2020-02-20 09:10:59
          mobile_device_id: 7810
          company_name: company_name
          name: Test1
          disabled: 6
          id: 6963
        - mobile_device_model: JFX501
          company_id: 0
          destination_port: "8080"
          created_at: 1995-06-08 04:20:07
          mobile_device_token: fdygykhgjl3gh5df6gj1f3hhgjffk1gfg1hj6f1h
          protocol: ssh
          destination_ip: 127.0.0.1
          mobile_device_uuid: mobile_device_uuid
          updated_at: 2020-02-20 09:10:59
          mobile_device_id: 7810
          company_name: company_name
          name: Test1
          disabled: 6
          id: 6963
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Wrapped array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_19_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_20:
      example:
        data:
          mobile_device_model: JFX501
          company_id: 0
          destination_port: "8080"
          created_at: 1995-06-08 04:20:07
          mobile_device_token: fdygykhgjl3gh5df6gj1f3hhgjffk1gfg1hj6f1h
          protocol: ssh
          destination_ip: 127.0.0.1
          mobile_device_uuid: mobile_device_uuid
          updated_at: 2020-02-20 09:10:59
          mobile_device_id: 7810
          company_name: company_name
          name: Test1
          disabled: 6
          id: 6963
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_19_data'
    inline_response_200_21_data:
      example:
        input_data: 0
        webrtc_user: 1741969466e6a03801ab4d40ff9fe4b11f50a71e91d5f
        end_time: 0
        type: http
        mobile_device_connection_id: "10"
        ttl: 0
        url: 1741969466e6a03801ab4d40ff9fe4b11f50a71e91d5fa57f39f11674b32b283.webrtc1-connect.teltonika.com
        start_time: 0
        user_id: 5
        mobile_device_id: 75
        id: 6963
        output_data: 0
        status: closed_by_user
      properties:
        id:
          description: Mobile device connection access id.
          example: 6963
          type: integer
        type:
          description: Type of access.
          example: http
          type: string
        user_id:
          description: Id of creator of access.
          example: 5
          type: integer
        mobile_device_id:
          description: Mobile device id.
          example: 75
          type: integer
        mobile_device_connection_id:
          description: Mobile device connection id.
          example: "10"
          type: string
        webrtc_user:
          description: Webrtc user hash.
          example: 1741969466e6a03801ab4d40ff9fe4b11f50a71e91d5f
          type: string
        url:
          description: Access link.
          example: 1741969466e6a03801ab4d40ff9fe4b11f50a71e91d5fa57f39f11674b32b283.webrtc1-connect.teltonika.com
          type: string
        input_data:
          description: Input data.
          example: 0
          type: integer
        output_data:
          description: Output data.
          example: 0
          type: integer
        start_time:
          description: Access start time.
          example: 0
          type: integer
        end_time:
          description: Access end time.
          example: 0
          type: integer
        ttl:
          type: integer
        status:
          description: Access status.
          example: closed_by_user
          type: string
    inline_response_200_21:
      example:
        data:
        - input_data: 0
          webrtc_user: 1741969466e6a03801ab4d40ff9fe4b11f50a71e91d5f
          end_time: 0
          type: http
          mobile_device_connection_id: "10"
          ttl: 0
          url: 1741969466e6a03801ab4d40ff9fe4b11f50a71e91d5fa57f39f11674b32b283.webrtc1-connect.teltonika.com
          start_time: 0
          user_id: 5
          mobile_device_id: 75
          id: 6963
          output_data: 0
          status: closed_by_user
        - input_data: 0
          webrtc_user: 1741969466e6a03801ab4d40ff9fe4b11f50a71e91d5f
          end_time: 0
          type: http
          mobile_device_connection_id: "10"
          ttl: 0
          url: 1741969466e6a03801ab4d40ff9fe4b11f50a71e91d5fa57f39f11674b32b283.webrtc1-connect.teltonika.com
          start_time: 0
          user_id: 5
          mobile_device_id: 75
          id: 6963
          output_data: 0
          status: closed_by_user
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Wrapped array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_21_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_22_data:
      example:
        input_data: 0
        threshold_output: 1
        company_id: 5
        end_time: 0
        type: type
        mobile_device_connection_id: 0
        threshold_input: 6
        start_time: 0
        mobile_device_id: 75
        company_name: company_name
        mobile_device_connection_access_id: "10"
        id: 6963
        output_data: 0
        email: email
        status: active
      properties:
        id:
          description: Mobile device connection access log id.
          example: 6963
          type: integer
        mobile_device_id:
          description: Mobile device id.
          example: 75
          type: integer
        mobile_device_connection_access_id:
          description: Mobile device connection access id.
          example: "10"
          type: string
        mobile_device_connection_id:
          type: integer
        email:
          type: string
        threshold_input:
          type: integer
        threshold_output:
          type: integer
        input_data:
          description: Logged used input data.
          example: 0
          type: integer
        output_data:
          description: Logged used output data.
          example: 0
          type: integer
        start_time:
          description: Logged access start time.
          example: 0
          type: integer
        end_time:
          description: Logged access end time.
          example: 0
          type: integer
        status:
          description: Access log status.
          example: active
          type: string
        company_id:
          type: integer
        company_name:
          type: string
        type:
          type: string
    inline_response_200_22:
      example:
        data:
        - input_data: 0
          threshold_output: 1
          company_id: 5
          end_time: 0
          type: type
          mobile_device_connection_id: 0
          threshold_input: 6
          start_time: 0
          mobile_device_id: 75
          company_name: company_name
          mobile_device_connection_access_id: "10"
          id: 6963
          output_data: 0
          email: email
          status: active
        - input_data: 0
          threshold_output: 1
          company_id: 5
          end_time: 0
          type: type
          mobile_device_connection_id: 0
          threshold_input: 6
          start_time: 0
          mobile_device_id: 75
          company_name: company_name
          mobile_device_connection_access_id: "10"
          id: 6963
          output_data: 0
          email: email
          status: active
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Wrapped array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_22_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_23_tags:
      example:
        name: The tag
        id: 11
      properties:
        id:
          description: Tag id.
          example: 11
          type: integer
        name:
          description: Tag name.
          example: The tag
          type: string
    inline_response_200_23_data:
      example:
        device_id: 777
        destination_port: 80
        device_description: "351489677415"
        created_at: 2000-01-23T04:56:07.000+00:00
        credentials_required: false
        tags:
        - name: The tag
          id: 11
        - name: The tag
          id: 11
        protocol: protocol
        device_name: Rutx
        destination_ip: 127.0.0.1
        is_main: false
        mqtt: 1.2
        company_name: Teltonika
        name: Access rule name
        id: 62375
      properties:
        id:
          description: Id of a remote access.
          example: 62375
          type: integer
        device_id:
          description: Id of device that this remote access belongs to.
          example: 777
          type: integer
        name:
          description: Name of a access.
          example: Access rule name
          type: string
        destination_ip:
          description: Destination ip address.
          example: 127.0.0.1
          format: ipv4
          type: string
        destination_port:
          description: Destination port.
          example: 80
          type: integer
        protocol:
          description: Connection protocol.
          type: string
        is_main:
          description: Is this remote access is main for device.
          example: false
          type: boolean
        credentials_required:
          description: Set if credentials be required on connect.
          example: false
          type: boolean
        mqtt:
          description: Device's mqqt version. 0 - means device uses vpn.
          example: 1.2
          type: number
        device_name:
          description: Device name.
          example: Rutx
          type: string
        device_description:
          description: Device description.
          example: "351489677415"
          type: string
        tags:
          description: Remote Access tags list.
          items:
            $ref: '#/components/schemas/inline_response_200_23_tags'
          type: array
        company_name:
          description: Device company name.
          example: Teltonika
          type: string
        created_at:
          description: Timestamp of entry's creation.
          format: date-time
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_23:
      example:
        data:
        - device_id: 777
          destination_port: 80
          device_description: "351489677415"
          created_at: 2000-01-23T04:56:07.000+00:00
          credentials_required: false
          tags:
          - name: The tag
            id: 11
          - name: The tag
            id: 11
          protocol: protocol
          device_name: Rutx
          destination_ip: 127.0.0.1
          is_main: false
          mqtt: 1.2
          company_name: Teltonika
          name: Access rule name
          id: 62375
        - device_id: 777
          destination_port: 80
          device_description: "351489677415"
          created_at: 2000-01-23T04:56:07.000+00:00
          credentials_required: false
          tags:
          - name: The tag
            id: 11
          - name: The tag
            id: 11
          protocol: protocol
          device_name: Rutx
          destination_ip: 127.0.0.1
          is_main: false
          mqtt: 1.2
          company_name: Teltonika
          name: Access rule name
          id: 62375
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_23_data'
          type: array
    inline_response_200_24_data:
      example:
        job_type: 101
        device_id: 46245
        serial: "1234567890"
        name: Test
        id: 44
      properties:
        id:
          description: Id of a pending update action.
          example: 44
          type: integer
        job_type:
          description: Type of job.
          example: 101
          type: integer
        name:
          description: Name of a update.
          example: Test
          type: string
        serial:
          description: Device's serial number.
          example: "1234567890"
          type: string
        device_id:
          description: Device's id.
          example: 46245
          type: integer
    inline_response_200_24:
      example:
        data:
        - job_type: 101
          device_id: 46245
          serial: "1234567890"
          name: Test
          id: 44
        - job_type: 101
          device_id: 46245
          serial: "1234567890"
          name: Test
          id: 44
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_24_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_25:
      example:
        data:
        - 7
        - 7
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Ids list of canceled update jobs.
          items:
            description: Canceled update job id.
            example: 7
            type: integer
          type: array
    inline_response_207_1:
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Ids list of canceled update jobs.
          items:
            description: Canceled update job id.
            example: 7
            type: integer
          type: array
        errors:
          description: Errors that occurred during bulk execution.
          items:
            properties:
              code:
                description: Constant code that indicates specific information about
                  error.
                example: SOME_ERROR_CODE
                type: string
              source:
                description: Error source.
                example: "784551"
                nullable: true
                type: string
              message:
                description: Default error message.
                example: Not found.
                type: string
            type: object
          type: array
    inline_response_200_26_events:
      example:
        reference_id: reference_id
        action: action
        created_at: created_at
        message: message
      properties:
        action:
          type: string
        message:
          type: string
        created_at:
          type: string
        reference_id:
          nullable: true
          type: string
    inline_response_200_26_additional_information:
      example:
        source_id: 0
        source_name: source_name
      properties:
        source_id:
          type: integer
        source_name:
          type: string
    inline_response_200_26_data:
      example:
        device_id: 46245
        finished_at: 2000-01-23T04:56:07.000+00:00
        action_tag_id: 6
        created_at: 2000-01-23T04:56:07.000+00:00
        scheduler_id: "12345"
        action_tag_name: action_tag_name
        additional_information:
          source_id: 0
          source_name: source_name
        request_target_state: failed
        device_name: device_name
        device_serial: device_serial
        action_tag_description: action_tag_description
        action_name: "101"
        action_initialized_from: tag_action
        events:
        - reference_id: reference_id
          action: action
          created_at: created_at
          message: message
        - reference_id: reference_id
          action: action
          created_at: created_at
          message: message
      properties:
        events:
          items:
            $ref: '#/components/schemas/inline_response_200_26_events'
          type: array
        action_name:
          description: Name of the action
          example: "101"
          type: string
        scheduler_id:
          description: Job id used in canceling actions.
          example: "12345"
          type: string
        request_target_state:
          description: Status of action.
          example: failed
          type: string
        device_id:
          description: Device's id.
          example: 46245
          type: integer
        action_initialized_from:
          example: tag_action
          type: string
        additional_information:
          $ref: '#/components/schemas/inline_response_200_26_additional_information'
        device_name:
          description: Device name.
          type: string
        device_serial:
          nullable: true
          type: string
        action_tag_id:
          type: integer
        created_at:
          format: date-time
          type: string
        finished_at:
          format: date-time
          type: string
        action_tag_name:
          nullable: true
          type: string
        action_tag_description:
          nullable: true
          type: string
    inline_response_200_26:
      example:
        data:
        - device_id: 46245
          finished_at: 2000-01-23T04:56:07.000+00:00
          action_tag_id: 6
          created_at: 2000-01-23T04:56:07.000+00:00
          scheduler_id: "12345"
          action_tag_name: action_tag_name
          additional_information:
            source_id: 0
            source_name: source_name
          request_target_state: failed
          device_name: device_name
          device_serial: device_serial
          action_tag_description: action_tag_description
          action_name: "101"
          action_initialized_from: tag_action
          events:
          - reference_id: reference_id
            action: action
            created_at: created_at
            message: message
          - reference_id: reference_id
            action: action
            created_at: created_at
            message: message
        - device_id: 46245
          finished_at: 2000-01-23T04:56:07.000+00:00
          action_tag_id: 6
          created_at: 2000-01-23T04:56:07.000+00:00
          scheduler_id: "12345"
          action_tag_name: action_tag_name
          additional_information:
            source_id: 0
            source_name: source_name
          request_target_state: failed
          device_name: device_name
          device_serial: device_serial
          action_tag_description: action_tag_description
          action_name: "101"
          action_initialized_from: tag_action
          events:
          - reference_id: reference_id
            action: action
            created_at: created_at
            message: message
          - reference_id: reference_id
            action: action
            created_at: created_at
            message: message
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_26_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_27_data:
      example:
        total: 2
        company_id: 360
        updated_at: 2020-02-20 09:10:59
        company_name: Company
        created_at: 1995-06-08 04:20:07
        id: bQEBivEcpwMU450ryHcHD4b26Uyhd3z3tWByqH0tX5Kcdw7Uh5SZb4Mk7Nea0zMI
        completed: 0
        deleted_at: 2012-12-12 12:12:12
      properties:
        id:
          description: Hash used as id for a task.
          example: bQEBivEcpwMU450ryHcHD4b26Uyhd3z3tWByqH0tX5Kcdw7Uh5SZb4Mk7Nea0zMI
          type: string
        company_id:
          description: Id of comapny that created this device password task.
          example: 360
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
        deleted_at:
          description: Timestamp of entry's deletion.
          example: 2012-12-12 12:12:12
          pattern: Y-m-d H:i:s
          type: string
        company_name:
          description: Name of company that created this device password task.
          example: Company
          type: string
        completed:
          description: Number of devices that completed this password task.
          example: 0
          type: integer
        total:
          description: Number of devices that has to do this password task.
          example: 2
          type: integer
    inline_response_200_27:
      example:
        data:
        - total: 2
          company_id: 360
          updated_at: 2020-02-20 09:10:59
          company_name: Company
          created_at: 1995-06-08 04:20:07
          id: bQEBivEcpwMU450ryHcHD4b26Uyhd3z3tWByqH0tX5Kcdw7Uh5SZb4Mk7Nea0zMI
          completed: 0
          deleted_at: 2012-12-12 12:12:12
        - total: 2
          company_id: 360
          updated_at: 2020-02-20 09:10:59
          company_name: Company
          created_at: 1995-06-08 04:20:07
          id: bQEBivEcpwMU450ryHcHD4b26Uyhd3z3tWByqH0tX5Kcdw7Uh5SZb4Mk7Nea0zMI
          completed: 0
          deleted_at: 2012-12-12 12:12:12
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_27_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_201_1:
      example:
        data:
        - 42178
        - 42178
        success: true
        meta:
          channel: private-status.1.6AY8tkkgOAu2AFaoNtUeBhykaJIcTx8y6AY8tkkgOAu2AFaoNtUeBhykaJIcTx8y
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: List of devices that has new passwords.
          items:
            description: Id of device.
            example: 42178
            type: integer
          type: array
        meta:
          $ref: '#/components/schemas/meta_channel'
    inline_response_207_2:
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: List of devices that has new passwords.
          items:
            description: Id of device.
            example: 42178
            type: integer
          type: array
        errors:
          description: Errors that occurred during bulk execution.
          items:
            properties:
              code:
                description: Constant code that indicates specific information about
                  error.
                example: SOME_ERROR_CODE
                type: string
              source:
                description: Error source.
                example: "784551"
                nullable: true
                type: string
              message:
                description: Default error message.
                example: Not found.
                type: string
            type: object
          type: array
        meta:
          $ref: '#/components/schemas/meta_channel'
    inline_response_200_28_data:
      example:
        serial: "1234567890"
        name: Device1
        description: s/n 1234567890, added at 2020-02-14
        created_at: 1995-06-08 04:20:07
        id: 2077
        mac: 00:00:00:00:00:00
        status: failed
      properties:
        id:
          description: Device id.
          example: 2077
          type: integer
        name:
          description: Device name.
          example: Device1
          type: string
        serial:
          description: Serial number of a device.
          example: "1234567890"
          type: string
        mac:
          description: Mac number of a device.
          example: 00:00:00:00:00:00
          type: string
        description:
          description: Device's description.
          example: s/n 1234567890, added at 2020-02-14
          type: string
        status:
          description: Status of task for this device.
          example: failed
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_28:
      example:
        data:
        - serial: "1234567890"
          name: Device1
          description: s/n 1234567890, added at 2020-02-14
          created_at: 1995-06-08 04:20:07
          id: 2077
          mac: 00:00:00:00:00:00
          status: failed
        - serial: "1234567890"
          name: Device1
          description: s/n 1234567890, added at 2020-02-14
          created_at: 1995-06-08 04:20:07
          id: 2077
          mac: 00:00:00:00:00:00
          status: failed
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_28_data'
          type: array
    inline_response_200_29_data:
      example:
        altitude: 25
        latitude: 54.6872
        created_at: 1995-06-08 04:20:07
        longitude: 25.2797
      properties:
        latitude:
          description: Latitude coordinates.
          example: 54.6872
          type: number
        longitude:
          description: Longitude coordinates.
          example: 25.2797
          type: number
        altitude:
          description: Altitude coordinates.
          example: 25
          type: number
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_29:
      example:
        data:
        - altitude: 25
          latitude: 54.6872
          created_at: 1995-06-08 04:20:07
          longitude: 25.2797
        - altitude: 25
          latitude: 54.6872
          created_at: 1995-06-08 04:20:07
          longitude: 25.2797
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_29_data'
          type: array
    inline_response_200_30_data:
      example:
        sim_slot: 1
        connection_type: LTE
        sim2_received: 0
        created_at: ' 2019-12-09 14:01:24 '
        operator: Fake Operator
        signal_2: 6
        mobile_ip: 127.0.0.1
        sim1_sent: 0
        operator_2: Fake Operator
        temperature_2: 360
        temperature: 360
        connection_type_2: LTE
        wan_ip: 127.0.0.1
        network_state: registered (home)
        sim_slot_2: 1
        mobile_ip_2: 127.0.0.1
        signal: 0
        network_state_2: registered (home)
        sim1_received: 0
        sim2_sent: 0
      properties:
        signal:
          description: Device's signal strength, at given time moment. If null data
            was not recorded.
          nullable: true
          type: integer
        signal_2:
          description: Device's signal strength, at given time moment. If null data
            was not recorded.
          nullable: true
          type: integer
        temperature:
          description: Device's temperature, at given time moment. If null data was
            not recorded. Last digit (zero) indicates it is celsius.
          example: 360
          nullable: true
          type: integer
        temperature_2:
          description: Device's temperature, at given time moment. If null data was
            not recorded. Last digit (zero) indicates it is celsius.
          example: 360
          nullable: true
          type: integer
        sim1_sent:
          description: Device's amount of sent data, at given time moment, for sim1.
            If null data was not recorded.
          example: 0
          nullable: true
          type: integer
        sim1_received:
          description: Device's amount of received data, at given time moment, for
            sim1. If null data was not recorded.
          example: 0
          nullable: true
          type: integer
        sim2_sent:
          description: Device's amount of sent data, at given time moment, for sim2.
            If null data was not recorded.
          example: 0
          nullable: true
          type: integer
        sim2_received:
          description: Device's amount of received data, at given time moment, for
            sim2. If null data was not recorded.
          example: 0
          nullable: true
          type: integer
        network_state:
          description: State of network, at given time moment. If null data was not
            recorded.
          example: registered (home)
          nullable: true
          type: string
        network_state_2:
          description: State of network, at given time moment. If null data was not
            recorded.
          example: registered (home)
          nullable: true
          type: string
        sim_slot:
          description: Sim slot used by device, at given time moment. If null data
            was not recorded.
          example: 1
          nullable: true
          type: integer
        sim_slot_2:
          description: Sim slot used by device, at given time moment. If null data
            was not recorded.
          example: 1
          nullable: true
          type: integer
        operator:
          description: Device used operator, at given time moment. If null data was
            not recorded.
          example: Fake Operator
          nullable: true
          type: string
        operator_2:
          description: Device used operator, at given time moment. If null data was
            not recorded.
          example: Fake Operator
          nullable: true
          type: string
        connection_type:
          description: Device's connection type, at given time moment. If null data
            was not recorded.
          example: LTE
          nullable: true
          type: string
        connection_type_2:
          description: Device's connection type, at given time moment. If null data
            was not recorded.
          example: LTE
          nullable: true
          type: string
        wan_ip:
          description: Wan ip, at given time moment. If null data was not recorded.
          example: 127.0.0.1
          nullable: true
          type: string
        mobile_ip:
          description: Mobile ip, at given time moment. If null data was not recorded.
          example: 127.0.0.1
          nullable: true
          type: string
        mobile_ip_2:
          description: Mobile ip, at given time moment. If null data was not recorded.
          example: 127.0.0.1
          nullable: true
          type: string
        created_at:
          description: The time moment.
          example: ' 2019-12-09 14:01:24 '
          type: string
    inline_response_200_30:
      example:
        data:
        - sim_slot: 1
          connection_type: LTE
          sim2_received: 0
          created_at: ' 2019-12-09 14:01:24 '
          operator: Fake Operator
          signal_2: 6
          mobile_ip: 127.0.0.1
          sim1_sent: 0
          operator_2: Fake Operator
          temperature_2: 360
          temperature: 360
          connection_type_2: LTE
          wan_ip: 127.0.0.1
          network_state: registered (home)
          sim_slot_2: 1
          mobile_ip_2: 127.0.0.1
          signal: 0
          network_state_2: registered (home)
          sim1_received: 0
          sim2_sent: 0
        - sim_slot: 1
          connection_type: LTE
          sim2_received: 0
          created_at: ' 2019-12-09 14:01:24 '
          operator: Fake Operator
          signal_2: 6
          mobile_ip: 127.0.0.1
          sim1_sent: 0
          operator_2: Fake Operator
          temperature_2: 360
          temperature: 360
          connection_type_2: LTE
          wan_ip: 127.0.0.1
          network_state: registered (home)
          sim_slot_2: 1
          mobile_ip_2: 127.0.0.1
          signal: 0
          network_state_2: registered (home)
          sim1_received: 0
          sim2_sent: 0
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Data wrapper.
          items:
            $ref: '#/components/schemas/inline_response_200_30_data'
          type: array
    inline_response_200_31_data:
      description: Data wrapper. Selected parameters graph data is placed in here.
      example:
        Maximum:
          key: 450
        Minimum:
          key: 300
      properties:
        Maximum:
          additionalProperties:
            description: Maximum value at given time moment. Property name is same
              as requested parameter's.
            example: 450
            type: number
          properties:
            serial:
              description: Device's serial number.
              example: "1234567890"
              type: string
            device_id:
              type: integer
            created_at:
              description: The time moment.
              example: 2019-12-09 14:01:24
              type: string
          type: object
        Minimum:
          additionalProperties:
            description: Minimum value at given time moment. Property name is same
              as requested parameter's.
            example: 300
            type: number
          properties:
            serial:
              description: Device's serial number.
              example: "1001042485"
              type: string
            device_id:
              type: integer
            created_at:
              description: The time moment.
              example: 2019-12-09 14:01:24
              type: string
          type: object
    inline_response_200_31:
      example:
        data:
          Maximum:
            key: 450
          Minimum:
            key: 300
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_31_data'
    inline_response_200_32_data:
      example:
        wan_state: Mobile
        tx_month: 5139811/5139811
        rx_month: 61574384 B / 61574384 B
        tx_week: 5139811/5139811
        pin_state: READY
        connection_state: connected
        mcc: "246"
        operator: LT BITE GSM
        lac: "10501"
        mobile_ip: 10.0.163.159
        iccid: "11111111111111111111"
        temperature: 360
        tx_day: 4238286/4238286
        firmware: RUTX_R_00.01.06
        signal: 0
        cell_id: "6893643"
        sim_slot: 1
        mnc: "02"
        device_id: 73181
        connection_type: WCDMA
        operator_number: 24602
        connection_uptime: 269412
        sim_state: inserted
        rx_day: 61014369 B / 61014369 B
        rx_week: 61574384 B / 61574384 B
        router_uptime: 269469
        wan_ip: 10.0.163.159
        network_state: registered (home)
      properties:
        device_id:
          description: Device id.
          example: 73181
          type: integer
        firmware:
          description: Firmware used by this device.
          example: RUTX_R_00.01.06
          type: string
        sim_state:
          description: Sim state.
          example: inserted
          type: string
        pin_state:
          description: Pin state.
          example: READY
          type: string
        sim_slot:
          description: Sim slot number.
          example: 1
          type: integer
        network_state:
          description: State of the network.
          example: registered (home)
          type: string
        mobile_ip:
          description: Mobile ip
          example: 10.0.163.159
          type: string
        signal:
          description: Device signal strength.
          type: integer
        operator:
          description: Device operator.
          example: LT BITE GSM
          type: string
        operator_number:
          description: Operator number.
          example: 24602
          type: integer
        connection_state:
          description: Device state of the connection.
          example: connected
          type: string
        connection_type:
          description: Device type of the connection.
          example: WCDMA
          type: string
        temperature:
          description: Device temperature.
          example: 360
          type: integer
        router_uptime:
          description: Router uptime in seconds.
          example: 269469
          type: integer
        connection_uptime:
          description: Connection uptime in seconds.
          example: 269412
          type: integer
        wan_state:
          description: Device state of the wan.
          example: Mobile
          type: string
        wan_ip:
          description: Wan ip number.
          example: 10.0.163.159
          type: string
        cell_id:
          description: Cell id.
          example: "6893643"
          type: string
        mcc:
          description: Mobile country code.
          example: "246"
          type: string
        mnc:
          description: Mobile network code.
          example: "02"
          type: string
        lac:
          description: Location area code.
          example: "10501"
          type: string
        iccid:
          description: Integrated Circuit Card Identifier.
          example: "11111111111111111111"
          type: string
        rx_day:
          description: Received data for day.
          example: 61014369 B / 61014369 B
          type: string
        rx_week:
          description: Received data for week.
          example: 61574384 B / 61574384 B
          type: string
        rx_month:
          description: Received data for month.
          example: 61574384 B / 61574384 B
          type: string
        tx_day:
          description: Transmitted (sent) data for day.
          example: 4238286/4238286
          type: string
        tx_week:
          description: Transmitted (sent) data for week.
          example: 5139811/5139811
          type: string
        tx_month:
          description: Transmitted (sent) data for month.
          example: 5139811/5139811
          type: string
    inline_response_200_32:
      example:
        data:
        - wan_state: Mobile
          tx_month: 5139811/5139811
          rx_month: 61574384 B / 61574384 B
          tx_week: 5139811/5139811
          pin_state: READY
          connection_state: connected
          mcc: "246"
          operator: LT BITE GSM
          lac: "10501"
          mobile_ip: 10.0.163.159
          iccid: "11111111111111111111"
          temperature: 360
          tx_day: 4238286/4238286
          firmware: RUTX_R_00.01.06
          signal: 0
          cell_id: "6893643"
          sim_slot: 1
          mnc: "02"
          device_id: 73181
          connection_type: WCDMA
          operator_number: 24602
          connection_uptime: 269412
          sim_state: inserted
          rx_day: 61014369 B / 61014369 B
          rx_week: 61574384 B / 61574384 B
          router_uptime: 269469
          wan_ip: 10.0.163.159
          network_state: registered (home)
        - wan_state: Mobile
          tx_month: 5139811/5139811
          rx_month: 61574384 B / 61574384 B
          tx_week: 5139811/5139811
          pin_state: READY
          connection_state: connected
          mcc: "246"
          operator: LT BITE GSM
          lac: "10501"
          mobile_ip: 10.0.163.159
          iccid: "11111111111111111111"
          temperature: 360
          tx_day: 4238286/4238286
          firmware: RUTX_R_00.01.06
          signal: 0
          cell_id: "6893643"
          sim_slot: 1
          mnc: "02"
          device_id: 73181
          connection_type: WCDMA
          operator_number: 24602
          connection_uptime: 269412
          sim_state: inserted
          rx_day: 61014369 B / 61014369 B
          rx_week: 61574384 B / 61574384 B
          router_uptime: 269469
          wan_ip: 10.0.163.159
          network_state: registered (home)
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_32_data'
          type: array
    inline_response_200_33:
      example:
        data:
        - key: RUTX_R_00.01.06
        - key: RUTX_R_00.01.06
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            additionalProperties:
              description: Element used by this device at created at moment. Key depends
                on selected parameter.
              example: RUTX_R_00.01.06
              type: string
            properties:
              created_at:
                $ref: '#/components/schemas/created_at'
            type: object
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_34_data:
      example:
        date: 2019-07-29T00:00:00.000+0000
        times:
        - 00:01:19
        - 00:01:19
      properties:
        date:
          description: Year, month, day.
          example: 2019-07-29
          format: date
          type: string
        times:
          items:
            description: Hour, minute, second.
            example: 00:01:19
            type: string
          type: array
    inline_response_200_34:
      example:
        data:
        - date: 2019-07-29T00:00:00.000+0000
          times:
          - 00:01:19
          - 00:01:19
        - date: 2019-07-29T00:00:00.000+0000
          times:
          - 00:01:19
          - 00:01:19
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_34_data'
          type: array
    inline_response_200_35_data:
      example:
        tx: 1024
        rx: 1024
      properties:
        rx:
          description: Data received
          example: 1024
          type: integer
        tx:
          description: Data sent
          example: 1024
          type: integer
    inline_response_200_35_sims:
      example:
        sim_id: 1
        data:
          tx: 1024
          rx: 1024
      properties:
        sim_id:
          description: Sim id
          example: 1
          type: integer
        data:
          $ref: '#/components/schemas/inline_response_200_35_data'
    inline_response_200_35_modems:
      example:
        sims:
        - sim_id: 1
          data:
            tx: 1024
            rx: 1024
        - sim_id: 1
          data:
            tx: 1024
            rx: 1024
        modem_id: 3-1
      properties:
        modem_id:
          description: Modem id
          example: 3-1
          type: string
        sims:
          items:
            $ref: '#/components/schemas/inline_response_200_35_sims'
          type: array
    inline_response_200_35_data_1:
      example:
        date: 2020-07-28
        modems:
        - sims:
          - sim_id: 1
            data:
              tx: 1024
              rx: 1024
          - sim_id: 1
            data:
              tx: 1024
              rx: 1024
          modem_id: 3-1
        - sims:
          - sim_id: 1
            data:
              tx: 1024
              rx: 1024
          - sim_id: 1
            data:
              tx: 1024
              rx: 1024
          modem_id: 3-1
      properties:
        date:
          description: Date of entry.
          example: 2020-07-28
          type: string
        modems:
          items:
            $ref: '#/components/schemas/inline_response_200_35_modems'
          type: array
    inline_response_200_35:
      example:
        data:
        - date: 2020-07-28
          modems:
          - sims:
            - sim_id: 1
              data:
                tx: 1024
                rx: 1024
            - sim_id: 1
              data:
                tx: 1024
                rx: 1024
            modem_id: 3-1
          - sims:
            - sim_id: 1
              data:
                tx: 1024
                rx: 1024
            - sim_id: 1
              data:
                tx: 1024
                rx: 1024
            modem_id: 3-1
        - date: 2020-07-28
          modems:
          - sims:
            - sim_id: 1
              data:
                tx: 1024
                rx: 1024
            - sim_id: 1
              data:
                tx: 1024
                rx: 1024
            modem_id: 3-1
          - sims:
            - sim_id: 1
              data:
                tx: 1024
                rx: 1024
            - sim_id: 1
              data:
                tx: 1024
                rx: 1024
            modem_id: 3-1
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_35_data_1'
          type: array
    inline_response_200_36_data:
      example: '{status={offline=9, not_activated=2, online=5}, model={RUT950=7, TRB140=6,
        RUT200=3}, network_state={unknown=11, home=3, roaming=2}, wan_state={unknown=11,
        mobile=2, wifi=2, wired=1}, signal={excellent=2, average=1, low=1, no_signal=12},
        information_updated={more_than_1_week_ago=1, never_been_updated=15}, task={pending_firmware=4,
        no_pending_task=12, pending_configuration=1}, modem_model={HE910-D=1, ME909u-521=10,
        LE910-EU V2=5}, modem_manufacturer={man1=10, man2=2, unknown=4}, modem_firmware={N/A=5,
        EC20EQAR02A04E2G=10, unknown=1}, operator={Some operator=12, OPERATOR=4}}'
      properties:
        status:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        model:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        firmware:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        connection_type:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        connection_type_2:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        network_state:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        network_state_2:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        wan_state:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        signal:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        signal_2:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        information_updated:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        task:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        modem_model:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        modem_model_2:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        modem_manufacturer:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        modem_manufacturer_2:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        modem_firmware:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        modem_firmware_2:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        operator:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
        operator_2:
          additionalProperties:
            description: Property name is the key and value shows count.
            type: integer
          type: object
    inline_response_200_36:
      example:
        data: '{status={offline=9, not_activated=2, online=5}, model={RUT950=7, TRB140=6,
          RUT200=3}, network_state={unknown=11, home=3, roaming=2}, wan_state={unknown=11,
          mobile=2, wifi=2, wired=1}, signal={excellent=2, average=1, low=1, no_signal=12},
          information_updated={more_than_1_week_ago=1, never_been_updated=15}, task={pending_firmware=4,
          no_pending_task=12, pending_configuration=1}, modem_model={HE910-D=1, ME909u-521=10,
          LE910-EU V2=5}, modem_manufacturer={man1=10, man2=2, unknown=4}, modem_firmware={N/A=5,
          EC20EQAR02A04E2G=10, unknown=1}, operator={Some operator=12, OPERATOR=4}}'
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_36_data'
    inline_response_200_37_data:
      example:
        company_id: 1
        updated_at: 2020-02-20 09:10:59
        name: Device
        description: s/n 1234567890, added at 2019-08-01 04:11:56
        model: rut
        ssid_names: ssid_names
        id: 1
        firmware: RUT9XX_R_00.02.566
        online_users: 0
        status: "1"
      properties:
        id:
          description: Device id
          example: 1
          type: integer
        model:
          description: Model name
          example: rut
          type: string
        company_id:
          description: Company id
          example: 1
          type: integer
        name:
          description: Device serial and mac as name
          example: Device
          type: string
        description:
          description: Device description
          example: s/n 1234567890, added at 2019-08-01 04:11:56
          type: string
        firmware:
          description: Device firmware
          example: RUT9XX_R_00.02.566
          type: string
        status:
          description: Device status
          example: "1"
          type: string
        online_users:
          description: Number of online users
          example: 0
          type: integer
        ssid_names:
          description: Service set identifier names
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_37:
      example:
        data:
        - company_id: 1
          updated_at: 2020-02-20 09:10:59
          name: Device
          description: s/n 1234567890, added at 2019-08-01 04:11:56
          model: rut
          ssid_names: ssid_names
          id: 1
          firmware: RUT9XX_R_00.02.566
          online_users: 0
          status: "1"
        - company_id: 1
          updated_at: 2020-02-20 09:10:59
          name: Device
          description: s/n 1234567890, added at 2019-08-01 04:11:56
          model: rut
          ssid_names: ssid_names
          id: 1
          firmware: RUT9XX_R_00.02.566
          online_users: 0
          status: "1"
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_37_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_38_data:
      example:
        auth_type: extrad
        updated_at: 2020-02-20 09:10:59
        id: 1
        ssid: MyWiFi
        online_users: 0
        status: true
        hotspot_ip: 0
        hotspot_index: hotspot_index
      properties:
        id:
          description: Hotspot id.
          example: 1
          type: integer
        status:
          description: Hotspot status.
          example: true
          type: boolean
        ssid:
          description: Service set identifier name.
          example: MyWiFi
          type: string
        hotspot_ip:
          description: Hotspot ip.
          type: integer
        online_users:
          description: Number of online users.
          example: 0
          type: integer
        auth_type:
          description: Auth type name.
          example: extrad
          type: string
        hotspot_index:
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_38:
      example:
        data:
        - auth_type: extrad
          updated_at: 2020-02-20 09:10:59
          id: 1
          ssid: MyWiFi
          online_users: 0
          status: true
          hotspot_ip: 0
          hotspot_index: hotspot_index
        - auth_type: extrad
          updated_at: 2020-02-20 09:10:59
          id: 1
          ssid: MyWiFi
          online_users: 0
          status: true
          hotspot_ip: 0
          hotspot_index: hotspot_index
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_38_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_39_hotspots_active_users:
      example:
        start_time: '2019-01-11 15:15:59 '
        download: 48.64 MB
        device_id: 12313
        updated_at: 2020-02-20 09:10:59
        use_time: 12:20:51
        upload: 171.93 MB
        ip: 192.168.2.205
        created_at: 1995-06-08 04:20:07
        id: 151415
        ssid: SomeSSID
        mac: 00:00:00:00:00:00
        username: UsernameX
      properties:
        id:
          description: Hot spot active user id
          example: 151415
          type: integer
        device_id:
          description: Device id
          example: 12313
          type: integer
        ssid:
          description: Service set identifier
          example: SomeSSID
          type: string
        username:
          description: User name
          example: UsernameX
          type: string
        mac:
          description: Device mac
          example: 00:00:00:00:00:00
          type: string
        ip:
          description: Device ip
          example: 192.168.2.205
          type: string
        start_time:
          description: Use start date and time
          example: '2019-01-11 15:15:59 '
          type: string
        use_time:
          description: Time of usage
          example: 12:20:51
          type: string
        download:
          description: Download quantity
          example: 48.64 MB
          type: string
        upload:
          description: Upload quantity
          example: 171.93 MB
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_39:
      example:
        code: 200
        hotspots_active_users:
        - start_time: '2019-01-11 15:15:59 '
          download: 48.64 MB
          device_id: 12313
          updated_at: 2020-02-20 09:10:59
          use_time: 12:20:51
          upload: 171.93 MB
          ip: 192.168.2.205
          created_at: 1995-06-08 04:20:07
          id: 151415
          ssid: SomeSSID
          mac: 00:00:00:00:00:00
          username: UsernameX
        - start_time: '2019-01-11 15:15:59 '
          download: 48.64 MB
          device_id: 12313
          updated_at: 2020-02-20 09:10:59
          use_time: 12:20:51
          upload: 171.93 MB
          ip: 192.168.2.205
          created_at: 1995-06-08 04:20:07
          id: 151415
          ssid: SomeSSID
          mac: 00:00:00:00:00:00
          username: UsernameX
      properties:
        code:
          description: Message code
          example: 200
          type: integer
        hotspots_active_users:
          items:
            $ref: '#/components/schemas/inline_response_200_39_hotspots_active_users'
          type: array
    inline_response_200_40_data:
      example:
        end_date: 2019-05-30
        period: day
        is_active: 0
        company_id: 1
        description: test
        created_at: 1995-06-08 04:20:07
        type: single
        applied_by: device
        updated_at: 2020-02-20 09:10:59
        generated_at: 2019-07-31
        company_name: Some_company_name
        name: Test
        id: 281
        parameters:
        - router_uptime
        - temperature
        - connection_uptime
        - connection_type
        - operator
        - data_usage
        - signal
        apply_list:
        - 1
        - 2
        start_date: 2019-04-30
        apply_list_names:
        - applied_company_name
        - applied_company_name
      properties:
        id:
          description: Report id.
          example: 281
          type: integer
        company_id:
          description: Company id.
          example: 1
          type: integer
        name:
          description: Report name.
          example: Test
          type: string
        description:
          description: Report description.
          example: test
          type: string
        type:
          description: Type of report.
          enum:
          - single
          - periodic
          type: string
        period:
          description: Period of report.
          enum:
          - day
          - week
          - month
          - custom
          type: string
        parameters:
          description: Selected report parameters
          example:
          - router_uptime
          - temperature
          - connection_uptime
          - connection_type
          - operator
          - data_usage
          - signal
          items:
            type: integer
          type: array
        applied_by:
          description: What report is applied to.
          enum:
          - device
          - company
          - tag
          type: string
        apply_list:
          description: List of items ids separated by comma.
          example:
          - 1
          - 2
          items:
            type: integer
          type: array
        is_active:
          description: Is report active.
          example: 0
          type: integer
        generated_at:
          description: Generation date.
          example: 2019-07-31
          type: string
        start_date:
          description: Report start date.
          example: 2019-04-30
          type: string
        end_date:
          description: Report end date.
          example: 2019-05-30
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
        company_name:
          description: Company name.
          example: Some_company_name
          type: string
        apply_list_names:
          description: Apply list names.
          items:
            example: applied_company_name
            type: string
          type: array
    inline_response_200_40:
      example:
        data:
        - end_date: 2019-05-30
          period: day
          is_active: 0
          company_id: 1
          description: test
          created_at: 1995-06-08 04:20:07
          type: single
          applied_by: device
          updated_at: 2020-02-20 09:10:59
          generated_at: 2019-07-31
          company_name: Some_company_name
          name: Test
          id: 281
          parameters:
          - router_uptime
          - temperature
          - connection_uptime
          - connection_type
          - operator
          - data_usage
          - signal
          apply_list:
          - 1
          - 2
          start_date: 2019-04-30
          apply_list_names:
          - applied_company_name
          - applied_company_name
        - end_date: 2019-05-30
          period: day
          is_active: 0
          company_id: 1
          description: test
          created_at: 1995-06-08 04:20:07
          type: single
          applied_by: device
          updated_at: 2020-02-20 09:10:59
          generated_at: 2019-07-31
          company_name: Some_company_name
          name: Test
          id: 281
          parameters:
          - router_uptime
          - temperature
          - connection_uptime
          - connection_type
          - operator
          - data_usage
          - signal
          apply_list:
          - 1
          - 2
          start_date: 2019-04-30
          apply_list_names:
          - applied_company_name
          - applied_company_name
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_40_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_41_data:
      example:
        report_template_name: Android test
        company_id: 1
        company_name: company
        name: Test
        description: test
        created_at: 1995-06-08 04:20:07
        id: 1
        report_template_id: 236
        type: single
      properties:
        id:
          description: Report id.
          example: 1
          type: integer
        name:
          description: Report name.
          example: Test
          type: string
        description:
          description: Report description.
          example: test
          type: string
        company_name:
          description: Company name.
          example: company
          type: string
        report_template_id:
          description: Report template id number.
          example: 236
          type: integer
        report_template_name:
          description: Report template name.
          example: Android test
          type: string
        type:
          description: Type of report.
          enum:
          - single
          - periodic
          type: string
        company_id:
          description: Company id.
          example: 1
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_41:
      example:
        data:
        - report_template_name: Android test
          company_id: 1
          company_name: company
          name: Test
          description: test
          created_at: 1995-06-08 04:20:07
          id: 1
          report_template_id: 236
          type: single
        - report_template_name: Android test
          company_id: 1
          company_name: company
          name: Test
          description: test
          created_at: 1995-06-08 04:20:07
          id: 1
          report_template_id: 236
          type: single
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_41_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_42_data_all_max_signal:
      description: Maximum signal
      example:
        serial: "1234567890"
        name: TheDevice
        router_id: 1
        value: 0
        mac: 00:00:00:00:00:00
      properties:
        mac:
          description: Mac number
          example: 00:00:00:00:00:00
          type: string
        name:
          description: Name of device
          example: TheDevice
          type: string
        value:
          description: Value
          type: integer
        serial:
          description: Serial number
          example: "1234567890"
          type: string
        router_id:
          description: Router id
          example: 1
          type: integer
    inline_response_200_42_data_all_min_signal:
      description: Minimum signal
      example:
        serial: "1234567890"
        name: TheDevice
        router_id: 1
        value: 6
        mac: 00:00:00:00:00:00
      properties:
        mac:
          description: Mac number
          example: 00:00:00:00:00:00
          type: string
        name:
          description: Name of device
          example: TheDevice
          type: string
        value:
          description: Value
          type: integer
        serial:
          description: Serial number
          example: "1234567890"
          type: string
        router_id:
          description: Router id
          example: 1
          type: integer
    inline_response_200_42_data_all_mobile_data:
      description: Mobile data statistics
      example:
        total: 1513882477
        received: 1449956779
        sent: 63925698
      properties:
        sent:
          description: Data sent quantity
          example: 63925698
          type: integer
        received:
          description: Data received quantity
          example: 1449956779
          type: integer
        total:
          description: Total data quantity
          example: 1513882477
          type: integer
    inline_response_200_42_data_all_average_values:
      description: Average values
      example:
        router_uptime: 523
        connection_uptime: 532
        temperature: 238
        signal: 1
      properties:
        signal:
          description: Average value of signal
          type: integer
        temperature:
          description: Average value of temperature
          example: 238
          type: integer
        router_uptime:
          description: Average value of router uptime
          example: 523
          type: integer
        connection_uptime:
          description: Average value of connection uptime
          example: 532
          type: integer
    inline_response_200_42_data_all_max_temperature:
      description: Maximum temperature
      example:
        serial: "1234567890"
        name: TheDevice
        router_id: 1
        value: 390
        mac: 00:00:00:00:00:00
      properties:
        mac:
          description: Mac number
          example: 00:00:00:00:00:00
          type: string
        name:
          description: Name of device
          example: TheDevice
          type: string
        value:
          description: Value
          example: 390
          type: integer
        serial:
          description: Serial number
          example: "1234567890"
          type: string
        router_id:
          description: Router id
          example: 1
          type: integer
    inline_response_200_42_data_all_min_temperature:
      description: Minimum temperature
      example:
        serial: "1234567890"
        name: TheDevice
        router_id: 1
        value: 220
        mac: 00:00:00:00:00:00
      properties:
        mac:
          description: Mac number
          example: 00:00:00:00:00:00
          type: string
        name:
          description: Name of device
          example: TheDevice
          type: string
        value:
          description: Value
          example: 220
          type: integer
        serial:
          description: Serial number
          example: "1234567890"
          type: string
        router_id:
          description: Router id
          example: 1
          type: integer
    inline_response_200_42_data_all_max_router_uptime:
      description: Maximum router uptime
      example:
        serial: "1234567890"
        name: TheDevice
        router_id: 1
        value: 111410784
        mac: 00:00:00:00:00:00
      properties:
        mac:
          description: Mac number
          example: 00:00:00:00:00:00
          type: string
        name:
          description: Name of device
          example: TheDevice
          type: string
        value:
          description: Value
          example: 111410784
          type: integer
        serial:
          description: Serial number
          example: "1234567890"
          type: string
        router_id:
          description: Router id
          example: 1
          type: integer
    inline_response_200_42_data_all_min_router_uptime:
      description: Minimum router uptime
      example:
        serial: "1234567890"
        name: TheDevice
        router_id: 1
        value: 111410784
        mac: 00:00:00:00:00:00
      properties:
        mac:
          description: Mac number
          example: 00:00:00:00:00:00
          type: string
        name:
          description: Name of device
          example: TheDevice
          type: string
        value:
          description: Value
          example: 111410784
          type: integer
        serial:
          description: Serial number
          example: "1234567890"
          type: string
        router_id:
          description: Router id
          example: 1
          type: integer
    inline_response_200_42_data_all_max_connection_uptime:
      description: Maximum connection uptime
      example:
        serial: "1234567890"
        name: TheDevice
        router_id: 1
        value: 111410784
        mac: 00:00:00:00:00:00
      properties:
        mac:
          description: Mac number
          example: 00:00:00:00:00:00
          type: string
        name:
          description: Name of device
          example: TheDevice
          type: string
        value:
          description: Value
          example: 111410784
          type: integer
        serial:
          description: Serial number
          example: "1234567890"
          type: string
        router_id:
          description: Router id
          example: 1
          type: integer
    inline_response_200_42_data_all_min_connection_uptime:
      description: Minimum connection uptime
      example:
        serial: "1234567890"
        name: TheDevice
        router_id: 1
        value: 111410784
        mac: 00:00:00:00:00:00
      properties:
        mac:
          description: Mac number
          example: 00:00:00:00:00:00
          type: string
        name:
          description: Name of device
          example: TheDevice
          type: string
        value:
          description: Value
          example: 111410784
          type: integer
        serial:
          description: Serial number
          example: "1234567890"
          type: string
        router_id:
          description: Router id
          example: 1
          type: integer
    inline_response_200_42_data_all:
      example:
        max_temperature:
          serial: "1234567890"
          name: TheDevice
          router_id: 1
          value: 390
          mac: 00:00:00:00:00:00
        average_values:
          router_uptime: 523
          connection_uptime: 532
          temperature: 238
          signal: 1
        min_connection_uptime:
          serial: "1234567890"
          name: TheDevice
          router_id: 1
          value: 111410784
          mac: 00:00:00:00:00:00
        max_signal:
          serial: "1234567890"
          name: TheDevice
          router_id: 1
          value: 0
          mac: 00:00:00:00:00:00
        min_router_uptime:
          serial: "1234567890"
          name: TheDevice
          router_id: 1
          value: 111410784
          mac: 00:00:00:00:00:00
        min_signal:
          serial: "1234567890"
          name: TheDevice
          router_id: 1
          value: 6
          mac: 00:00:00:00:00:00
        max_router_uptime:
          serial: "1234567890"
          name: TheDevice
          router_id: 1
          value: 111410784
          mac: 00:00:00:00:00:00
        mobile_data:
          total: 1513882477
          received: 1449956779
          sent: 63925698
        min_temperature:
          serial: "1234567890"
          name: TheDevice
          router_id: 1
          value: 220
          mac: 00:00:00:00:00:00
        max_connection_uptime:
          serial: "1234567890"
          name: TheDevice
          router_id: 1
          value: 111410784
          mac: 00:00:00:00:00:00
      properties:
        max_signal:
          $ref: '#/components/schemas/inline_response_200_42_data_all_max_signal'
        min_signal:
          $ref: '#/components/schemas/inline_response_200_42_data_all_min_signal'
        mobile_data:
          $ref: '#/components/schemas/inline_response_200_42_data_all_mobile_data'
        average_values:
          $ref: '#/components/schemas/inline_response_200_42_data_all_average_values'
        max_temperature:
          $ref: '#/components/schemas/inline_response_200_42_data_all_max_temperature'
        min_temperature:
          $ref: '#/components/schemas/inline_response_200_42_data_all_min_temperature'
        max_router_uptime:
          $ref: '#/components/schemas/inline_response_200_42_data_all_max_router_uptime'
        min_router_uptime:
          $ref: '#/components/schemas/inline_response_200_42_data_all_min_router_uptime'
        max_connection_uptime:
          $ref: '#/components/schemas/inline_response_200_42_data_all_max_connection_uptime'
        min_connection_uptime:
          $ref: '#/components/schemas/inline_response_200_42_data_all_min_connection_uptime'
    inline_response_200_42_data_params:
      example:
        end_date: end_date
        generation_date: 1547164804
        report_description: MY REPORT
        apply_to: device
        company: 1
        type: periodic
        report_name: MY REPORT
        parameters: 1,2,3,4,5,6,7
        period_type: day
        start_date: start_date
      properties:
        type:
          description: Type of report
          example: periodic
          type: string
        company:
          description: id of company
          example: 1
          type: integer
        apply_to:
          description: What report applies to
          example: device
          type: string
        end_date:
          type: string
        parameters:
          description: Parameters separated by comma
          example: 1,2,3,4,5,6,7
          type: string
        start_date:
          type: string
        period_type:
          description: Report period type
          example: day
          type: string
        report_name:
          description: Name of report
          example: MY REPORT
          type: string
        generation_date:
          description: Report date of generation in integer value
          example: 1547164804
          type: integer
        report_description:
          description: Description of report
          example: MY REPORT
          type: string
    inline_response_200_42_data_devices:
      example:
        max_temperature: 390
        connection_type: LTE
        sent_sim1: 5
        sent_sim2: 5
        max_signal: 9
        connection_uptime: 111392229
        min_signal: 3
        received: 1449956779
        sent: 639225698
        mac: 00:00:00:00:00:00
        operator: EE
        min_temperature: 220
        serial: "1234567890"
        router_uptime: 111410784
        name: TheDevice
        received_sim1: 2
        received_sim2: 7
        router_id: 1
      properties:
        mac:
          description: Mac number
          example: 00:00:00:00:00:00
          type: string
        name:
          description: Name of device
          example: TheDevice
          type: string
        sent:
          description: Quantity of sent data
          example: 639225698
          type: integer
        serial:
          description: Serial number of device
          example: "1234567890"
          type: string
        operator:
          description: Operator
          example: EE
          type: string
        received:
          description: Quantity of received data
          example: 1449956779
          type: integer
        router_id:
          description: Router id
          example: 1
          type: integer
        sent_sim1:
          type: integer
        sent_sim2:
          type: integer
        received_sim1:
          type: integer
        received_sim2:
          type: integer
        max_signal:
          description: Max signal strength
          type: integer
        min_signal:
          description: Min signal strength
          type: integer
        router_uptime:
          description: Router uptime in seconds
          example: 111410784
          type: integer
        connection_type:
          description: Type of connection
          example: LTE
          type: string
        max_temperature:
          description: Max temperature
          example: 390
          type: integer
        min_temperature:
          description: Min temperature
          example: 220
          type: integer
        connection_uptime:
          description: Connection uptime in seconds
          example: 111392229
          type: integer
    inline_response_200_42_data_operator_stats:
      example:
        name: EE
        value: 100
      properties:
        name:
          description: Operator name
          example: EE
          type: string
        value:
          description: Value
          example: 100
          type: integer
    inline_response_200_42_data_connection_type_stats:
      example:
        name: LTE
        value: 100
      properties:
        name:
          description: Connection type name
          example: LTE
          type: string
        value:
          description: Value
          example: 100
          type: integer
    inline_response_200_42_data:
      example:
        all:
          max_temperature:
            serial: "1234567890"
            name: TheDevice
            router_id: 1
            value: 390
            mac: 00:00:00:00:00:00
          average_values:
            router_uptime: 523
            connection_uptime: 532
            temperature: 238
            signal: 1
          min_connection_uptime:
            serial: "1234567890"
            name: TheDevice
            router_id: 1
            value: 111410784
            mac: 00:00:00:00:00:00
          max_signal:
            serial: "1234567890"
            name: TheDevice
            router_id: 1
            value: 0
            mac: 00:00:00:00:00:00
          min_router_uptime:
            serial: "1234567890"
            name: TheDevice
            router_id: 1
            value: 111410784
            mac: 00:00:00:00:00:00
          min_signal:
            serial: "1234567890"
            name: TheDevice
            router_id: 1
            value: 6
            mac: 00:00:00:00:00:00
          max_router_uptime:
            serial: "1234567890"
            name: TheDevice
            router_id: 1
            value: 111410784
            mac: 00:00:00:00:00:00
          mobile_data:
            total: 1513882477
            received: 1449956779
            sent: 63925698
          min_temperature:
            serial: "1234567890"
            name: TheDevice
            router_id: 1
            value: 220
            mac: 00:00:00:00:00:00
          max_connection_uptime:
            serial: "1234567890"
            name: TheDevice
            router_id: 1
            value: 111410784
            mac: 00:00:00:00:00:00
        devices:
        - max_temperature: 390
          connection_type: LTE
          sent_sim1: 5
          sent_sim2: 5
          max_signal: 9
          connection_uptime: 111392229
          min_signal: 3
          received: 1449956779
          sent: 639225698
          mac: 00:00:00:00:00:00
          operator: EE
          min_temperature: 220
          serial: "1234567890"
          router_uptime: 111410784
          name: TheDevice
          received_sim1: 2
          received_sim2: 7
          router_id: 1
        - max_temperature: 390
          connection_type: LTE
          sent_sim1: 5
          sent_sim2: 5
          max_signal: 9
          connection_uptime: 111392229
          min_signal: 3
          received: 1449956779
          sent: 639225698
          mac: 00:00:00:00:00:00
          operator: EE
          min_temperature: 220
          serial: "1234567890"
          router_uptime: 111410784
          name: TheDevice
          received_sim1: 2
          received_sim2: 7
          router_id: 1
        operator_stats:
        - name: EE
          value: 100
        - name: EE
          value: 100
        connection_type_stats:
        - name: LTE
          value: 100
        - name: LTE
          value: 100
        params:
          end_date: end_date
          generation_date: 1547164804
          report_description: MY REPORT
          apply_to: device
          company: 1
          type: periodic
          report_name: MY REPORT
          parameters: 1,2,3,4,5,6,7
          period_type: day
          start_date: start_date
      properties:
        all:
          $ref: '#/components/schemas/inline_response_200_42_data_all'
        params:
          $ref: '#/components/schemas/inline_response_200_42_data_params'
        devices:
          items:
            $ref: '#/components/schemas/inline_response_200_42_data_devices'
          type: array
        operator_stats:
          items:
            $ref: '#/components/schemas/inline_response_200_42_data_operator_stats'
          type: array
        connection_type_stats:
          items:
            $ref: '#/components/schemas/inline_response_200_42_data_connection_type_stats'
          type: array
    inline_response_200_42_meta:
      example:
        max_router_uptime: 00:00:00:00:00:00
        max_connection_uptime: 00:00:00:00:00:00
      properties:
        max_router_uptime:
          description: Router mac which had max uptime.
          example: 00:00:00:00:00:00
          type: string
        max_connection_uptime:
          description: Router mac which had max connection uptime.
          example: 00:00:00:00:00:00
          type: string
    inline_response_200_42:
      example:
        data:
          all:
            max_temperature:
              serial: "1234567890"
              name: TheDevice
              router_id: 1
              value: 390
              mac: 00:00:00:00:00:00
            average_values:
              router_uptime: 523
              connection_uptime: 532
              temperature: 238
              signal: 1
            min_connection_uptime:
              serial: "1234567890"
              name: TheDevice
              router_id: 1
              value: 111410784
              mac: 00:00:00:00:00:00
            max_signal:
              serial: "1234567890"
              name: TheDevice
              router_id: 1
              value: 0
              mac: 00:00:00:00:00:00
            min_router_uptime:
              serial: "1234567890"
              name: TheDevice
              router_id: 1
              value: 111410784
              mac: 00:00:00:00:00:00
            min_signal:
              serial: "1234567890"
              name: TheDevice
              router_id: 1
              value: 6
              mac: 00:00:00:00:00:00
            max_router_uptime:
              serial: "1234567890"
              name: TheDevice
              router_id: 1
              value: 111410784
              mac: 00:00:00:00:00:00
            mobile_data:
              total: 1513882477
              received: 1449956779
              sent: 63925698
            min_temperature:
              serial: "1234567890"
              name: TheDevice
              router_id: 1
              value: 220
              mac: 00:00:00:00:00:00
            max_connection_uptime:
              serial: "1234567890"
              name: TheDevice
              router_id: 1
              value: 111410784
              mac: 00:00:00:00:00:00
          devices:
          - max_temperature: 390
            connection_type: LTE
            sent_sim1: 5
            sent_sim2: 5
            max_signal: 9
            connection_uptime: 111392229
            min_signal: 3
            received: 1449956779
            sent: 639225698
            mac: 00:00:00:00:00:00
            operator: EE
            min_temperature: 220
            serial: "1234567890"
            router_uptime: 111410784
            name: TheDevice
            received_sim1: 2
            received_sim2: 7
            router_id: 1
          - max_temperature: 390
            connection_type: LTE
            sent_sim1: 5
            sent_sim2: 5
            max_signal: 9
            connection_uptime: 111392229
            min_signal: 3
            received: 1449956779
            sent: 639225698
            mac: 00:00:00:00:00:00
            operator: EE
            min_temperature: 220
            serial: "1234567890"
            router_uptime: 111410784
            name: TheDevice
            received_sim1: 2
            received_sim2: 7
            router_id: 1
          operator_stats:
          - name: EE
            value: 100
          - name: EE
            value: 100
          connection_type_stats:
          - name: LTE
            value: 100
          - name: LTE
            value: 100
          params:
            end_date: end_date
            generation_date: 1547164804
            report_description: MY REPORT
            apply_to: device
            company: 1
            type: periodic
            report_name: MY REPORT
            parameters: 1,2,3,4,5,6,7
            period_type: day
            start_date: start_date
        success: true
        meta:
          max_router_uptime: 00:00:00:00:00:00
          max_connection_uptime: 00:00:00:00:00:00
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_42_data'
        meta:
          $ref: '#/components/schemas/inline_response_200_42_meta'
    inline_response_200_43_data:
      example:
        parent_company_name: Company3000
        company_id: 6960
        credit_left: 2
        credit_reserved: 0
        credit_price: 0
        credit_type: free
        deleted_at: 2012-12-12 12:12:12
        credit_type_name: management_10y
        assigned_at: '2019-07-12 08:43:49 '
        company_name: Company4000
        credit_type_id: 6
        credit_count: 5
        expire_at: 2021-07-12
        id: 2568
      properties:
        id:
          description: Credit id.
          example: 2568
          type: integer
        company_id:
          description: Company id.
          example: 6960
          type: integer
        credit_type:
          description: Type of credit.
          enum:
          - free
          - paid
          example: free
          type: string
        credit_type_name:
          description: Credit type name.
          enum:
          - credit
          - management_5y
          - management_10y
          - data_150GB_10y
          example: management_10y
          type: string
        credit_type_id:
          description: Credit type id.
          example: 6
          type: integer
        credit_price:
          description: Credit price.
          example: 0
          type: number
        credit_count:
          description: Credit count.
          example: 5
          type: integer
        credit_left:
          description: Number of credits left.
          example: 2
          type: integer
        credit_reserved:
          description: Number of credits reserved.
          example: 0
          type: integer
        expire_at:
          description: Date at which credits expires.
          example: 2021-07-12
          type: string
        assigned_at:
          description: Date and time at which credits was assigned.
          example: '2019-07-12 08:43:49 '
          type: string
        company_name:
          description: Name of the company.
          example: Company4000
          type: string
        parent_company_name:
          description: Name of the parent company.
          example: Company3000
          type: string
        deleted_at:
          description: Timestamp of entry's deletion.
          example: 2012-12-12 12:12:12
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_43:
      example:
        data:
        - parent_company_name: Company3000
          company_id: 6960
          credit_left: 2
          credit_reserved: 0
          credit_price: 0
          credit_type: free
          deleted_at: 2012-12-12 12:12:12
          credit_type_name: management_10y
          assigned_at: '2019-07-12 08:43:49 '
          company_name: Company4000
          credit_type_id: 6
          credit_count: 5
          expire_at: 2021-07-12
          id: 2568
        - parent_company_name: Company3000
          company_id: 6960
          credit_left: 2
          credit_reserved: 0
          credit_price: 0
          credit_type: free
          deleted_at: 2012-12-12 12:12:12
          credit_type_name: management_10y
          assigned_at: '2019-07-12 08:43:49 '
          company_name: Company4000
          credit_type_id: 6
          credit_count: 5
          expire_at: 2021-07-12
          id: 2568
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_43_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_44_data_credits_left:
      example:
        payment_type: free
        credits_left: 2036
        credit_type_name: Free Credit
        credit_type_id: 2
        credit_type: credit
      properties:
        credit_type_id:
          description: Credit type id
          example: 2
          type: integer
        credit_type:
          description: Type of credit
          enum:
          - credit
          - management_5y
          - management_10y
          - data_150GB_10y
          example: credit
          type: string
        credits_left:
          description: Number of credits left
          example: 2036
          type: integer
        credit_type_name:
          description: Credit type title
          example: Free Credit
          type: string
        payment_type:
          description: Credit payment type.
          enum:
          - free
          - paid
          example: free
          type: string
    inline_response_200_44_data_credits_total:
      example:
        credits_count: 2036
        credit_type: credit
      properties:
        credit_type:
          description: Type of credit
          enum:
          - credit
          - management_5y
          - management_10y
          - data_150GB_10y
          example: credit
          type: string
        credits_count:
          description: Number of credits total
          example: 2036
          type: integer
    inline_response_200_44_data_credits:
      example:
        total:
        - credits_count: 2036
          credit_type: credit
        - credits_count: 2036
          credit_type: credit
        left:
        - payment_type: free
          credits_left: 2036
          credit_type_name: Free Credit
          credit_type_id: 2
          credit_type: credit
        - payment_type: free
          credits_left: 2036
          credit_type_name: Free Credit
          credit_type_id: 2
          credit_type: credit
      properties:
        left:
          description: Stats of credits
          items:
            $ref: '#/components/schemas/inline_response_200_44_data_credits_left'
          type: array
        total:
          items:
            $ref: '#/components/schemas/inline_response_200_44_data_credits_total'
          type: array
    inline_response_200_44_data_monitored_device:
      example:
        total: 6
        monitored: 0
      properties:
        monitored:
          type: integer
        total:
          type: integer
    inline_response_200_44_data:
      example:
        credits:
          total:
          - credits_count: 2036
            credit_type: credit
          - credits_count: 2036
            credit_type: credit
          left:
          - payment_type: free
            credits_left: 2036
            credit_type_name: Free Credit
            credit_type_id: 2
            credit_type: credit
          - payment_type: free
            credits_left: 2036
            credit_type_name: Free Credit
            credit_type_id: 2
            credit_type: credit
        credit_coverage: ' 2021-05-24 00:00:00 '
        monitored_device:
          total: 6
          monitored: 0
      properties:
        credits:
          $ref: '#/components/schemas/inline_response_200_44_data_credits'
        monitored_device:
          $ref: '#/components/schemas/inline_response_200_44_data_monitored_device'
        credit_coverage:
          description: Date till it is possible to monitor devices.
          example: ' 2021-05-24 00:00:00 '
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_44:
      example:
        data:
          credits:
            total:
            - credits_count: 2036
              credit_type: credit
            - credits_count: 2036
              credit_type: credit
            left:
            - payment_type: free
              credits_left: 2036
              credit_type_name: Free Credit
              credit_type_id: 2
              credit_type: credit
            - payment_type: free
              credits_left: 2036
              credit_type_name: Free Credit
              credit_type_id: 2
              credit_type: credit
          credit_coverage: ' 2021-05-24 00:00:00 '
          monitored_device:
            total: 6
            monitored: 0
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_44_data'
    inline_response_200_45_data:
      example:
        user_id: 2252
        serial: "1234567890"
        action_type: 3
        created_at: 1995-06-08 04:20:07
        company: Company
        user: user.name
        mac: 00:00:00:00:00:00
      properties:
        user_id:
          description: User id.
          example: 2252
          type: integer
        company:
          description: Company name.
          example: Company
          type: string
        user:
          description: Username.
          example: user.name
          type: string
        serial:
          description: Device serial number.
          example: "1234567890"
          type: string
        mac:
          description: Device mac number.
          example: 00:00:00:00:00:00
          type: string
        action_type:
          description: Action type.
          example: 3
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_45:
      example:
        data:
        - user_id: 2252
          serial: "1234567890"
          action_type: 3
          created_at: 1995-06-08 04:20:07
          company: Company
          user: user.name
          mac: 00:00:00:00:00:00
        - user_id: 2252
          serial: "1234567890"
          action_type: 3
          created_at: 1995-06-08 04:20:07
          company: Company
          user: user.name
          mac: 00:00:00:00:00:00
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_45_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_46_data:
      example:
        to_company: Company2
        user_id: 2252
        count: 3
        from_company: Company1
        created_at: 1995-06-08 04:20:07
        user: vardenis.pavardenis
      properties:
        user_id:
          description: User id.
          example: 2252
          type: integer
        from_company:
          description: Company name from which credits were moved.
          example: Company1
          type: string
        to_company:
          description: Company name to which credits were moved.
          example: Company2
          type: string
        user:
          description: Username of user who moved.
          example: vardenis.pavardenis
          type: string
        count:
          description: Number of credits moved.
          example: 3
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_46:
      example:
        data:
        - to_company: Company2
          user_id: 2252
          count: 3
          from_company: Company1
          created_at: 1995-06-08 04:20:07
          user: vardenis.pavardenis
        - to_company: Company2
          user_id: 2252
          count: 3
          from_company: Company1
          created_at: 1995-06-08 04:20:07
          user: vardenis.pavardenis
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_46_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_47_data_totals:
      description: Object of total values.
      example:
        child_company_credits: 10
        child_pools: 10
        data_purchase: 10
        credits_for_devices: 10
        pool_logs: 10
        transfer_codes_credits: 10
      properties:
        child_pools:
          description: Total number of child pools
          example: 10
          type: integer
        child_company_credits:
          description: Total number of child company credits.
          example: 10
          type: integer
        pool_logs:
          description: Total number of credit log records.
          example: 10
          type: integer
        credits_for_devices:
          description: Total number of credits used by devices.
          example: 10
          type: integer
        transfer_codes_credits:
          description: Total number of credits used by transfer codes.
          example: 10
          type: integer
        data_purchase:
          description: Total number of credits used to purchase data.
          example: 10
          type: integer
    inline_response_200_47_data_child_pools:
      example:
        company_name: Example company
        count: 8
        to_company_id: 5
      properties:
        count:
          description: Number of credits.
          example: 8
          type: integer
        to_company_id:
          description: Id of company that credits were moved to.
          example: 5
          type: integer
        company_name:
          description: Name of company that credits were moved to.
          example: Example company
          type: string
    inline_response_200_47_data_pool_logs:
      example:
        device_mac: 00:1E:42:04:1D:D6
        device_serial: "1098343541"
        action_id: 3
        action: Credit used
        created_at: 2019-07-12 08:43:49
        pool_id: 15
        username: user123
      properties:
        device_mac:
          description: Device mac.
          example: 00:1E:42:04:1D:D6
          type: string
        device_serial:
          description: Device serial.
          example: "1098343541"
          type: string
        pool_id:
          description: Id of a credit pool.
          example: 15
          type: integer
        action:
          description: Name of action.
          example: Credit used
          type: string
        action_id:
          description: Id of action.
          example: 3
          type: integer
        created_at:
          description: Date and time at which log was created.
          example: 2019-07-12 08:43:49
          type: string
        username:
          description: User username.
          example: user123
          type: string
    inline_response_200_47_data_transfer_codes:
      example:
        pool_amount: 10
        used_by_company_id: 6
        amount: 2
        code: n4qdywfh0zmd13i7j2apr98xkv5gl3c6
        created_at: 2019-07-12 08:43:49
        is_used: 1
      properties:
        amount:
          description: Number of credits taken from pool.
          example: 2
          type: integer
        pool_amount:
          description: Transfer code credits.
          example: 10
          type: integer
        code:
          description: Transfer code.
          example: n4qdywfh0zmd13i7j2apr98xkv5gl3c6
          type: string
        is_used:
          description: Value for setting if code was used or not.
          example: 1
          type: integer
        used_by_company_id:
          description: Company id that used a code.
          example: 6
          type: integer
        created_at:
          description: Date and time at which code was created.
          example: 2019-07-12 08:43:49
          type: string
    inline_response_200_47_data_data_purchase:
      example:
        bytes_purchased: 4294967296
        from_pool_id: 30
        company_id: 50
        user_id: 4
        created_at: 2019-07-12 08:43:49
        id: 1
        credits_used: 2
      properties:
        id:
          description: Id of a record.
          example: 1
          type: integer
        bytes_purchased:
          description: Number of bytes purchased.
          example: 4294967296
          type: integer
        credits_used:
          description: Number of credits used to purchase data.
          example: 2
          type: integer
        from_pool_id:
          description: From which pool id credits were taken from.
          example: 30
          type: integer
        company_id:
          description: Company id that received data.
          example: 50
          type: integer
        user_id:
          description: User id that purchased data.
          example: 4
          type: integer
        created_at:
          description: Date and time at which code was created.
          example: 2019-07-12 08:43:49
          type: string
    inline_response_200_47_data:
      example:
        child_pools:
        - company_name: Example company
          count: 8
          to_company_id: 5
        - company_name: Example company
          count: 8
          to_company_id: 5
        data_purchase:
        - bytes_purchased: 4294967296
          from_pool_id: 30
          company_id: 50
          user_id: 4
          created_at: 2019-07-12 08:43:49
          id: 1
          credits_used: 2
        - bytes_purchased: 4294967296
          from_pool_id: 30
          company_id: 50
          user_id: 4
          created_at: 2019-07-12 08:43:49
          id: 1
          credits_used: 2
        totals:
          child_company_credits: 10
          child_pools: 10
          data_purchase: 10
          credits_for_devices: 10
          pool_logs: 10
          transfer_codes_credits: 10
        pool_logs:
        - device_mac: 00:1E:42:04:1D:D6
          device_serial: "1098343541"
          action_id: 3
          action: Credit used
          created_at: 2019-07-12 08:43:49
          pool_id: 15
          username: user123
        - device_mac: 00:1E:42:04:1D:D6
          device_serial: "1098343541"
          action_id: 3
          action: Credit used
          created_at: 2019-07-12 08:43:49
          pool_id: 15
          username: user123
        transfer_codes:
        - pool_amount: 10
          used_by_company_id: 6
          amount: 2
          code: n4qdywfh0zmd13i7j2apr98xkv5gl3c6
          created_at: 2019-07-12 08:43:49
          is_used: 1
        - pool_amount: 10
          used_by_company_id: 6
          amount: 2
          code: n4qdywfh0zmd13i7j2apr98xkv5gl3c6
          created_at: 2019-07-12 08:43:49
          is_used: 1
      properties:
        totals:
          $ref: '#/components/schemas/inline_response_200_47_data_totals'
        child_pools:
          items:
            $ref: '#/components/schemas/inline_response_200_47_data_child_pools'
          type: array
        pool_logs:
          items:
            $ref: '#/components/schemas/inline_response_200_47_data_pool_logs'
          type: array
        transfer_codes:
          items:
            $ref: '#/components/schemas/inline_response_200_47_data_transfer_codes'
          type: array
        data_purchase:
          items:
            $ref: '#/components/schemas/inline_response_200_47_data_data_purchase'
          type: array
    inline_response_200_47:
      example:
        data:
          child_pools:
          - company_name: Example company
            count: 8
            to_company_id: 5
          - company_name: Example company
            count: 8
            to_company_id: 5
          data_purchase:
          - bytes_purchased: 4294967296
            from_pool_id: 30
            company_id: 50
            user_id: 4
            created_at: 2019-07-12 08:43:49
            id: 1
            credits_used: 2
          - bytes_purchased: 4294967296
            from_pool_id: 30
            company_id: 50
            user_id: 4
            created_at: 2019-07-12 08:43:49
            id: 1
            credits_used: 2
          totals:
            child_company_credits: 10
            child_pools: 10
            data_purchase: 10
            credits_for_devices: 10
            pool_logs: 10
            transfer_codes_credits: 10
          pool_logs:
          - device_mac: 00:1E:42:04:1D:D6
            device_serial: "1098343541"
            action_id: 3
            action: Credit used
            created_at: 2019-07-12 08:43:49
            pool_id: 15
            username: user123
          - device_mac: 00:1E:42:04:1D:D6
            device_serial: "1098343541"
            action_id: 3
            action: Credit used
            created_at: 2019-07-12 08:43:49
            pool_id: 15
            username: user123
          transfer_codes:
          - pool_amount: 10
            used_by_company_id: 6
            amount: 2
            code: n4qdywfh0zmd13i7j2apr98xkv5gl3c6
            created_at: 2019-07-12 08:43:49
            is_used: 1
          - pool_amount: 10
            used_by_company_id: 6
            amount: 2
            code: n4qdywfh0zmd13i7j2apr98xkv5gl3c6
            created_at: 2019-07-12 08:43:49
            is_used: 1
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_47_data'
    inline_response_200_48_data:
      example:
        credits_amount: 1
        used_by_company_id: 3917
        code: ly0f38erw5otka1sq497dimb2pu6jvhg
        company_id: 3917
        used_by_company_name: Company_name
        created_at: 1995-06-08 04:20:07
        credit_type: credit
        is_used: true
        activated_at: '2019-01-04 14:59:52 '
        used_by_user_id: 0
        company_name: Company_name
        comment: Example comment
        id: 27
        email: email
      properties:
        id:
          description: Token id.
          example: 27
          type: integer
        company_id:
          description: Company id.
          example: 3917
          type: integer
        email:
          type: string
        code:
          description: Identifier code.
          example: ly0f38erw5otka1sq497dimb2pu6jvhg
          type: string
        credits_amount:
          description: Amount of credits.
          example: 1
          type: integer
        is_used:
          description: Is token used.
          example: true
          type: boolean
        used_by_company_id:
          description: Company id that uses this token.
          example: 3917
          type: integer
        credit_type:
          description: Credit type name.
          example: credit
          type: string
        used_by_company_name:
          description: Company name that uses this token.
          example: Company_name
          type: string
        comment:
          description: Comment.
          example: Example comment
          type: string
        company_name:
          description: Name of company
          example: Company_name
          type: string
        used_by_user_id:
          type: integer
        activated_at:
          description: Activation date and time.
          example: '2019-01-04 14:59:52 '
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_48:
      example:
        data:
        - credits_amount: 1
          used_by_company_id: 3917
          code: ly0f38erw5otka1sq497dimb2pu6jvhg
          company_id: 3917
          used_by_company_name: Company_name
          created_at: 1995-06-08 04:20:07
          credit_type: credit
          is_used: true
          activated_at: '2019-01-04 14:59:52 '
          used_by_user_id: 0
          company_name: Company_name
          comment: Example comment
          id: 27
          email: email
        - credits_amount: 1
          used_by_company_id: 3917
          code: ly0f38erw5otka1sq497dimb2pu6jvhg
          company_id: 3917
          used_by_company_name: Company_name
          created_at: 1995-06-08 04:20:07
          credit_type: credit
          is_used: true
          activated_at: '2019-01-04 14:59:52 '
          used_by_user_id: 0
          company_name: Company_name
          comment: Example comment
          id: 27
          email: email
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_48_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_201_2_meta:
      example:
        credit_code: mw1fhkscebo8nv9yuz3xgj5rt2p4dq0a
      properties:
        credit_code:
          description: Credit code.
          example: mw1fhkscebo8nv9yuz3xgj5rt2p4dq0a
          type: string
    inline_response_201_2:
      example:
        success: true
        meta:
          credit_code: mw1fhkscebo8nv9yuz3xgj5rt2p4dq0a
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        meta:
          $ref: '#/components/schemas/inline_response_201_2_meta'
    inline_response_200_49_data:
      example:
        licence_price: 5.962134
        license_type_id: 6
        licence_count: 5
        licence_left: 2
        company_id: 6960
        created_at: 1995-06-08 04:20:07
        deleted_at: 2012-12-12 12:12:12
        pro_form_nr: pro_form_nr
        licence_type: licence_type
        parent_pool_id_company_name: parent_pool_id_company_name
        updated_at: 2020-02-20 09:10:59
        user_id: 7777
        licence_reserved: 7
        buy_date: buy_date
        expire_at: expire_at
        id: 2568
        validity: 1
        parent_pool_id: 0
      properties:
        id:
          description: Credit id.
          example: 2568
          type: integer
        company_id:
          description: Company id.
          example: 6960
          type: integer
        user_id:
          description: User id.
          example: 7777
          type: integer
        parent_pool_id:
          type: integer
        parent_pool_id_company_name:
          type: string
        license_type_id:
          type: integer
        validity:
          type: integer
        licence_type:
          type: string
        licence_price:
          format: float
          type: number
        pro_form_nr:
          type: string
        licence_count:
          type: integer
        licence_left:
          type: integer
        licence_reserved:
          type: integer
        buy_date:
          type: string
        expire_at:
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
        deleted_at:
          description: Timestamp of entry's deletion.
          example: 2012-12-12 12:12:12
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_49_meta:
      example:
        amount: 5
      properties:
        amount:
          description: Licences amount
          example: 5
          type: integer
    inline_response_200_49:
      example:
        data:
        - licence_price: 5.962134
          license_type_id: 6
          licence_count: 5
          licence_left: 2
          company_id: 6960
          created_at: 1995-06-08 04:20:07
          deleted_at: 2012-12-12 12:12:12
          pro_form_nr: pro_form_nr
          licence_type: licence_type
          parent_pool_id_company_name: parent_pool_id_company_name
          updated_at: 2020-02-20 09:10:59
          user_id: 7777
          licence_reserved: 7
          buy_date: buy_date
          expire_at: expire_at
          id: 2568
          validity: 1
          parent_pool_id: 0
        - licence_price: 5.962134
          license_type_id: 6
          licence_count: 5
          licence_left: 2
          company_id: 6960
          created_at: 1995-06-08 04:20:07
          deleted_at: 2012-12-12 12:12:12
          pro_form_nr: pro_form_nr
          licence_type: licence_type
          parent_pool_id_company_name: parent_pool_id_company_name
          updated_at: 2020-02-20 09:10:59
          user_id: 7777
          licence_reserved: 7
          buy_date: buy_date
          expire_at: expire_at
          id: 2568
          validity: 1
          parent_pool_id: 0
        success: true
        meta:
          amount: 5
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_49_data'
          type: array
        meta:
          $ref: '#/components/schemas/inline_response_200_49_meta'
    inline_response_200_50_data:
      example:
        alert_subtype: Signal strength dropped below -75 dBm
        alert_type_id: 3
        company_id: 6626
        device_id: 47432
        alert_subtype_id: 9
        created_at: 1995-06-08 04:20:07
        id: 900
        message: Router name - SOME_NAME; Event type - Status change; Event text -
          Online to Offline; Time stamp - 2019-01-28 23-16-21;
        alert_type: Status change
      properties:
        id:
          description: Alert id.
          example: 900
          type: integer
        company_id:
          description: Company id.
          example: 6626
          type: integer
        device_id:
          description: Device id.
          example: 47432
          type: integer
        message:
          description: Alert message.
          example: Router name - SOME_NAME; Event type - Status change; Event text
            - Online to Offline; Time stamp - 2019-01-28 23-16-21;
          type: string
        alert_type:
          description: Alert type name.
          example: Status change
          type: string
        alert_subtype:
          description: Alert sub type name.
          example: Signal strength dropped below -75 dBm
          type: string
        alert_type_id:
          description: Alert type id.
          example: 3
          type: integer
        alert_subtype_id:
          description: Alert sub type id.
          example: 9
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_50:
      example:
        data:
        - alert_subtype: Signal strength dropped below -75 dBm
          alert_type_id: 3
          company_id: 6626
          device_id: 47432
          alert_subtype_id: 9
          created_at: 1995-06-08 04:20:07
          id: 900
          message: Router name - SOME_NAME; Event type - Status change; Event text
            - Online to Offline; Time stamp - 2019-01-28 23-16-21;
          alert_type: Status change
        - alert_subtype: Signal strength dropped below -75 dBm
          alert_type_id: 3
          company_id: 6626
          device_id: 47432
          alert_subtype_id: 9
          created_at: 1995-06-08 04:20:07
          id: 900
          message: Router name - SOME_NAME; Event type - Status change; Event text
            - Online to Offline; Time stamp - 2019-01-28 23-16-21;
          alert_type: Status change
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_50_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_51_data:
      example:
        alerts_configs_id: 36
        device_id: 47432
        created_at: 1995-06-08 04:20:07
        id: 900
        message: Router name - UP-000857; Event type - Status change; Event text -
          Online to Offline; Time stamp - 2019-01-28 23-16-21;
      properties:
        id:
          description: Alert id.
          example: 900
          type: integer
        alerts_configs_id:
          description: Alert configuration id.
          example: 36
          type: integer
        device_id:
          description: Device id.
          example: 47432
          type: integer
        message:
          description: Alert message.
          example: Router name - UP-000857; Event type - Status change; Event text
            - Online to Offline; Time stamp - 2019-01-28 23-16-21;
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_51:
      example:
        data:
        - alerts_configs_id: 36
          device_id: 47432
          created_at: 1995-06-08 04:20:07
          id: 900
          message: Router name - UP-000857; Event type - Status change; Event text
            - Online to Offline; Time stamp - 2019-01-28 23-16-21;
        - alerts_configs_id: 36
          device_id: 47432
          created_at: 1995-06-08 04:20:07
          id: 900
          message: Router name - UP-000857; Event type - Status change; Event text
            - Online to Offline; Time stamp - 2019-01-28 23-16-21;
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_51_data'
          type: array
    inline_response_200_52_data:
      example:
        alert_type_id: 3
        device_id: 47432
        receiver: vardenis.pavardenis@mail.com
        subtype: Signal strength dropped below -75 dBm
        user_id: 1547
        enable: true
        alert_subtype_id: 9
        created_at: 1995-06-08 04:20:07
        id: 900
        message: Router name - %rn; Event type - %et; Event text - %ex; Time stamp
          - %ts; 222222
        type: Status change
      properties:
        id:
          description: Alert id.
          example: 900
          type: integer
        device_id:
          description: Device id.
          example: 47432
          type: integer
        receiver:
          description: Receiver information.
          example: vardenis.pavardenis@mail.com
          type: string
        message:
          description: Alert message.
          example: Router name - %rn; Event type - %et; Event text - %ex; Time stamp
            - %ts; 222222
          type: string
        enable:
          description: Is enabled.
          example: true
          type: boolean
        type:
          description: Alert type name.
          example: Status change
          type: string
        subtype:
          description: Alert sub type name.
          example: Signal strength dropped below -75 dBm
          type: string
        user_id:
          description: User id.
          example: 1547
          minimum: 1
          type: integer
        alert_type_id:
          description: Alert type id.
          example: 3
          type: integer
        alert_subtype_id:
          description: Alert sub type id.
          example: 9
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_52:
      example:
        data:
        - alert_type_id: 3
          device_id: 47432
          receiver: vardenis.pavardenis@mail.com
          subtype: Signal strength dropped below -75 dBm
          user_id: 1547
          enable: true
          alert_subtype_id: 9
          created_at: 1995-06-08 04:20:07
          id: 900
          message: Router name - %rn; Event type - %et; Event text - %ex; Time stamp
            - %ts; 222222
          type: Status change
        - alert_type_id: 3
          device_id: 47432
          receiver: vardenis.pavardenis@mail.com
          subtype: Signal strength dropped below -75 dBm
          user_id: 1547
          enable: true
          alert_subtype_id: 9
          created_at: 1995-06-08 04:20:07
          id: 900
          message: Router name - %rn; Event type - %et; Event text - %ex; Time stamp
            - %ts; 222222
          type: Status change
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_52_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_53_data:
      example:
        email_to: john.doe@mail.com
        alert_type_id: 1
        redundancy_interval: 2
        device_id: 78880
        company_id: 4200
        email_type: true
        subject: Test
        alert_subtype_id: 1
        smtp_config_id: "1"
        created_at: 1995-06-08 04:20:07
        message: Some text
        type: web
        redundancy_enable: true
        updated_at: 2020-02-20 09:10:59
        user_id: 5
        enable: true
        id: 10
      properties:
        id:
          description: Alert configuration id.
          example: 10
          type: integer
        device_id:
          description: Id of device that this alert configuration belongs to.
          example: 78880
          type: integer
        company_id:
          description: Id of company that this alert configuration belongs to.
          example: 4200
          type: integer
        alert_type_id:
          description: Alert type id.
          example: 1
          type: integer
        alert_subtype_id:
          description: Alert subtype id.
          example: 1
          type: integer
        smtp_config_id:
          description: Smtp config id.
          example: "1"
          type: string
        email_to:
          description: Email address that will receive alert.
          example: john.doe@mail.com
          type: string
        subject:
          description: Email's subject.
          example: Test
          type: string
        message:
          description: Message text of alert.
          example: Some text
          type: string
        email_type:
          description: Is alert email type.
          example: true
          type: boolean
        enable:
          description: Is enabled.
          example: true
          type: boolean
        redundancy_enable:
          description: Is redundancy protection enabled.
          example: true
          type: boolean
        redundancy_interval:
          description: Interval in minutes of redundancy.
          example: 2
          type: integer
        type:
          description: Type.
          example: web
          type: string
        user_id:
          description: User id.
          example: 5
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_53:
      example:
        data:
          email_to: john.doe@mail.com
          alert_type_id: 1
          redundancy_interval: 2
          device_id: 78880
          company_id: 4200
          email_type: true
          subject: Test
          alert_subtype_id: 1
          smtp_config_id: "1"
          created_at: 1995-06-08 04:20:07
          message: Some text
          type: web
          redundancy_enable: true
          updated_at: 2020-02-20 09:10:59
          user_id: 5
          enable: true
          id: 10
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_53_data'
    inline_response_200_54_data:
      example:
        port: 587
        name: '@teltonika.lt'
        host: sslo-ovh.net
        created_at: 1995-06-08 04:20:07
        id: 1
        email: example.mail@teltonika.lt
        username: example.username
      properties:
        id:
          description: Email configuration id.
          example: 1
          type: integer
        email:
          description: Email address used by configuration.
          example: example.mail@teltonika.lt
          type: string
        name:
          description: Name of email.
          example: '@teltonika.lt'
          type: string
        host:
          description: Host.
          example: sslo-ovh.net
          type: string
        port:
          description: Port number.
          example: 587
          type: integer
        username:
          description: Username.
          example: example.username
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_54:
      example:
        data:
        - port: 587
          name: '@teltonika.lt'
          host: sslo-ovh.net
          created_at: 1995-06-08 04:20:07
          id: 1
          email: example.mail@teltonika.lt
          username: example.username
        - port: 587
          name: '@teltonika.lt'
          host: sslo-ovh.net
          created_at: 1995-06-08 04:20:07
          id: 1
          email: example.mail@teltonika.lt
          username: example.username
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: List of email configurations.
          items:
            $ref: '#/components/schemas/inline_response_200_54_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_55_data:
      example:
        device_id: 7788
        company_id: 7788
        device_model: RUT955
        company_name: Company
        name: RUT9XX_R_00.06.00_WEBUI.bin
        description: Good device
        created_at: 1995-06-08 04:20:07
        id: 1506
        type: firmware
        version: RUT9XX_R_00.06.00
        file_size: 11272218
      properties:
        id:
          description: File id.
          example: 1506
          type: integer
        device_id:
          description: Device id.
          example: 7788
          type: integer
        company_id:
          description: File company id.
          example: 7788
          type: integer
        description:
          description: Description of device.
          example: Good device
          type: string
        device_model:
          description: Device model name.
          example: RUT955
          type: string
        version:
          description: Files firmware version.
          example: RUT9XX_R_00.06.00
          type: string
        company_name:
          description: Name of company.
          example: Company
          type: string
        file_size:
          description: File size in kb.
          example: 11272218
          type: integer
        type:
          description: File type.
          enum:
          - config
          - custom_file
          - device_task_manager_file
          - eventslog
          - firmware
          - global_firmware
          - periodic_backup
          - troubleshoot
          example: firmware
          type: string
        name:
          description: Name of file.
          example: RUT9XX_R_00.06.00_WEBUI.bin
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_55:
      example:
        data:
        - device_id: 7788
          company_id: 7788
          device_model: RUT955
          company_name: Company
          name: RUT9XX_R_00.06.00_WEBUI.bin
          description: Good device
          created_at: 1995-06-08 04:20:07
          id: 1506
          type: firmware
          version: RUT9XX_R_00.06.00
          file_size: 11272218
        - device_id: 7788
          company_id: 7788
          device_model: RUT955
          company_name: Company
          name: RUT9XX_R_00.06.00_WEBUI.bin
          description: Good device
          created_at: 1995-06-08 04:20:07
          id: 1506
          type: firmware
          version: RUT9XX_R_00.06.00
          file_size: 11272218
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_55_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_56_meta:
      example:
        id: 10
      properties:
        id:
          description: id of uploaded file
          example: 10
          type: integer
    inline_response_200_56:
      example:
        success: true
        meta:
          id: 10
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        meta:
          $ref: '#/components/schemas/inline_response_200_56_meta'
    inline_response_200_57:
      example:
        data:
          device_id: 7788
          company_id: 7788
          device_model: RUT955
          company_name: Company
          name: RUT9XX_R_00.06.00_WEBUI.bin
          description: Good device
          created_at: 1995-06-08 04:20:07
          id: 1506
          type: firmware
          version: RUT9XX_R_00.06.00
          file_size: 11272218
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_55_data'
    inline_response_200_58_data:
      example:
        name: Rutixas
        description: s/n 1101620981, added at 2019-11-11
        created_at: 1995-06-08 04:20:07
        model: model
        received: "0"
        id: 76783
        clients_count: "0"
        firmware: Some_firmware.fw
        sent: "0"
        status: "1"
      properties:
        id:
          description: Id of device.
          example: 76783
          type: integer
        name:
          description: Device name.
          example: Rutixas
          type: string
        model:
          type: string
        description:
          description: Device description.
          example: s/n 1101620981, added at 2019-11-11
          type: string
        firmware:
          description: Firmware.
          example: Some_firmware.fw
          type: string
        received:
          description: Sum of received data.
          example: "0"
          type: string
        status:
          description: Status of device.
          example: "1"
          type: string
        sent:
          description: Sum of sent data.
          example: "0"
          type: string
        clients_count:
          description: Count of clients.
          example: "0"
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_58:
      example:
        data:
        - name: Rutixas
          description: s/n 1101620981, added at 2019-11-11
          created_at: 1995-06-08 04:20:07
          model: model
          received: "0"
          id: 76783
          clients_count: "0"
          firmware: Some_firmware.fw
          sent: "0"
          status: "1"
        - name: Rutixas
          description: s/n 1101620981, added at 2019-11-11
          created_at: 1995-06-08 04:20:07
          model: model
          received: "0"
          id: 76783
          clients_count: "0"
          firmware: Some_firmware.fw
          sent: "0"
          status: "1"
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_58_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_59_data:
      example:
        wlan_id: hotspot2
        device_id: 76783
        updated_at: 2020-02-20 09:10:59
        active: 0
        received: 56923
        id: 2336547
        clients_count: 0
        ssid: RUT955_02DB1
        sent: 176014
      properties:
        id:
          description: Id of entry.
          example: 2336547
          type: integer
        device_id:
          description: Id of device.
          example: 76783
          type: integer
        wlan_id:
          description: Wlan id.
          example: hotspot2
          type: string
        ssid:
          description: Service Set IDentifier.
          example: RUT955_02DB1
          type: string
        active:
          description: Active count.
          example: 0
          type: integer
        received:
          description: Sum of received data.
          example: 56923
          type: integer
        sent:
          description: Sum of sent data.
          example: 176014
          type: integer
        clients_count:
          description: Count of clients.
          example: 0
          type: integer
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_59:
      example:
        data:
        - wlan_id: hotspot2
          device_id: 76783
          updated_at: 2020-02-20 09:10:59
          active: 0
          received: 56923
          id: 2336547
          clients_count: 0
          ssid: RUT955_02DB1
          sent: 176014
        - wlan_id: hotspot2
          device_id: 76783
          updated_at: 2020-02-20 09:10:59
          active: 0
          received: 56923
          id: 2336547
          clients_count: 0
          ssid: RUT955_02DB1
          sent: 176014
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_59_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_60_hotspot1:
      example:
        created_at: 1995-06-08 04:20:07
        interval: interval
        received: 2759556
        clients_count: 0
        sent: 15126297
      properties:
        interval:
          type: string
        clients_count:
          description: Count of clients.
          example: 0
          type: integer
        received:
          description: Received data.
          example: 2759556
          type: integer
        sent:
          description: Sent data.
          example: 15126297
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_60_data:
      example:
        hotspot1:
        - created_at: 1995-06-08 04:20:07
          interval: interval
          received: 2759556
          clients_count: 0
          sent: 15126297
        - created_at: 1995-06-08 04:20:07
          interval: interval
          received: 2759556
          clients_count: 0
          sent: 15126297
      properties:
        hotspot1:
          description: Name of this property is wlan id.
          items:
            $ref: '#/components/schemas/inline_response_200_60_hotspot1'
          type: array
    inline_response_200_60:
      example:
        data:
        - hotspot1:
          - created_at: 1995-06-08 04:20:07
            interval: interval
            received: 2759556
            clients_count: 0
            sent: 15126297
          - created_at: 1995-06-08 04:20:07
            interval: interval
            received: 2759556
            clients_count: 0
            sent: 15126297
        - hotspot1:
          - created_at: 1995-06-08 04:20:07
            interval: interval
            received: 2759556
            clients_count: 0
            sent: 15126297
          - created_at: 1995-06-08 04:20:07
            interval: interval
            received: 2759556
            clients_count: 0
            sent: 15126297
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_60_data'
          type: array
    inline_response_200_61_data:
      example:
        file: file
        acceptable_codes:
        - 0
        - 0
        file_id: 6
        command: command
        target_path: target_path
      properties:
        command:
          type: string
        acceptable_codes:
          items:
            type: integer
          type: array
        file_id:
          type: integer
        target_path:
          type: string
        file:
          type: string
    inline_response_200_61_data_1:
      example:
        company_id: 61
        data:
          file: file
          acceptable_codes:
          - 0
          - 0
          file_id: 6
          command: command
          target_path: target_path
        updated_at: 2020-02-20 09:10:59
        group_name: Device task group
        group_id: 10
        stop_on_failure: true
        name: The task
        created_at: 1995-06-08 04:20:07
        id: 41
        type: command
        timeout: 15
        order: 61
      properties:
        id:
          description: Device task id.
          example: 41
          type: integer
        group_name:
          description: Device task group name.
          example: Device task group
          type: string
        group_id:
          description: Device task group id.
          example: 10
          type: integer
        company_id:
          description: Device task company's id.
          example: 61
          type: integer
        order:
          description: Device task order in group.
          example: 61
          type: integer
        type:
          description: Device task type.
          example: command
          type: string
        name:
          description: Device task name.
          example: The task
          type: string
        data:
          $ref: '#/components/schemas/inline_response_200_61_data'
        timeout:
          description: Task timeout in seconds.
          example: 15
          type: integer
        stop_on_failure:
          description: Indicates if task will stop on failure.
          example: true
          type: boolean
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_61:
      example:
        data:
        - company_id: 61
          data:
            file: file
            acceptable_codes:
            - 0
            - 0
            file_id: 6
            command: command
            target_path: target_path
          updated_at: 2020-02-20 09:10:59
          group_name: Device task group
          group_id: 10
          stop_on_failure: true
          name: The task
          created_at: 1995-06-08 04:20:07
          id: 41
          type: command
          timeout: 15
          order: 61
        - company_id: 61
          data:
            file: file
            acceptable_codes:
            - 0
            - 0
            file_id: 6
            command: command
            target_path: target_path
          updated_at: 2020-02-20 09:10:59
          group_name: Device task group
          group_id: 10
          stop_on_failure: true
          name: The task
          created_at: 1995-06-08 04:20:07
          id: 41
          type: command
          timeout: 15
          order: 61
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_61_data_1'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_62_data:
      example:
        company_id: 61
        updated_at: 2020-02-20 09:10:59
        name: Device task group
        created_at: 1995-06-08 04:20:07
        id: 41
      properties:
        id:
          description: Device task id.
          example: 41
          type: integer
        name:
          description: Device task group name.
          example: Device task group
          type: string
        company_id:
          description: Device task company's id.
          example: 61
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_62:
      example:
        data:
        - company_id: 61
          updated_at: 2020-02-20 09:10:59
          name: Device task group
          created_at: 1995-06-08 04:20:07
          id: 41
        - company_id: 61
          updated_at: 2020-02-20 09:10:59
          name: Device task group
          created_at: 1995-06-08 04:20:07
          id: 41
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_62_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_63:
      example:
        data:
          company_id: 61
          updated_at: 2020-02-20 09:10:59
          name: Device task group
          created_at: 1995-06-08 04:20:07
          id: 41
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_62_data'
    inline_response_200_64_data:
      example:
        result: '{}'
        data: '{}'
        name: The task
        created_at: 1995-06-08 04:20:07
        group_log_name: Device task group log
        id: 41
        type: command
        group_log_id: 10
      properties:
        id:
          description: Device task id.
          example: 41
          type: integer
        group_log_name:
          description: Device task group log name.
          example: Device task group log
          type: string
        group_log_id:
          description: Device task group id.
          example: 10
          type: integer
        type:
          description: Device task type.
          enum:
          - command
          - upload_file
          - download_file
          example: command
          type: string
        name:
          description: Device task name.
          example: The task
          type: string
        data:
          description: Device task's used object.
          type: object
        result:
          description: Device task result
          type: object
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_64:
      example:
        data:
        - result: '{}'
          data: '{}'
          name: The task
          created_at: 1995-06-08 04:20:07
          group_log_name: Device task group log
          id: 41
          type: command
          group_log_id: 10
        - result: '{}'
          data: '{}'
          name: The task
          created_at: 1995-06-08 04:20:07
          group_log_name: Device task group log
          id: 41
          type: command
          group_log_id: 10
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_64_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_65_data:
      example:
        result: '{}'
        data: '{}'
        name: The task
        created_at: 1995-06-08 04:20:07
        group_log_name: Device task group log
        id: 41
        type: command
        group_log_id: 10
      properties:
        id:
          description: Device task id.
          example: 41
          type: integer
        group_log_name:
          description: Device task group log name.
          example: Device task group log
          type: string
        group_log_id:
          description: Device task group id.
          example: 10
          type: integer
        type:
          description: Device task type.
          example: command
          type: string
        name:
          description: Device task name.
          example: The task
          type: string
        data:
          description: Device task's used object.
          type: object
        result:
          description: Device task result
          type: object
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_65:
      example:
        data:
          result: '{}'
          data: '{}'
          name: The task
          created_at: 1995-06-08 04:20:07
          group_log_name: Device task group log
          id: 41
          type: command
          group_log_id: 10
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_65_data'
    inline_response_200_66_data:
      example:
        device_id: 10
        name: Device task group log
        created_at: 1995-06-08 04:20:07
        id: 41
        status: completed
      properties:
        id:
          description: Device task id.
          example: 41
          type: integer
        device_id:
          description: Device that executed this group id.
          example: 10
          type: integer
        name:
          description: Device task group log name.
          example: Device task group log
          type: string
        status:
          description: Status of this group log.
          enum:
          - processing
          - completed
          - failed
          example: completed
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_66:
      example:
        data:
        - device_id: 10
          name: Device task group log
          created_at: 1995-06-08 04:20:07
          id: 41
          status: completed
        - device_id: 10
          name: Device task group log
          created_at: 1995-06-08 04:20:07
          id: 41
          status: completed
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_66_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_67:
      example:
        data:
          device_id: 10
          name: Device task group log
          created_at: 1995-06-08 04:20:07
          id: 41
          status: completed
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_66_data'
    inline_response_200_68:
      example:
        data:
        - permissions_count: 56
          company_id: 55
          updated_at: 2000-01-23T04:56:07.000+00:00
          company_name: Company name
          name: name
          description: Admin role can do anything.
          created_at: 2000-01-23T04:56:07.000+00:00
          id: 70810
          title: Admin role
        - permissions_count: 56
          company_id: 55
          updated_at: 2000-01-23T04:56:07.000+00:00
          company_name: Company name
          name: name
          description: Admin role can do anything.
          created_at: 2000-01-23T04:56:07.000+00:00
          id: 70810
          title: Admin role
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/role_body'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_69:
      example:
        data:
          permissions_count: 56
          company_id: 55
          updated_at: 2000-01-23T04:56:07.000+00:00
          company_name: Company name
          name: name
          description: Admin role can do anything.
          created_at: 2000-01-23T04:56:07.000+00:00
          id: 70810
          title: Admin role
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/role_body'
    inline_response_200_70:
      example:
        data:
        - name: view_devices
          description: description
          created_at: 2000-01-23T04:56:07.000+00:00
          id: 70810
          title: Allows to view devices
          category: Devices
        - name: view_devices
          description: description
          created_at: 2000-01-23T04:56:07.000+00:00
          id: 70810
          title: Allows to view devices
          category: Devices
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/permission_body'
          type: array
    inline_response_200_71_data:
      example:
        data: 123456789
        company_id: 1234567890
        user_id: 2252
        created_at: 1995-06-08 04:20:07
        company: Company
        user: random.user
        credits_used: 10
        email: random.user@email.com
      properties:
        user_id:
          description: Record id.
          example: 2252
          type: integer
        data:
          description: Data in bytes.
          example: 123456789
          type: integer
        credits_used:
          description: Number of credits used.
          example: 10
          type: integer
        company_id:
          description: Id of a company.
          example: 1234567890
          type: integer
        company:
          description: Name of a company.
          example: Company
          type: string
        user:
          description: Username of a user.
          example: random.user
          type: string
        email:
          description: Email of a user.
          example: random.user@email.com
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_71:
      example:
        data:
        - data: 123456789
          company_id: 1234567890
          user_id: 2252
          created_at: 1995-06-08 04:20:07
          company: Company
          user: random.user
          credits_used: 10
          email: random.user@email.com
        - data: 123456789
          company_id: 1234567890
          user_id: 2252
          created_at: 1995-06-08 04:20:07
          company: Company
          user: random.user
          credits_used: 10
          email: random.user@email.com
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_71_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_72_data:
      example:
        company_id: 1
        end_time: 7
        description: Description
        created_at: 1995-06-08 04:20:07
        server_crt_expire_at: 2024-02-20 09:10:59
        quick_hub: 0
        enabled: 0
        tags:
        - company_id: 430
          updated_at: 2020-02-20 09:10:59
          user_id: 4
          name: The tag
          description: Good tag
          created_at: 1995-06-08 04:20:07
          id: 11
        - company_id: 430
          updated_at: 2020-02-20 09:10:59
          user_id: 4
          name: The tag
          description: Good tag
          created_at: 1995-06-08 04:20:07
          id: 11
        start_time: 2
        bytes_used: 34123342
        disabled_on_company_data_used: 6
        ca_crt_expire_at: 2024-02-20 09:10:59
        updated_at: 2020-02-20 09:10:59
        port: 0
        disabled_because_expired: 5
        company_name: 0
        name: VPN hub name
        disabled_for_inactive_without_users: 5
        id: 1
        disabled_for_inactive: 1
      properties:
        id:
          description: Id of hub.
          example: 1
          type: integer
        name:
          description: VPN hub name.
          example: VPN hub name
          type: string
        quick_hub:
          description: Shows if hub is quick vpn hub.
          type: integer
        description:
          description: VPN hub description.
          example: Description
          type: string
        bytes_used:
          example: 34123342
          type: integer
        enabled:
          description: Sum of received data.
          example: 0
          type: integer
        company_id:
          description: VPN hub company id.
          example: 1
          type: integer
        company_name:
          description: VPN hub company name.
          example: 0
          type: integer
        port:
          example: 0
          type: integer
        disabled_on_company_data_used:
          type: integer
        disabled_for_inactive:
          type: integer
        disabled_for_inactive_without_users:
          type: integer
        disabled_because_expired:
          type: integer
        start_time:
          type: integer
        end_time:
          type: integer
        ca_crt_expire_at:
          description: The expiration date of the VPN hub certificate.
          example: 2024-02-20 09:10:59
          nullable: true
          pattern: Y-m-d H:i:s
          type: string
        server_crt_expire_at:
          description: The expiration date of the server certificate.
          example: 2024-02-20 09:10:59
          nullable: true
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        tags:
          description: Tags list.
          items:
            $ref: '#/components/schemas/inline_response_200_11_data_tags'
          type: array
    inline_response_200_72:
      example:
        data:
        - company_id: 1
          end_time: 7
          description: Description
          created_at: 1995-06-08 04:20:07
          server_crt_expire_at: 2024-02-20 09:10:59
          quick_hub: 0
          enabled: 0
          tags:
          - company_id: 430
            updated_at: 2020-02-20 09:10:59
            user_id: 4
            name: The tag
            description: Good tag
            created_at: 1995-06-08 04:20:07
            id: 11
          - company_id: 430
            updated_at: 2020-02-20 09:10:59
            user_id: 4
            name: The tag
            description: Good tag
            created_at: 1995-06-08 04:20:07
            id: 11
          start_time: 2
          bytes_used: 34123342
          disabled_on_company_data_used: 6
          ca_crt_expire_at: 2024-02-20 09:10:59
          updated_at: 2020-02-20 09:10:59
          port: 0
          disabled_because_expired: 5
          company_name: 0
          name: VPN hub name
          disabled_for_inactive_without_users: 5
          id: 1
          disabled_for_inactive: 1
        - company_id: 1
          end_time: 7
          description: Description
          created_at: 1995-06-08 04:20:07
          server_crt_expire_at: 2024-02-20 09:10:59
          quick_hub: 0
          enabled: 0
          tags:
          - company_id: 430
            updated_at: 2020-02-20 09:10:59
            user_id: 4
            name: The tag
            description: Good tag
            created_at: 1995-06-08 04:20:07
            id: 11
          - company_id: 430
            updated_at: 2020-02-20 09:10:59
            user_id: 4
            name: The tag
            description: Good tag
            created_at: 1995-06-08 04:20:07
            id: 11
          start_time: 2
          bytes_used: 34123342
          disabled_on_company_data_used: 6
          ca_crt_expire_at: 2024-02-20 09:10:59
          updated_at: 2020-02-20 09:10:59
          port: 0
          disabled_because_expired: 5
          company_name: 0
          name: VPN hub name
          disabled_for_inactive_without_users: 5
          id: 1
          disabled_for_inactive: 1
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_72_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_73_data:
      example:
        latitude: 6.0274563
        name: frankfurt
        id: 0
        visual_name: Germany
        longitude: 1.4658129
      properties:
        id:
          type: integer
        name:
          description: Vpn hub zone name.
          example: frankfurt
          type: string
        visual_name:
          description: Vpn hub zone visual name.
          example: Germany
          type: string
        latitude:
          format: float
          type: number
        longitude:
          format: float
          type: number
    inline_response_200_73:
      example:
        data:
        - latitude: 6.0274563
          name: frankfurt
          id: 0
          visual_name: Germany
          longitude: 1.4658129
        - latitude: 6.0274563
          name: frankfurt
          id: 0
          visual_name: Germany
          longitude: 1.4658129
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_73_data'
          type: array
    inline_response_200_74_data:
      example:
        vpn_hub_id: 5
        company_id: 1
        ip: ip
        company_name: company_name
        name: name
        model: model
        id: 1
        is_facelift: 5
        type: type
        object_id: 0
        enabled: 6
        status: 2
      properties:
        id:
          description: Id of hub user.
          example: 1
          type: integer
        name:
          type: string
        type:
          type: string
        object_id:
          type: integer
        ip:
          type: string
        enabled:
          type: integer
        company_id:
          type: integer
        company_name:
          type: string
        vpn_hub_id:
          type: integer
        model:
          type: string
        is_facelift:
          type: integer
        status:
          type: integer
    inline_response_200_74:
      example:
        data:
        - vpn_hub_id: 5
          company_id: 1
          ip: ip
          company_name: company_name
          name: name
          model: model
          id: 1
          is_facelift: 5
          type: type
          object_id: 0
          enabled: 6
          status: 2
        - vpn_hub_id: 5
          company_id: 1
          ip: ip
          company_name: company_name
          name: name
          model: model
          id: 1
          is_facelift: 5
          type: type
          object_id: 0
          enabled: 6
          status: 2
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_74_data'
          type: array
    inline_response_200_75_data:
      example:
        hub_id: 0
        netmask: 1.1.1.1
        ip: 1.1.1.1
        name: name
        created_at: 1995-06-08 04:20:07
        id: 1
      properties:
        id:
          description: Id of route.
          example: 1
          type: integer
        name:
          description: Route name.
          type: string
        hub_id:
          description: ID of hub.
          type: integer
        ip:
          description: IP address.
          example: 1.1.1.1
          type: string
        netmask:
          description: Netmask.
          example: 1.1.1.1
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_75:
      example:
        data:
        - hub_id: 0
          netmask: 1.1.1.1
          ip: 1.1.1.1
          name: name
          created_at: 1995-06-08 04:20:07
          id: 1
        - hub_id: 0
          netmask: 1.1.1.1
          ip: 1.1.1.1
          name: name
          created_at: 1995-06-08 04:20:07
          id: 1
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_75_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_76_data:
      example:
        hub_id: 1
        session_bytes_received: 1234
        session_bytes_send: 1234
        created_at: 1995-06-08 04:20:07
        total_data_used: 1234
      properties:
        hub_id:
          description: Id of hub.
          example: 1
          type: integer
        session_bytes_send:
          description: Session bytes send.
          example: 1234
          type: integer
        session_bytes_received:
          description: Session bytes received.
          example: 1234
          type: integer
        total_data_used:
          description: Total data usage.
          example: 1234
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_76:
      example:
        data:
        - hub_id: 1
          session_bytes_received: 1234
          session_bytes_send: 1234
          created_at: 1995-06-08 04:20:07
          total_data_used: 1234
        - hub_id: 1
          session_bytes_received: 1234
          session_bytes_send: 1234
          created_at: 1995-06-08 04:20:07
          total_data_used: 1234
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_76_data'
          type: array
    inline_response_200_77_data:
      example:
        vpn_hub_id: 1
        ip: 1.1.1.1
        name: name
        vpn_user_id: 1234
        connected_at: 1995-06-08 04:20:07
        type: type
        visual_name: visual_name
      properties:
        vpn_hub_id:
          description: Id of hub.
          example: 1
          type: integer
        vpn_user_id:
          description: Id of user.
          example: 1234
          type: integer
        name:
          description: Name.
          type: string
        visual_name:
          description: Visual name.
          type: string
        ip:
          description: IP address.
          example: 1.1.1.1
          type: string
        type:
          description: Type.
          type: string
        connected_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_77:
      example:
        data:
        - vpn_hub_id: 1
          ip: 1.1.1.1
          name: name
          vpn_user_id: 1234
          connected_at: 1995-06-08 04:20:07
          type: type
          visual_name: visual_name
        - vpn_hub_id: 1
          ip: 1.1.1.1
          name: name
          vpn_user_id: 1234
          connected_at: 1995-06-08 04:20:07
          type: type
          visual_name: visual_name
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        meta:
          $ref: '#/components/schemas/meta_total'
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_77_data'
          type: array
    inline_response_200_78_data:
      example:
        hub_id: 1
        session_bytes_received: 1234
        session_bytes_send: 1234
        created_at: 1995-06-08 04:20:07
      properties:
        hub_id:
          description: Id of hub.
          example: 1
          type: integer
        session_bytes_send:
          description: Session bytes send.
          example: 1234
          type: integer
        session_bytes_received:
          description: Session bytes received.
          example: 1234
          type: integer
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_78:
      example:
        data:
        - hub_id: 1
          session_bytes_received: 1234
          session_bytes_send: 1234
          created_at: 1995-06-08 04:20:07
        - hub_id: 1
          session_bytes_received: 1234
          session_bytes_send: 1234
          created_at: 1995-06-08 04:20:07
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_78_data'
          type: array
    inline_response_200_79:
      example:
        success: true
        url: url
      properties:
        url:
          description: URL of device API routes documentation in OpenAPI specification.
          type: string
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
    inline_response_200_80_data:
      example:
        template: template
        company_id: 1
        updated_at: 2020-02-20 09:10:59
        name: Authentication method
        created_at: 1995-06-08 04:20:07
        id: 1
        version: Authentication method
      properties:
        id:
          description: Parameter id
          example: 1
          type: integer
        company_id:
          description: Parameter id
          example: 1
          type: integer
        name:
          description: Parameter name
          example: Authentication method
          type: string
        version:
          description: Parameter name
          example: Authentication method
          type: string
        template:
          type: string
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    inline_response_200_80:
      example:
        data:
        - template: template
          company_id: 1
          updated_at: 2020-02-20 09:10:59
          name: Authentication method
          created_at: 1995-06-08 04:20:07
          id: 1
          version: Authentication method
        - template: template
          company_id: 1
          updated_at: 2020-02-20 09:10:59
          name: Authentication method
          created_at: 1995-06-08 04:20:07
          id: 1
          version: Authentication method
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: Array of data.
          items:
            $ref: '#/components/schemas/inline_response_200_80_data'
          type: array
    inline_response_200_81_data:
      example:
        response_code: 6
        device_id: 0
        method: method
        request_message: request_message
        created_at: 2000-01-23T04:56:07.000+00:00
        display_name: display_name
        duration: 1.4658129805029452
        additional_information: additional_information
        request_state: request_state
        route: route
        response_message: response_message
        execution_duration: 5.962133916683182
        updated_at: 2000-01-23T04:56:07.000+00:00
        action_name: action_name
        request_hidden: 5
        request_id: 2
      properties:
        device_id:
          description: The unique identifier of the device.
          type: integer
        action_name:
          description: The unique identifier of the action.
          type: string
        method:
          description: The HTTP method used for the request.
          type: string
        route:
          description: The route of the request.
          type: string
        request_message:
          description: The request message sent to the device.
          type: string
        response_message:
          description: The response message received from the device.
          type: string
        response_code:
          description: The HTTP status code of the response.
          type: integer
        request_state:
          description: The state of the request.
          type: string
        duration:
          description: The total duration of the request.
          type: number
        execution_duration:
          description: The execution duration of the request.
          type: number
        additional_information:
          description: Additional information about the request.
          type: string
        created_at:
          description: The timestamp when the request was created.
          format: date-time
          type: string
        updated_at:
          description: The timestamp when the request was last updated.
          format: date-time
          type: string
        display_name:
          description: The display name of the action.
          type: string
        request_hidden:
          type: integer
        request_id:
          description: The unique identifier of the request.
          type: integer
    inline_response_200_81:
      example:
        data:
        - response_code: 6
          device_id: 0
          method: method
          request_message: request_message
          created_at: 2000-01-23T04:56:07.000+00:00
          display_name: display_name
          duration: 1.4658129805029452
          additional_information: additional_information
          request_state: request_state
          route: route
          response_message: response_message
          execution_duration: 5.962133916683182
          updated_at: 2000-01-23T04:56:07.000+00:00
          action_name: action_name
          request_hidden: 5
          request_id: 2
        - response_code: 6
          device_id: 0
          method: method
          request_message: request_message
          created_at: 2000-01-23T04:56:07.000+00:00
          display_name: display_name
          duration: 1.4658129805029452
          additional_information: additional_information
          request_state: request_state
          route: route
          response_message: response_message
          execution_duration: 5.962133916683182
          updated_at: 2000-01-23T04:56:07.000+00:00
          action_name: action_name
          request_hidden: 5
          request_id: 2
      properties:
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_81_data'
          type: array
    inline_response_200_82_data:
      example:
        is_enabled: true
        is_running: true
        ip: ip
        name: name
        type: type
      properties:
        ip:
          description: The IP address of the device.
          type: string
        name:
          description: The name of the device.
          type: string
        type:
          description: The type of the device (e.g. server, client).
          type: string
        is_enabled:
          description: Indicates whether the device is enabled or not.
          type: boolean
        is_running:
          description: Indicates whether the device is running or not.
          type: boolean
    inline_response_200_82_data_1:
      example:
        device_id: 6
        data:
        - is_enabled: true
          is_running: true
          ip: ip
          name: name
          type: type
        - is_enabled: true
          is_running: true
          ip: ip
          name: name
          type: type
        updated_at: 2000-01-23T04:56:07.000+00:00
        id: 0
      properties:
        id:
          description: The unique identifier of the device.
          type: integer
        device_id:
          description: The unique identifier of the device in the system.
          type: integer
        data:
          description: An array of status information for the device.
          items:
            $ref: '#/components/schemas/inline_response_200_82_data'
          type: array
        updated_at:
          description: The date and time when the device information was last updated.
          format: date-time
          type: string
    inline_response_200_82:
      example:
        data:
        - device_id: 6
          data:
          - is_enabled: true
            is_running: true
            ip: ip
            name: name
            type: type
          - is_enabled: true
            is_running: true
            ip: ip
            name: name
            type: type
          updated_at: 2000-01-23T04:56:07.000+00:00
          id: 0
        - device_id: 6
          data:
          - is_enabled: true
            is_running: true
            ip: ip
            name: name
            type: type
          - is_enabled: true
            is_running: true
            ip: ip
            name: name
            type: type
          updated_at: 2000-01-23T04:56:07.000+00:00
          id: 0
        success: true
      properties:
        success:
          description: Indicates whether the request was successful or not.
          type: boolean
        data:
          description: An array of network devices and their status.
          items:
            $ref: '#/components/schemas/inline_response_200_82_data_1'
          type: array
    inline_response_200_83:
      example:
        data:
          devices_count: 5
          company_id: 10
          total_triggered_count: 6
          conditions_body_version: conditions_body_version
          delay_repetitions_count: 4
          cooldown_duration: 60
          description: Automation that does something.
          created_at: created_at
          data_group: data_group
          delay_enabled: true
          enabled: true
          active_devices_count: 2
          period_latest_reset: period_latest_reset
          period_trigger_limit: 5
          user_id: 0
          name: Test automation
          cooldown_enabled: true
          automation_version: automation_version
          id: 12
          period_triggered_count: 1
          conditions_body:
          - '{}'
          delay_duration: 60
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/automation_body'
    inline_response_200_84:
      example:
        data:
          evaluation_id: gaTqiZMFfFd9LYbHhylh
          device_name: RUT Device 1
          evaluated_parameters:
          - value: "35"
            key: temperature
          - value: "35"
            key: temperature
          company_id: 1534
          device_id: 7034
          evaluated_conditions:
          - value: true
            key: cond_0
          - value: true
            key: cond_0
          serial: "0000000000"
          company_name: Regular company
          overall_status: success
          created_at: 2000-01-23T04:56:07.000+00:00
          conditions_body:
          - '{}'
          mac: 00:00:00:00:00:00
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/automation_log_body'
    inline_response_200_85:
      example:
        data:
          evaluation_id: gaTqiZMFfFd9LYbHhylh
          company_id: 1534
          device_id: 7034
          overall_status: success
          created_at: 2000-01-23T04:56:07.000+00:00
          mac: 00:00:00:00:00:00
          device_name: RUT Device 1
          evaluated_parameters:
          - value: "35"
            key: temperature
          - value: "35"
            key: temperature
          action_status_message: Succeeded
          evaluated_conditions:
          - value: true
            key: cond_0
          - value: true
            key: cond_0
          serial: "0000000000"
          company_name: Regular company
          conditions:
          - '{}'
          action_status: 1
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/automation_log_evaluationId_body'
    inline_response_200_86:
      example:
        data:
          device_id: 7034
          total_triggered_count: 3012
          created_at: 2000-01-23T04:56:07.000+00:00
          enabled: false
          mac: 00:00:00:00:00:00
          automation_id: 5634
          period_latest_reset: 2000-01-23T04:56:07.000+00:00
          device_name: RUT Device 1
          period_trigger_limit: 25
          last_triggered_at: 2000-01-23T04:56:07.000+00:00
          serial: "0000000000"
          period_triggered_count: 58
          firmware: RUT9XX_R_00.06.05.3
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/device_body_2'
    inline_response_200_87_config_variables:
      example:
        filter: filter
        ref: ref
        transform: transform
        default: default
        id: id
        type: type
        enum:
        - enum
        - enum
      properties:
        id:
          description: The variable ID
          type: string
        ref:
          description: The reference path to data
          type: string
        enum:
          description: Optional list of allowed values (null if not applicable)
          items:
            type: string
          type: array
        type:
          description: The data type of the variable
          type: string
        filter:
          description: Optional filter to apply (can be null)
          nullable: true
          type: string
        transform:
          description: Optional transformation to apply (can be null)
          nullable: true
          type: string
        default:
          description: The default value for the variable (can be null)
          nullable: true
          type: string
    inline_response_200_87_config_query_parameters:
      example:
        value:
        - value
        - value
        key: key
      properties:
        key:
          description: The key of the query parameter
          type: string
        value:
          description: The values associated with the query parameter
          items:
            type: string
          type: array
    inline_response_200_87_config_data:
      example:
        query_parameters:
        - value:
          - value
          - value
          key: key
        - value:
          - value
          - value
          key: key
        variables:
        - filter: filter
          ref: ref
          transform: transform
          default: default
          id: id
          type: type
          enum:
          - enum
          - enum
        - filter: filter
          ref: ref
          transform: transform
          default: default
          id: id
          type: type
          enum:
          - enum
          - enum
        url_params:
          key:
          - url_params
          - url_params
        url: url
      properties:
        url:
          description: The URL pattern for the request
          type: string
        variables:
          description: Variables used in the URL
          items:
            $ref: '#/components/schemas/inline_response_200_87_config_variables'
          type: array
        url_params:
          additionalProperties:
            items:
              type: string
            type: array
          description: URL parameters
          type: object
        query_parameters:
          description: Query parameters associated with the URL
          items:
            $ref: '#/components/schemas/inline_response_200_87_config_query_parameters'
          type: array
    inline_response_200_87_config:
      description: Configuration details of the data collect
      example:
        data:
        - query_parameters:
          - value:
            - value
            - value
            key: key
          - value:
            - value
            - value
            key: key
          variables:
          - filter: filter
            ref: ref
            transform: transform
            default: default
            id: id
            type: type
            enum:
            - enum
            - enum
          - filter: filter
            ref: ref
            transform: transform
            default: default
            id: id
            type: type
            enum:
            - enum
            - enum
          url_params:
            key:
            - url_params
            - url_params
          url: url
        - query_parameters:
          - value:
            - value
            - value
            key: key
          - value:
            - value
            - value
            key: key
          variables:
          - filter: filter
            ref: ref
            transform: transform
            default: default
            id: id
            type: type
            enum:
            - enum
            - enum
          - filter: filter
            ref: ref
            transform: transform
            default: default
            id: id
            type: type
            enum:
            - enum
            - enum
          url_params:
            key:
            - url_params
            - url_params
          url: url
        name: name
        api_system: api_system
        description: description
        id: 1
        type: type
        api_version: api_version
        version: version
        device_documentation_id: 5
        retention: retention
        data_source: data_source
      properties:
        id:
          description: The unique identifier for the configuration
          type: integer
        data:
          description: Array of URLs and related variables
          items:
            $ref: '#/components/schemas/inline_response_200_87_config_data'
          type: array
        name:
          description: The name of the configuration
          type: string
        type:
          description: The type of the entity
          type: string
        version:
          description: The version of the configuration
          type: string
        retention:
          description: The retention period for the data
          type: string
        api_system:
          description: The API system used
          type: string
        api_version:
          description: The version of the API system
          type: string
        data_source:
          description: The data source for the configuration
          type: string
        description:
          description: The description of the configuration (can be null)
          type: string
        device_documentation_id:
          description: The ID for device documentation
          type: integer
    inline_response_200_87_data:
      example:
        period: 5
        company_id: 6
        company_name: company_name
        created_at: 2000-01-23T04:56:07.000+00:00
        id: 0
        type: user
        config:
          data:
          - query_parameters:
            - value:
              - value
              - value
              key: key
            - value:
              - value
              - value
              key: key
            variables:
            - filter: filter
              ref: ref
              transform: transform
              default: default
              id: id
              type: type
              enum:
              - enum
              - enum
            - filter: filter
              ref: ref
              transform: transform
              default: default
              id: id
              type: type
              enum:
              - enum
              - enum
            url_params:
              key:
              - url_params
              - url_params
            url: url
          - query_parameters:
            - value:
              - value
              - value
              key: key
            - value:
              - value
              - value
              key: key
            variables:
            - filter: filter
              ref: ref
              transform: transform
              default: default
              id: id
              type: type
              enum:
              - enum
              - enum
            - filter: filter
              ref: ref
              transform: transform
              default: default
              id: id
              type: type
              enum:
              - enum
              - enum
            url_params:
              key:
              - url_params
              - url_params
            url: url
          name: name
          api_system: api_system
          description: description
          id: 1
          type: type
          api_version: api_version
          version: version
          device_documentation_id: 5
          retention: retention
          data_source: data_source
        enabled: true
        device_count: 2
      properties:
        id:
          description: The unique identifier for the data collect config
          type: integer
        type:
          description: The type of the entity (e.g., user)
          enum:
          - user
          - system
          type: string
        company_id:
          description: The company ID associated with the user
          type: integer
        company_name:
          description: Configs company name
          nullable: true
          type: string
        config:
          $ref: '#/components/schemas/inline_response_200_87_config'
        enabled:
          description: Whether the configuration is enabled
          type: boolean
        period:
          description: The period in seconds for the configuration
          type: integer
        device_count:
          description: The number of devices associated with the configuration
          type: integer
        created_at:
          description: The timestamp when the configuration was created
          format: date-time
          type: string
    inline_response_200_87:
      example:
        data:
        - period: 5
          company_id: 6
          company_name: company_name
          created_at: 2000-01-23T04:56:07.000+00:00
          id: 0
          type: user
          config:
            data:
            - query_parameters:
              - value:
                - value
                - value
                key: key
              - value:
                - value
                - value
                key: key
              variables:
              - filter: filter
                ref: ref
                transform: transform
                default: default
                id: id
                type: type
                enum:
                - enum
                - enum
              - filter: filter
                ref: ref
                transform: transform
                default: default
                id: id
                type: type
                enum:
                - enum
                - enum
              url_params:
                key:
                - url_params
                - url_params
              url: url
            - query_parameters:
              - value:
                - value
                - value
                key: key
              - value:
                - value
                - value
                key: key
              variables:
              - filter: filter
                ref: ref
                transform: transform
                default: default
                id: id
                type: type
                enum:
                - enum
                - enum
              - filter: filter
                ref: ref
                transform: transform
                default: default
                id: id
                type: type
                enum:
                - enum
                - enum
              url_params:
                key:
                - url_params
                - url_params
              url: url
            name: name
            api_system: api_system
            description: description
            id: 1
            type: type
            api_version: api_version
            version: version
            device_documentation_id: 5
            retention: retention
            data_source: data_source
          enabled: true
          device_count: 2
        - period: 5
          company_id: 6
          company_name: company_name
          created_at: 2000-01-23T04:56:07.000+00:00
          id: 0
          type: user
          config:
            data:
            - query_parameters:
              - value:
                - value
                - value
                key: key
              - value:
                - value
                - value
                key: key
              variables:
              - filter: filter
                ref: ref
                transform: transform
                default: default
                id: id
                type: type
                enum:
                - enum
                - enum
              - filter: filter
                ref: ref
                transform: transform
                default: default
                id: id
                type: type
                enum:
                - enum
                - enum
              url_params:
                key:
                - url_params
                - url_params
              url: url
            - query_parameters:
              - value:
                - value
                - value
                key: key
              - value:
                - value
                - value
                key: key
              variables:
              - filter: filter
                ref: ref
                transform: transform
                default: default
                id: id
                type: type
                enum:
                - enum
                - enum
              - filter: filter
                ref: ref
                transform: transform
                default: default
                id: id
                type: type
                enum:
                - enum
                - enum
              url_params:
                key:
                - url_params
                - url_params
              url: url
            name: name
            api_system: api_system
            description: description
            id: 1
            type: type
            api_version: api_version
            version: version
            device_documentation_id: 5
            retention: retention
            data_source: data_source
          enabled: true
          device_count: 2
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          description: A list of data collect configurations
          items:
            $ref: '#/components/schemas/inline_response_200_87_data'
          type: array
    _data_collect_configs_query_parameters:
      properties:
        key:
          type: string
        value:
          items:
            type: string
          type: array
    _data_collect_configs_search_parameters:
      properties:
        path:
          type: string
        search_key:
          type: string
        key:
          type: string
        value:
          type: string
    _data_collect_configs_data:
      properties:
        url:
          nullable: true
          type: string
        query_parameters:
          items:
            $ref: '#/components/schemas/_data_collect_configs_query_parameters'
          minItems: 1
          type: array
        search_parameters:
          items:
            $ref: '#/components/schemas/_data_collect_configs_search_parameters'
          minItems: 1
          type: array
      required:
      - url
    inline_object_1:
      properties:
        name:
          maxLength: 255
          nullable: true
          type: string
        description:
          maxLength: 255
          nullable: true
          type: string
        company_id:
          description: The ID of the company (required).
          type: integer
        api_version:
          maxLength: 255
          type: string
        api_system:
          enum:
          - rutos
          - tswos
          nullable: true
          type: string
        period:
          minimum: 1
          type: integer
        enabled:
          type: boolean
        device_documentation_id:
          type: integer
        data:
          description: testas
          items:
            $ref: '#/components/schemas/_data_collect_configs_data'
          type: array
      required:
      - api_version
      - company_id
      - data
      - device_documentation_id
      - enabled
      - period
      type: object
    inline_response_200_88:
      example:
        success: true
      properties:
        success:
          example: true
          type: boolean
    _data_collect_configs__id__transform:
      properties:
        evaluator:
          enum:
          - bash
          - lua
          type: string
        eval_var:
          maxLength: 255
          pattern: ^[a-zA-Z0-9-_]+$
          type: string
        expression:
          maxLength: 500
          type: string
    _data_collect_configs__id__variables:
      properties:
        id:
          minLength: 1
          pattern: ^[a-zA-Z0-9-_]+$
          type: string
        ref:
          minLength: 1
          nullable: true
          type: string
        filter:
          minLength: 1
          nullable: true
          type: string
        type:
          enum:
          - string
          - number
          - integer
          - boolean
          - array
          - object
          type: string
        default:
          nullable: true
          type: string
        transform:
          $ref: '#/components/schemas/_data_collect_configs__id__transform'
        description:
          maxLength: 1000
          type: string
        enum:
          items:
            type: string
          minItems: 1
          nullable: true
          type: array
    _data_collect_configs__id__data:
      properties:
        url:
          nullable: true
          type: string
        query_parameters:
          items:
            $ref: '#/components/schemas/_data_collect_configs_query_parameters'
          minItems: 1
          type: array
        search_parameters:
          items:
            $ref: '#/components/schemas/_data_collect_configs_search_parameters'
          minItems: 1
          type: array
        variables:
          items:
            $ref: '#/components/schemas/_data_collect_configs__id__variables'
          maxItems: 200
          minItems: 1
          type: array
    inline_object_2:
      properties:
        name:
          maxLength: 255
          nullable: true
          type: string
        description:
          maxLength: 255
          nullable: true
          type: string
        company_id:
          description: The ID of the company (required).
          type: integer
        api_version:
          maxLength: 255
          type: string
        api_system:
          enum:
          - rutos
          - tswos
          nullable: true
          type: string
        period:
          minimum: 1
          type: integer
        enabled:
          type: boolean
        device_documentation_id:
          type: integer
        data:
          items:
            $ref: '#/components/schemas/_data_collect_configs__id__data'
          type: array
      required:
      - api_version
      - company_id
      - data
      - device_documentation_id
      - enabled
      - period
      type: object
    inline_response_200_89_data:
      example:
        config_name: Dynamic monitoring
        period: 300
        config_description: config_description
        company_id: 1
        device_id: 1
        editable: true
        device_description: device_description
        enabled: true
        device_name: RUT956_6D7Q
        config_id: 0
        last_updated_at: 2000-01-23T04:56:07.000+00:00
        fields_count: 55
        config_type: system
      properties:
        company_id:
          example: 1
          type: integer
        device_id:
          example: 1
          type: integer
        config_id:
          example: 0
          type: integer
        enabled:
          example: true
          type: boolean
        period:
          example: 300
          type: integer
        config_name:
          example: Dynamic monitoring
          type: string
        config_description:
          nullable: true
          type: string
        config_type:
          example: system
          type: string
        fields_count:
          example: 55
          type: integer
        device_name:
          example: RUT956_6D7Q
          type: string
        device_description:
          nullable: true
          type: string
        editable:
          example: true
          type: boolean
        last_updated_at:
          format: date-time
          type: string
    inline_response_200_89:
      example:
        data:
        - config_name: Dynamic monitoring
          period: 300
          config_description: config_description
          company_id: 1
          device_id: 1
          editable: true
          device_description: device_description
          enabled: true
          device_name: RUT956_6D7Q
          config_id: 0
          last_updated_at: 2000-01-23T04:56:07.000+00:00
          fields_count: 55
          config_type: system
        - config_name: Dynamic monitoring
          period: 300
          config_description: config_description
          company_id: 1
          device_id: 1
          editable: true
          device_description: device_description
          enabled: true
          device_name: RUT956_6D7Q
          config_id: 0
          last_updated_at: 2000-01-23T04:56:07.000+00:00
          fields_count: 55
          config_type: system
        success: true
      properties:
        success:
          description: Determinate if something went wrong while executing request.
            True - request was successful, false - request was unsuccessful.
          example: true
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_89_data'
          type: array
    _data_collect_configs_assign_configs:
      properties:
        id:
          description: Unique identifier for the configuration
          type: string
        device_id:
          description: List of device IDs associated with the configuration
          items:
            type: integer
          type: array
        period:
          description: Period of the configuration
          minimum: 1
          type: integer
        enabled:
          description: Whether the configuration is enabled or not
          type: boolean
      required:
      - device_id
      - enabled
      - id
      - period
    inline_object_3:
      properties:
        configs:
          items:
            $ref: '#/components/schemas/_data_collect_configs_assign_configs'
          minItems: 1
          type: array
      type: object
    inline_object_4:
      properties:
        device_id:
          description: List of device IDs associated with the configuration
          items:
            description: A valid device ID owned by the user
            type: integer
          minItems: 1
          type: array
      required:
      - device_id
      type: object
    inline_response_200_90_data:
      example:
        device_id: 15267
        log:
        - 'Variable retrieval failed: url [/modems/status], id [rsrp], filter [$.http_body.data[@.primary=true].rsrp],
          type mismatch: can not convert actual value [N/A] to expected [number] type'
        - 'Variable retrieval failed: url [/modems/status], id [rsrp], filter [$.http_body.data[@.primary=true].rsrp],
          type mismatch: can not convert actual value [N/A] to expected [number] type'
        config_id: 1
        created_at: 2000-01-23T04:56:07.000+00:00
      properties:
        log:
          description: Detailed log errors or issues related to device status
          items:
            example: 'Variable retrieval failed: url [/modems/status], id [rsrp],
              filter [$.http_body.data[@.primary=true].rsrp], type mismatch: can not
              convert actual value [N/A] to expected [number] type'
            type: string
          type: array
        config_id:
          description: Configuration identifier
          example: 1
          type: integer
        device_id:
          description: Device identifier
          example: 15267
          type: integer
        created_at:
          description: Timestamp of the log entry
          format: date-time
          type: string
    inline_response_200_90:
      example:
        data:
        - device_id: 15267
          log:
          - 'Variable retrieval failed: url [/modems/status], id [rsrp], filter [$.http_body.data[@.primary=true].rsrp],
            type mismatch: can not convert actual value [N/A] to expected [number]
            type'
          - 'Variable retrieval failed: url [/modems/status], id [rsrp], filter [$.http_body.data[@.primary=true].rsrp],
            type mismatch: can not convert actual value [N/A] to expected [number]
            type'
          config_id: 1
          created_at: 2000-01-23T04:56:07.000+00:00
        - device_id: 15267
          log:
          - 'Variable retrieval failed: url [/modems/status], id [rsrp], filter [$.http_body.data[@.primary=true].rsrp],
            type mismatch: can not convert actual value [N/A] to expected [number]
            type'
          - 'Variable retrieval failed: url [/modems/status], id [rsrp], filter [$.http_body.data[@.primary=true].rsrp],
            type mismatch: can not convert actual value [N/A] to expected [number]
            type'
          config_id: 1
          created_at: 2000-01-23T04:56:07.000+00:00
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Indicates if the request was successful
          example: true
          type: boolean
        data:
          description: List of log entries
          items:
            $ref: '#/components/schemas/inline_response_200_90_data'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_91_data__system_device_usage_status:
      example:
        ram_total: 234
      properties:
        ram_total:
          example: 234
          type: integer
    inline_response_200_91_data:
      description: Configuration identifier
      example:
        /system/device/usage/status:
          ram_total: 234
      properties:
        /system/device/usage/status:
          $ref: '#/components/schemas/inline_response_200_91_data__system_device_usage_status'
    inline_response_200_91_data_1:
      example:
        data:
          /system/device/usage/status:
            ram_total: 234
        created_at: 2000-01-23T04:56:07.000+00:00
      properties:
        data:
          $ref: '#/components/schemas/inline_response_200_91_data'
        created_at:
          description: Timestamp of the log entry
          format: date-time
          type: string
    inline_response_200_91:
      example:
        data:
        - data:
            /system/device/usage/status:
              ram_total: 234
          created_at: 2000-01-23T04:56:07.000+00:00
        - data:
            /system/device/usage/status:
              ram_total: 234
          created_at: 2000-01-23T04:56:07.000+00:00
        success: true
        meta:
          total: 1420
      properties:
        success:
          description: Indicates if the request was successful
          example: true
          type: boolean
        data:
          description: List of collected data
          items:
            $ref: '#/components/schemas/inline_response_200_91_data_1'
          type: array
        meta:
          $ref: '#/components/schemas/meta_total'
    inline_response_200_92_data_temperature:
      description: A dictionary of temperature values and their counts.
      example:
        "20": 120
        "10": 100
      properties:
        "10":
          example: 100
          type: integer
        "20":
          example: 120
          type: integer
    inline_response_200_92_data:
      example:
        temperature:
          "20": 120
          "10": 100
      properties:
        temperature:
          $ref: '#/components/schemas/inline_response_200_92_data_temperature'
    inline_response_200_92:
      example:
        data:
          temperature:
            "20": 120
            "10": 100
        success: true
      properties:
        success:
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_92_data'
    inline_response_200_93_data:
      example:
        temperature:
        - "20"
        - "20"
      properties:
        temperature:
          description: Array of available parameters values.
          items:
            example: "20"
            type: string
          type: array
    inline_response_200_93:
      example:
        data:
          temperature:
          - "20"
          - "20"
        success: true
      properties:
        success:
          example: true
          type: boolean
        data:
          $ref: '#/components/schemas/inline_response_200_93_data'
    inline_response_200_94_fields:
      example:
        description: description
        id: id
        url: url
      properties:
        id:
          description: Monitoring parameter name
          type: string
        url:
          description: URL to the device's status endpoint
          type: string
        description:
          description: Description of the field (if any)
          nullable: true
          type: string
    inline_response_200_94_data:
      example:
        name: name
        id: 0
        fields:
        - description: description
          id: id
          url: url
        - description: description
          id: id
          url: url
      properties:
        id:
          description: Monitoring template ID
          type: integer
        name:
          description: Monitoring template name
          type: string
        fields:
          items:
            $ref: '#/components/schemas/inline_response_200_94_fields'
          type: array
    inline_response_200_94:
      example:
        data:
        - name: name
          id: 0
          fields:
          - description: description
            id: id
            url: url
          - description: description
            id: id
            url: url
        - name: name
          id: 0
          fields:
          - description: description
            id: id
            url: url
          - description: description
            id: id
            url: url
        success: true
      properties:
        success:
          type: boolean
        data:
          items:
            $ref: '#/components/schemas/inline_response_200_94_data'
          type: array
    tag_create_actions:
      properties:
        action:
          description: Name of action assigned to tag.
          enum:
          - firmware_upload
          - config_upload
          - execute_tasks_group
          - execute_mulficonfig_template
          example: firmware_upload
          type: string
        source_id:
          description: ID of item used in tag action.
          example: 1
          type: integer
    device_body_tags:
      example:
        company_id: 430
        color: '#4287f5'
        updated_at: 2020-02-20 09:10:59
        user_id: 4
        name: The tag
        description: Good tag
        created_at: 1995-06-08 04:20:07
        id: 11
        actions:
        - tag_id: 1
          action: firmware_upload
          created_at: 2024-11-07 13:34:35
          source_id: 1
          source_name: RUT30X_R_00.07.00_WEBUI.bin
        - tag_id: 1
          action: firmware_upload
          created_at: 2024-11-07 13:34:35
          source_id: 1
          source_name: RUT30X_R_00.07.00_WEBUI.bin
        - tag_id: 1
          action: firmware_upload
          created_at: 2024-11-07 13:34:35
          source_id: 1
          source_name: RUT30X_R_00.07.00_WEBUI.bin
        - tag_id: 1
          action: firmware_upload
          created_at: 2024-11-07 13:34:35
          source_id: 1
          source_name: RUT30X_R_00.07.00_WEBUI.bin
      properties:
        id:
          description: Tag id.
          example: 11
          type: integer
        name:
          description: Tag name.
          example: The tag
          type: string
        description:
          description: Tag description.
          example: Good tag
          type: string
        user_id:
          description: Tag creators id.
          example: 4
          type: integer
        company_id:
          description: Company's that id belongs to id.
          example: 430
          type: integer
        color:
          description: Color of tag in HEX format.
          example: '#4287f5'
          maxLength: 7
          type: string
        actions:
          items:
            $ref: '#/components/schemas/inline_response_200_7_actions'
          maxItems: 4
          type: array
        created_at:
          description: Timestamp of entry's creation.
          example: 1995-06-08 04:20:07
          pattern: Y-m-d H:i:s
          type: string
        updated_at:
          description: Timestamp of entry's last update.
          example: 2020-02-20 09:10:59
          pattern: Y-m-d H:i:s
          type: string
    devices_update_data:
      properties:
        id:
          description: Id of a device.
          example: 1
          minimum: 1
          type: integer
        name:
          description: Device name.
          example: New device
          type: string
        description:
          description: Device new description.
          example: Device description.
          type: string
        password_confirmation:
          description: Update device password required for adding device to the system.
          example: Password123
          type: string
        dynamic_monitoring:
          description: Determinate at what interval dynamic monitoring will collect
            data. 0 - to turn off monitoring.
          example: 60
          minimum: 60
          type: integer
        static_monitoring:
          description: Determinate at what interval static monitoring will collect
            data. 0 - to turn off monitoring.
          example: 0
          minimum: 60
          type: integer
        hotspot_monitoring:
          description: Determinate at what interval hotspot monitoring will collect
            data. 0 - to turn off monitoring.
          example: 60
          minimum: 60
          type: integer
        io_monitoring:
          description: Determinate at what interval I/O monitoring will collect data.
            0 - to turn off monitoring.
          example: 60
          minimum: 60
          type: integer
        gps_monitoring:
          description: Determinate at what interval gps monitoring will collect data.
            0 - to turn off monitoring.
          example: 0
          minimum: 60
          type: integer
        wireless_monitoring:
          description: Determinate at what interval gps monitoring will collect data.
            0 - to turn off monitoring.
          example: 0
          minimum: 60
          type: integer
        vpn_monitoring:
          description: Determinate at what interval vpn monitoring will collect data.
            0 - to turn off monitoring.
          example: 0
          minimum: 60
          type: integer
        user_set_latitude:
          description: Device latitude in Decimal degrees.
          example: 54.898798
          format: float
          nullable: true
          type: number
        user_set_longitude:
          description: Device longitude in Decimal degrees.
          example: 23.964856
          format: float
          nullable: true
          type: number
        tag_id:
          description: Tags ids that device must have. If left empty will remove all
            tags.
          items:
            description: Id of a tag.
            example: 77
            minimum: 1
            type: integer
          type: array
      required:
      - id
    device_add_data:
      properties:
        company_id:
          description: Company id that device belongs to.
          example: 6969
          type: integer
        device_series:
          description: Device series type.
          enum:
          - rut
          - trb
          - tcr
          - tap
          - otd
          example: rut
          type: string
        serial:
          description: Device serial number
          example: "1234567890"
          type: string
        mac:
          description: Device's mac. Required if device model is RUT or TCR.
          example: 00:00:00:00:00:00
          type: string
        imei:
          description: Device imei number. Required if device model is TRB.
          example: "111111111111111"
          type: string
        name:
          description: Device name.
          example: New device
          type: string
        firmware_file_id:
          description: Firmware file ID. Must be owner of the file and it must be
            compatible with series of device (device_series).
          example: 1125
          type: integer
        config_file_id:
          description: Config (backup) file ID. Must be owner of the file.
          example: 6210
          type: integer
        auto_credit_enable:
          description: Auto credit function enable for device. Default true.
          example: true
          type: boolean
        password_confirmation:
          description: Devices password required for adding device to the system.
          example: Password123
          type: string
        tag_id:
          description: List of tags.
          items:
            description: Tag ID.
            type: integer
          type: array
      required:
      - company_id
      - device_series
      - imei
      - mac
      - password_confirmation
      - serial
    devices_monitoring_data:
      properties:
        device_id:
          description: Device id.
          minimum: 1
          type: integer
        monitoring_enabled:
          description: Represents state of device monitoring. True - enabled. False
            - disabled.
          type: integer
    device_assign_tags_data:
      properties:
        device_id:
          description: A device id.
          example: 78410
          type: integer
        tag_id:
          description: List of tag ids.
          items:
            description: Tag id that will be set for devices in file.
            example: 7841
            type: integer
          type: array
      required:
      - device_id
      - tag_id
    device_overwrite_tags_data:
      properties:
        device_id:
          description: A device id.
          example: 78410
          type: integer
        tag_id:
          description: List of tag ids, leave empty to remove all tags for device.
          items:
            description: Tag id that will be set for devices in file.
            example: 7841
            type: integer
          type: array
      required:
      - device_id
      - tag_id
    device_remote_access_post_data:
      properties:
        device_id:
          description: Device id.
          example: 1
          minimum: 1
          type: integer
        name:
          description: Name of remote access (alpha_dash only).
          example: The_name
          maxLength: 50
          minLength: 3
          type: string
        destination_ip:
          description: Destination ip.
          example: 127.0.0.1
          format: ipv4
          type: string
        destination_port:
          description: Destination port.
          example: 8000
          maxLength: 65535
          minLength: 0
          type: integer
        protocol:
          description: Connection protocol
          enum:
          - http
          - https
          - ssh
          - rdp
          - vnc
          type: string
        credentials_required:
          description: Set if credentials be required on connect
          example: false
          type: boolean
    set_updates_data:
      properties:
        id:
          description: Device id.
          example: 1001
          type: integer
        action:
          description: Update action for device.
          enum:
          - upload_backup
          - update_firmware
          example: upload_backup
          type: string
        file_id:
          description: File id.
          example: 5
          type: integer
        offline:
          description: Is offline.
          example: false
          type: boolean
        keep_settings:
          description: Is there a need to keep settings. Required when action is update_firmware.
          example: false
          type: boolean
      required:
      - action
      - file_id
      - id
      - offline
    cancel_updates_data:
      properties:
        id:
          description: Id of a device.
          example: 7911
          type: integer
        job_id:
          description: List of jobs.
          items:
            description: Job id.
            example: 7
            type: integer
          type: array
      required:
      - id
      - job_id
    generate_password_data:
      properties:
        id:
          description: Device id
          example: 1
          type: integer
        length:
          description: Length of password to be generated
          example: 16
          maximum: 32
          minimum: 8
          type: integer
        use_special:
          description: Boolean to determinate if special values should be used when
            generating password
          enum:
          - 0
          - 1
          example: 1
          type: integer
    set_passwords_data:
      properties:
        id:
          description: Device id
          example: 1
          type: integer
        password:
          description: Custom password to set for devices list
          example: Password123
          maximum: 32
          minimum: 8
          type: string
        password_confirmation:
          description: Same as password
          example: Password123
          type: string
        show_password:
          description: Show changed password in summary
          example: false
          type: bool
    add_device_credit_data:
      properties:
        device_id:
          description: Id of a device.
          example: 100
          type: integer
        auto_extend_credit:
          description: Turn on or off auto credit extend.
          enum:
          - 1
          - 0
          example: 1
          type: integer
        credit_enabled:
          description: To enable / disable credits for device.
          enum:
          - 1
          - 0
          example: 1
          type: integer
        credit_type_id:
          description: Credit type id.
          example: 4
          type: integer
    alert_config_add_data:
      properties:
        device_id:
          description: Device id.
          example: 5
          type: integer
        alert_type_id:
          description: Alert type id.
          example: 5
          type: integer
        alert_subtype_id:
          description: Alert subtype id.
          example: 3
          type: integer
        action:
          description: Alert action, required unless alert_subtype is 11 or 12.
          enum:
          - 1
          - 2
          - 3
          example: 1
          type: integer
        subject:
          description: Subject that will be used for alert.
          example: subject
          type: string
        message:
          description: Message for alert, required unless alert_subtype_id is 15.
          example: example
          type: string
        email:
          description: Email.
          example: example@mail.com
          format: email
          type: string
        smtp_config_id:
          description: Smtp config id.
          example: 2
          type: integer
        delivery_retry:
          description: Is delivery retry enabled.
          example: true
          type: boolean
        retry_interval:
          description: Retry interval in minutes.
          example: 5
          type: integer
        retry_count:
          description: Number of retries.
          example: 3
          type: integer
        redundancy_interval:
          description: Redundancy interval in minutes, requried unless alert_type_id
            is 3.
          example: 5
          type: integer
        data_limit:
          description: Limit of data interval in minutes, required if alert_subtype_id
            is 15.
          example: 5
          type: integer
        sim:
          description: Sim card number, required if alert_subtype_id is 15.
          enum:
          - 1
          - 2
          example: 1
          type: integer
        period:
          description: Period of alert, required if alert_subtype_id is 15.
          enum:
          - day
          - week
          - month
          example: day
          type: string
        starts:
          description: Start, required if alert_subtype_id is 15.
          example: 5
          type: integer
        phone:
          description: Phone number, required if alert_subtype_id is 12 or 15.
          example: +37060000000
          type: string
        longitude:
          description: Longitude coordinates, required if alert_type_id is 5.
          example: 20.5411
          type: number
        latitude:
          description: Latitude coordinates, required if alert_type_id is 5.
          example: 20.5411
          type: number
        radius:
          description: Radius in meters, required if alert_type_id is 5.
          example: 20
          type: number
      required:
      - action
      - alert_subtype_id
      - alert_type_id
      - data_limit
      - device_id
      - message
      - redundancy_interval
    device_task_groups_create_data:
      properties:
        command:
          description: Device task command. (required when type is command)
          example: echo Hello world!
          type: string
        acceptable_codes:
          description: Device task command's acceptable response/errro codes. (required
            when type is command)
          items:
            description: Command response/error code that wont fail task.
            example: 0
            type: integer
          type: array
        file_id:
          description: File to upload if. (required when type is upload_file)
          example: 1
          type: integer
        target_path:
          description: Target path to where file should be uploaded. (required when
            type is upload_file)
          example: /usr/local/bin
          type: string
        file:
          description: Path to file that should be downloaded. (required when type
            is download_file)
          example: /usr/local/bin/some_file.txt
          type: string
    device_task_groups_create_tasks:
      properties:
        name:
          description: Name of task.
          example: Task 1
          type: string
        order:
          description: Device task order in group.
          example: 2
          minimum: 0
          type: integer
        stop_on_failure:
          description: Stop this task on failure.
          example: true
          type: boolean
        type:
          description: Type of task.
          enum:
          - command
          - upload_file
          - download_file
          example: command
          type: string
        timeout:
          description: Task timeout in seconds.
          example: 10
          maximum: 300
          minimum: 1
          type: integer
        data:
          $ref: '#/components/schemas/device_task_groups_create_data'
      required:
      - data
      - name
      - order
      - timeout
      - type
    device_task_groups_execute_variables:
      properties:
        name:
          type: string
        value:
          type: string
    device_task_groups_execute_tasks:
      properties:
        task_id:
          description: ID of task you want to run.
          type: integer
        variables:
          items:
            $ref: '#/components/schemas/device_task_groups_execute_variables'
          type: array
    BaseErrorModel_allOf_data__1:
      properties:
        errorcode:
          description: Error code that represents execution failure.
          type: integer
        value:
          description: Response message.
          example: Object does not exist.
          type: string
        status:
          example: error
    BaseErrorModel_allOf_data:
      properties:
        "-1":
          $ref: '#/components/schemas/BaseErrorModel_allOf_data__1'
    BaseErrorModel_allOf:
      description: Error occured in executing action.
      properties:
        data:
          $ref: '#/components/schemas/BaseErrorModel_allOf_data'
      required:
      - data
    BaseResponseModel_data__1:
      description: Specific device response object.
      properties:
        status:
          description: Response status
          example: completed
          type: string
        type:
          description: Response type.
          example: text
          type: string
    BaseResponseModel_data:
      description: Response object that represents response for each device.
      properties:
        "-1":
          $ref: '#/components/schemas/BaseResponseModel_data__1'
    BaseSuccessModel_allOf_data__1:
      properties:
        value:
          description: Response message.
          example: Action executed successfully.
          type: string
        status:
          example: completed
    BaseSuccessModel_allOf_data:
      properties:
        "-1":
          $ref: '#/components/schemas/BaseSuccessModel_allOf_data__1'
    BaseSuccessModel_allOf:
      description: Action executed successfully.
      properties:
        data:
          $ref: '#/components/schemas/BaseSuccessModel_allOf_data'
      required:
      - data
    get_configuration_query_parameters:
      properties:
        key:
          description: The key of the query parameter.
          maxLength: 255
          type: string
        value:
          description: The value of the query parameter.
          maxLength: 255
          type: string
    get_configuration_elements:
      properties:
        key:
          description: The key of the search element. Required if 'value' is present.
          maxLength: 255
          type: string
        value:
          description: The value of the search element. Required if 'key' is present.
          maxLength: 255
          type: string
    get_configuration_search_elements:
      properties:
        search_key:
          description: The key to search for.
          maxLength: 255
          type: string
        path:
          description: The path of the search element.
          maxLength: 255
          type: string
        elements:
          description: Search elements.
          items:
            $ref: '#/components/schemas/get_configuration_elements'
          type: array
    get_configuration_endpoints:
      properties:
        path:
          description: The path of the endpoint.
          type: string
        query_parameters:
          description: The query parameters for the endpoint.
          items:
            $ref: '#/components/schemas/get_configuration_query_parameters'
          type: array
        search_elements:
          description: The elements to search for in the endpoint.
          items:
            $ref: '#/components/schemas/get_configuration_search_elements'
          type: array
    send_configuration_configuration:
      properties:
        device_id:
          description: The ID of the device.
          items:
            type: integer
          type: array
        path:
          description: The path of the configuration.
          type: string
        method:
          description: The HTTP method of the configuration.
          type: string
        content_type:
          description: The content type of the configuration.
          type: string
        query_parameters:
          description: The query parameters for the configuration.
          items:
            $ref: '#/components/schemas/get_configuration_query_parameters'
          type: array
        search_elements:
          description: The elements to search for in the configuration.
          items:
            $ref: '#/components/schemas/get_configuration_search_elements'
          type: array
        request_data:
          description: The request data of the configuration. Not required if the
            method is 'delete'.
          items:
            maxLength: 255
            type: string
          type: array
    create_template_template:
      properties:
        path:
          description: The path for the template
          type: string
        method:
          description: The HTTP method for the template (e.g. GET, POST)
          type: string
        content_type:
          description: The content type of the template (e.g. application/json)
          type: string
        request_data:
          description: The request data for the template (only required for non-DELETE
            requests)
          type: object
    automation_log_body_evaluated_conditions:
      example:
        value: true
        key: cond_0
      properties:
        key:
          description: Condition tag name.
          example: cond_0
          type: string
        value:
          description: Evaluated condition value
          example: true
          type: boolean
    automation_log_body_evaluated_parameters:
      example:
        value: "35"
        key: temperature
      properties:
        key:
          description: Parameter name.
          example: temperature
          type: string
        value:
          description: Parameter value at time of evaluation.
          example: "35"
    automations_devices_assign_data:
      properties:
        automation_id:
          description: Automation id.
          example: 78410
          type: integer
        device_id:
          description: List of device ids.
          items:
            description: Device id that will be assigned to automation.
            example: 7841
            type: integer
          type: array
      required:
      - automation_id
      - device_id
    automations_devices_unassign_data:
      properties:
        automation_id:
          description: Automation id.
          example: 78410
          type: integer
        device_id:
          description: List of device ids.
          items:
            description: Device id that will be unassigned from automation.
            example: 7841
            type: integer
          type: array
      required:
      - automation_id
      - device_id
    devices_automations_overwrite_data:
      properties:
        device_id:
          description: A device id.
          example: 78410
          type: integer
        automation_id:
          description: List of automations ids, leave empty to remove all automations
            for device.
          items:
            description: Automation id that will be set for device.
            example: 7841
            type: integer
          type: array
      required:
      - automation_id
      - device_id
  securitySchemes:
    BearerAuth:
      scheme: bearer
      type: http
