openapi: 3.2.0
info:
  version: 2.10.0
  description: 'Nerve OVDM API to manage:

    - node configuration

    - system configuration

    - system network configuration

    - workloads

    - remote connections

    - dna'
  title: Nerve Node PROXY SETTINGS API
  contact:
    name: Nerve support
    email: support@tttech-industrial.com
security:
- cookieAuth: []
tags:
- name: PROXY SETTINGS
paths:
  /api/proxy-settings:
    get:
      summary: Get proxy configuration
      tags:
      - PROXY SETTINGS
      x-permissions:
      - PROXY_SETTINGS:VIEW
      description: Get proxy configuration from the environment file.
      operationId: get_proxy_configuration
      responses:
        '200':
          description: Successful operation. The proxy configuration returned.
          content:
            application/json:
              schema:
                type: object
                description: Object containing the current configuration for the proxy server
                additionalProperties: false
                properties:
                  enabled:
                    description: Activate or deactivate proxy settings.
                    type: boolean
                    default: false
                  http_proxy:
                    description: This system environment variable is used to specify the HTTP proxy server responsible for mediating HTTP requests sent to the Internet. An HTTP proxy consists of an address and a port.
                    type: string
                    minLength: 0
                    maxLength: 28
                    pattern: ^(http:\/\/(?:[0-9]{1,3}\.){3}[0-9]{1,3}:\d+)?|^$
                    default: ''
                  https_proxy:
                    description: This system environment variable is used to specify the HTTPS proxy server responsible for mediating HTTPS requests sent to the Internet. An HTTPS proxy consists of an address and a port.
                    type: string
                    minLength: 0
                    maxLength: 29
                    pattern: ^(https?:\/\/(?:[0-9]{1,3}\.){3}[0-9]{1,3}:\d+)?|^$
                    default: ''
                  no_proxy:
                    description: This system environment variable is used to specify domains or  IP addresses that will not be routed through a proxy server, thereby avoiding routing certain requests through a proxy server.
                    type: string
                    minLength: 0
                    maxLength: 1001
                    default: ''
                  username:
                    description: Proxy server credentials.
                    type: string
                    minLength: 0
                    maxLength: 1001
                    default: ''
                example:
                  http_proxy: http://0.0.0.1:1
                  https_proxy: https://0.0.0.1:1
                  no_proxy: ''
                  username: ''
                  enabled: true
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  description: Validation error.
                  required:
                  - status
                  - message
                  - errors
                  additionalProperties: false
                  properties:
                    status:
                      type: integer
                      description: HTTP status code
                    message:
                      type: string
                      minLength: 1
                      maxLength: 1001
                      description: The validation error message
                    errors:
                      type: array
                      minItems: 1
                      maxItems: 1001
                      description: Detailed description of what does not match the schema
                      items:
                        type: object
                        properties:
                          path:
                            type: string
                            minLength: 1
                            maxLength: 1001
                            description: Specified location within the document where the error occurred
                          message:
                            type: string
                            minLength: 1
                            maxLength: 1001
                            description: Error message
                - type: object
                  description: Description of error associated with status code.
                  required:
                  - status
                  - msg
                  additionalProperties: false
                  properties:
                    status:
                      type: integer
                      description: HTTP status code
                    msg:
                      type: string
                      minLength: 1
                      maxLength: 1001
                      description: Error message
                      pattern: .*
        '401':
          description: You are not authorized to perform this operation
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  description: User not authorized
                  required:
                  - user
                  additionalProperties: false
                  properties:
                    user:
                      type: string
                      description: Not authorized
                      enum:
                      - not authorized
                - type: object
                  description: User not authorized
                  required:
                  - status
                  - msg
                  additionalProperties: false
                  properties:
                    status:
                      type: integer
                      minimum: 401
                      maximum: 401
                      description: HTTP status code
                    msg:
                      type: string
                      description: Error message
                      enum:
                      - Not authorized
                      - not authorized
                - type: object
                  description: Cookie header is missing in the request
                  required:
                  - status
                  - message
                  - errors
                  additionalProperties: false
                  properties:
                    status:
                      description: HTTP status code
                      type: integer
                      enum:
                      - 401
                    message:
                      type: string
                      description: The validation error message
                      enum:
                      - '''cookie'' header required'
                    errors:
                      type: array
                      minItems: 1
                      maxItems: 1001
                      description: List of errors
                      items:
                        type: object
                        properties:
                          path:
                            type: string
                            minLength: 1
                            maxLength: 1001
                            description: Specified location within the document where the error occurred
                          message:
                            type: string
                            minLength: 1
                            maxLength: 1001
                            description: Error message
              examples:
                not_authorized_usr:
                  value:
                    user: not authorized
                not_authorized_status:
                  value:
                    status: 401
                    msg: Not authorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: Description of error associated with status code.
                required:
                - status
                - msg
                additionalProperties: false
                properties:
                  status:
                    type: integer
                    description: HTTP status code
                  msg:
                    type: string
                    minLength: 1
                    maxLength: 1001
                    description: Error message
                    pattern: .*
              examples:
                forbidden:
                  value:
                    status: 403
                    msg: Forbidden
    post:
      summary: Set proxy configuration
      tags:
      - PROXY SETTINGS
      x-permissions:
      - PROXY_SETTINGS:EDIT
      description: Setting up proxy configuration entails writing the necessary data into the APT proxy configuration file.
      operationId: set_proxy_configuration
      requestBody:
        description: Set proxy configuration.
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Object containing the configuration for the proxy server
              additionalProperties: false
              properties:
                enabled:
                  description: Activate or deactivate proxy settings.
                  type: boolean
                  default: false
                http_proxy:
                  description: This system environment variable is used to specify the HTTP proxy server responsible for mediating HTTP requests sent to the Internet. An HTTP proxy consists of an address and a port.
                  type: string
                  minLength: 0
                  maxLength: 28
                  pattern: ^(http:\/\/(?:[0-9]{1,3}\.){3}[0-9]{1,3}:\d+)?|^$
                  default: ''
                https_proxy:
                  description: This system environment variable is used to specify the HTTPS proxy server responsible for mediating HTTPS requests sent to the Internet. An HTTPS proxy consists of an address and a port.
                  type: string
                  minLength: 0
                  maxLength: 29
                  pattern: ^(https?:\/\/(?:[0-9]{1,3}\.){3}[0-9]{1,3}:\d+)?|^$
                  default: ''
                no_proxy:
                  description: This system environment variable is used to specify domains or  IP addresses that will not be routed through a proxy server, thereby avoiding routing certain requests through a proxy server.
                  type: string
                  minLength: 0
                  maxLength: 1001
                  default: ''
                username:
                  description: Proxy server credentials.
                  type: string
                  minLength: 0
                  maxLength: 1001
                  default: ''
                password:
                  description: Proxy server credentials.
                  type: string
                  minLength: 0
                  maxLength: 1001
                  default: ''
              required:
              - http_proxy
              - https_proxy
              example:
                http_proxy: http://0.0.0.1:1
                https_proxy: https://0.0.0.1:1
                no_proxy: ''
                username: ''
                password: ''
                enabled: true
      responses:
        '204':
          description: The proxy configuration successfully modified.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  description: Validation error.
                  required:
                  - status
                  - message
                  - errors
                  additionalProperties: false
                  properties:
                    status:
                      type: integer
                      description: HTTP status code
                    message:
                      type: string
                      minLength: 1
                      maxLength: 1001
                      description: The validation error message
                    errors:
                      type: array
                      minItems: 1
                      maxItems: 1001
                      description: Detailed description of what does not match the schema
                      items:
                        type: object
                        properties:
                          path:
                            type: string
                            minLength: 1
                            maxLength: 1001
                            description: Specified location within the document where the error occurred
                          message:
                            type: string
                            minLength: 1
                            maxLength: 1001
                            description: Error message
                - type: object
                  description: Description of error associated with status code.
                  required:
                  - status
                  - msg
                  additionalProperties: false
                  properties:
                    status:
                      type: integer
                      description: HTTP status code
                    msg:
                      type: string
                      minLength: 1
                      maxLength: 1001
                      description: Error message
                      pattern: .*
        '401':
          description: You are not authorized to perform this operation
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  description: User not authorized
                  required:
                  - user
                  additionalProperties: false
                  properties:
                    user:
                      type: string
                      description: Not authorized
                      enum:
                      - not authorized
                - type: object
                  description: User not authorized
                  required:
                  - status
                  - msg
                  additionalProperties: false
                  properties:
                    status:
                      type: integer
                      minimum: 401
                      maximum: 401
                      description: HTTP status code
                    msg:
                      type: string
                      description: Error message
                      enum:
                      - Not authorized
                      - not authorized
                - type: object
                  description: Cookie header is missing in the request
                  required:
                  - status
                  - message
                  - errors
                  additionalProperties: false
                  properties:
                    status:
                      description: HTTP status code
                      type: integer
                      enum:
                      - 401
                    message:
                      type: string
                      description: The validation error message
                      enum:
                      - '''cookie'' header required'
                    errors:
                      type: array
                      minItems: 1
                      maxItems: 1001
                      description: List of errors
                      items:
                        type: object
                        properties:
                          path:
                            type: string
                            minLength: 1
                            maxLength: 1001
                            description: Specified location within the document where the error occurred
                          message:
                            type: string
                            minLength: 1
                            maxLength: 1001
                            description: Error message
              examples:
                not_authorized_usr:
                  value:
                    user: not authorized
                not_authorized_status:
                  value:
                    status: 401
                    msg: Not authorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: Description of error associated with status code.
                required:
                - status
                - msg
                additionalProperties: false
                properties:
                  status:
                    type: integer
                    description: HTTP status code
                  msg:
                    type: string
                    minLength: 1
                    maxLength: 1001
                    description: Error message
                    pattern: .*
              examples:
                forbidden:
                  value:
                    status: 403
                    msg: Forbidden
        '404':
          description: The resource not found
          content:
            application/json:
              schema:
                type: object
                description: Description of error associated with status code.
                required:
                - status
                - msg
                additionalProperties: false
                properties:
                  status:
                    type: integer
                    description: HTTP status code
                  msg:
                    type: string
                    minLength: 1
                    maxLength: 1001
                    description: Error message
                    pattern: .*
        '500':
          description: Response received when the response does not match the schema or an unexpected error has occurred.
          content:
            application/json:
              schema:
                type: object
                description: Description of error associated with status code.
                required:
                - status
                - msg
                additionalProperties: false
                properties:
                  status:
                    type: integer
                    description: HTTP status code
                  msg:
                    type: string
                    minLength: 1
                    maxLength: 1001
                    description: Error message
                    pattern: .*
components:
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: header
      name: cookie
    basicAuth:
      type: http
      scheme: basic