openapi: 3.2.0
info:
  title: DEVICES Switches API
  version: 3.0.0
  description: All core operations on switches.
servers:
- url: https://{BaseUrl}/api/v3.0
  description: Eagle Eye Networks API Server
  variables:
    BaseUrl:
      default: api.cxxx.eagleeyenetworks.com
      description: HTTPS Base url to use for all API calls, retrieved from https://api.eagleeyenetworks.com/api/v3.0/clientSettings
security:
- bearerAuth: []
tags:
- name: Switches
  description: All core operations on switches.
paths:
  /switches:
    get:
      operationId: listSwitches
      description: 'This endpoint allows users to retrieve a paginated list of switches within a given account.

        It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available switches, not the number of switches resulting from the query string.'
      tags:
      - Switches
      parameters:
      - $ref: '#/components/parameters/id__in3'
      - $ref: '#/components/parameters/name__contains3'
      - $ref: '#/components/parameters/id__contains3'
      - $ref: '#/components/parameters/include2'
      - $ref: '#/components/parameters/pageToken'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiPaginatedSwitchResponse'
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/resourceNotFound'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: List switches
      x-summary-source: derived
  /switches/{switchId}:
    parameters:
    - $ref: '#/components/parameters/switchId'
    get:
      operationId: getSwitch
      description: This endpoint allows users to retrieve a specific switch based on its id.
      tags:
      - Switches
      parameters:
      - $ref: '#/components/parameters/include2'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSwitchWithIncludes'
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/resourceNotFound'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: Get switch
      x-summary-source: derived
    patch:
      description: This endpoint allows users to update a given switch.
      operationId: updateSwitch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiSwitchUpdate'
      responses:
        '204':
          description: Switch Updated
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/resourceNotFound'
        '500':
          $ref: '#/components/responses/internalServerError'
      tags:
      - Switches
      summary: Update switch
      x-summary-source: derived
  /switches/{switchId}/actions:
    parameters:
    - $ref: '#/components/parameters/switchId'
    post:
      operationId: switchAction
      description: Switch action endpoint. This endpoint allows users to perform actions on a specific switch. Currently only reboot is supported.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiSwitchActionUpdate'
      responses:
        '204':
          description: Action Acknowledged
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/resourceNotFound'
        '500':
          $ref: '#/components/responses/internalServerError'
      tags:
      - Switches
      summary: Switch action
      x-summary-source: derived
  /switches/{switchId}/ports/all/actions:
    parameters:
    - $ref: '#/components/parameters/switchId'
    post:
      operationId: updateAllPorts
      description: All ports can be turned On, Off or power cycled with this endpoint.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiSwitchPortUpdate'
      responses:
        '204':
          description: Ports Updated
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/resourceNotFound'
        '500':
          $ref: '#/components/responses/internalServerError'
      tags:
      - Switches
      summary: Update all ports
      x-summary-source: derived
  /switches/{switchId}/ports/{portId}/actions:
    parameters:
    - $ref: '#/components/parameters/switchId'
    - $ref: '#/components/parameters/portId1'
    post:
      operationId: updatePort3
      description: A specific port can be turned On/Off with this endpoint. A port can also be power cycled.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiSwitchPortUpdate'
      responses:
        '204':
          description: Port Updated
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/resourceNotFound'
        '500':
          $ref: '#/components/responses/internalServerError'
      tags:
      - Switches
      summary: Update port3
      x-summary-source: derived
components:
  schemas:
    ApiPaginatedSwitchResponse:
      allOf:
      - $ref: '#/components/schemas/PaginatedResponseWithSize'
      - type: object
        properties:
          results:
            type: array
            items:
              $ref: '#/components/schemas/ApiSwitchWithIncludes'
    ErrorInfoExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - errorInfo
        reason:
          description: 'The reason for the error. This is a constant value that identifies the proximate cause of the

            error. Error reasons are unique within a particular domain of errors.

            '
          type: string
          enum:
          - unauthenticated
          - unexpectedArgument
          - missingRequiredArgument
          - wrongArgumentValue
          - invalidPermission
          - wrongEdition
          - wrongAccountType
          - resourceNotFound
          - endpointNotFound
          - methodNotSupported
          - unexpectedError
          - acceptNotSupported
          - alreadyExists
          - foreignKeyConflict
          - childDevicesExist
          - contentNotSupported
          - deadlineExpired
          - tooManyRequests
          - deviceUnavailable
          - serviceUnavailable
          - invalidJSON
          - resourceLocked
          - notSupportedOnBridge
          - outOfRetention
          - deviceIdentificationFailed
          - credentialValidationFailed
          - credentialSetupFailed
          - localUrlValidationFailed
          - hwRegistrationFailed
          - failedAddingCameraAfterValidation
          - neverConnected
          - reconnectFailed
          - unsupportedModel
          - purged
          - userBlocked
          - userTemporarilyBlocked
          - quotaExceeded
          - alreadyValidated
          - reAuthenticationRequired
          - badGateway
        domain:
          description: 'Logical grouping to which the "reason" belongs

            '
          type: string
        metadata:
          $ref: '#/components/schemas/ExceptionMetadata'
    ApiSwitchPortUpdate:
      type: object
      properties:
        action:
          type: string
          enum:
          - enable
          - disable
          - reboot
          description: 'Possible values:

            * `enable` - Turn on the port. * `disable` - Turn off the port. * `reboot` - Power cycle the port.

            '
      required:
      - action
    ExceptionDetail:
      type: object
      oneOf:
      - $ref: '#/components/schemas/ErrorInfoExceptionDetail'
      - $ref: '#/components/schemas/BadRequestExceptionDetail'
      - $ref: '#/components/schemas/ResourceInfoExceptionDetail'
      discriminator:
        propertyName: type
        mapping:
          errorInfo: '#/components/schemas/ErrorInfoExceptionDetail'
          badRequest: '#/components/schemas/BadRequestExceptionDetail'
          resourceInfo: '#/components/schemas/ResourceInfoExceptionDetail'
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - errorInfo
          - badRequest
          - resourceInfo
      required:
      - type
    ApiSwitchUpdate:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/Name1'
    IpAddress1:
      type: string
      pattern: ^(?:25[0-5]|2[0-4]\d|[0-1]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d{1,2})){3}$
      example: 10.143.55.140
    ApiV3Error:
      type: object
      properties:
        code:
          description: HTTP code defined in EEN Standard Code Values
          type: integer
        status:
          description: A string enum describing the code
          type: string
          enum:
          - cancelled
          - unknown
          - invalidArgument
          - deadlineExceeded
          - notFound
          - conflict
          - permissionDenied
          - resourceExhausted
          - failedPrecondition
          - aborted
          - outOfRange
          - unimplemented
          - internal
          - unavailable
          - dataLoss
          - unauthenticated
          - mediaTypeNotSupported
          - acceptNotSupported
          - methodNotSupported
          - tooManyRequests
          - badGateway
        message:
          description: Developer friendly human readable error message in English
          type: string
        details:
          description: An array of extensible objects that define error information
          type: array
          items:
            $ref: '#/components/schemas/ExceptionDetail'
      required:
      - code
      - status
      - message
      - details
    DeviceErrorStatus:
      description: "Indicates the detailed error status of a device, grouped by device type:\nONVIF Camera / RTSP Camera / Multicamera:\n  * `generalDeviceError`: Camera error\n  * `networkError`: Network error\n  * `invalidCredentials`: Invalid credentials\n  * `deviceSupportIssue`: Device support issue\n  * `queuedForConfiguration`: Queued for configuration\n  * `configurationInProgress`: Configuration in progress\n  * `deviceDisabled`: Device is turned off\n  * `disconnectedFromBridge`: Disconnected from bridge\n\nAnalog Camera:\n  * `analogNoPower`: Power loss detected\n  * `analogBadSignal`: Signal quality issue\n  * `analogIncompatibleSignal`: Incompatible signal\n  * `analogNoSignal`: No signal\n  * `disconnectedFromBridge`: Disconnected from bridge\n  * `deviceDisabled`: Device is turned off\n\nManaged Switch:\n  * `deviceSupportIssue`: Switch support issue\n  * `disconnectedFromBridge`: Disconnected from bridge\n"
      x-een-device-type-error-status-mapping:
        onvifCamera:
        - generalDeviceError
        - networkError
        - invalidCredentials
        - deviceSupportIssue
        - queuedForConfiguration
        - configurationInProgress
        - deviceDisabled
        - disconnectedFromBridge
        rtspCamera:
        - generalDeviceError
        - networkError
        - invalidCredentials
        - deviceSupportIssue
        - queuedForConfiguration
        - configurationInProgress
        - deviceDisabled
        - disconnectedFromBridge
        analogCamera:
        - analogNoPower
        - analogBadSignal
        - analogIncompatibleSignal
        - analogNoSignal
        - disconnectedFromBridge
        - deviceDisabled
        multiCamera:
        - generalDeviceError
        - networkError
        - invalidCredentials
        - deviceSupportIssue
        - queuedForConfiguration
        - configurationInProgress
        - deviceDisabled
        - disconnectedFromBridge
        managedSwitch:
        - deviceSupportIssue
        - disconnectedFromBridge
      type: string
      enum:
      - disconnectedFromBridge
      - generalDeviceError
      - networkError
      - invalidCredentials
      - deviceSupportIssue
      - queuedForConfiguration
      - configurationInProgress
      - deviceDisabled
      - analogNoPower
      - analogBadSignal
      - analogIncompatibleSignal
      - analogNoSignal
      example: generalDeviceError
    Name1:
      type: string
      example: EEN 4 Port PoE
      description: Switch name
    BadRequestExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - badRequest
        argumentViolations:
          type: array
          items:
            $ref: '#/components/schemas/ArgumentViolation'
    ApiAdapterInfo:
      type: object
      properties:
        macAddress:
          $ref: '#/components/schemas/MacAddress'
        ipAddress:
          $ref: '#/components/schemas/IpAddress'
    BridgeId2:
      type: string
      example: 1000f60d
      description: 'The bridge a switch is connected to.

        '
    deviceCloudConnectionStatusV2:
      description: "Socket connection state between device and cloud\n  * `connected`: The device socket connected to cloud.\n  * `disconnected`: The device socket disconnected from cloud.\n"
      type: string
      enum:
      - connected
      - disconnected
      example: connected
    ApiSwitchWithIncludes:
      allOf:
      - $ref: '#/components/schemas/ApiSwitchMain'
      - $ref: '#/components/schemas/ApiSwitchIncludes'
      - type: object
    DeviceCommonStatus:
      description: "Indicates the operational status of the device. The statuses defined here should be in sync with the DeviceStatus schema.\n  * `operational`: The device is online and operational.\n  * `error`: Device not working (requires error details).\n  * `disabled`: Operational but intentionally not recording telemetry\n  * `unreachable`: The device is not reachable (e.g., offline, out of service).\n  * `unknown`: The device state is unknown for some reason.\n  * `initializing`: The device is in the process of initializing.\n"
      type: string
      enum:
      - operational
      - error
      - disabled
      - unreachable
      - unknown
      - initializing
      example: operational
    ApiNetworkInfo:
      type: object
      x-jsoninclude-nonnull-annotation: true
      properties:
        globalIP:
          $ref: '#/components/schemas/IpAddress'
        adapters:
          type: array
          items:
            $ref: '#/components/schemas/ApiAdapterInfo'
    ApiFirmware:
      type: object
      x-jsoninclude-nonnull-annotation: true
      properties:
        currentVersion:
          type:
          - string
          - 'null'
          example: v20211019_542_3022
    PaginatedResponseNoTotalSize:
      type: object
      description: 'Used to wrap results for a paginated response, containing information on how to retrieve further pages.

        '
      properties:
        nextPageToken:
          type:
          - string
          - 'null'
          readOnly: true
          description: 'Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

            '
        prevPageToken:
          type:
          - string
          - 'null'
          readOnly: true
          description: 'Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

            '
        results:
          type: array
          readOnly: true
          description: The result set from a collection API call.
          items:
            type: object
      required:
      - nextPageToken
      - prevPageToken
      - results
    ResourceInfoExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - resourceInfo
        resource:
          description: Referenced resource type, eg "cameras", "bridges", or "locations".
          type: string
        ids:
          type: array
          description: Identities of resources
          items:
            type: string
    PaginatedResponseWithSize:
      description: "Used to wrap results for a paginated response, containing information on how to retrieve further pages and  the total number of results.  \n"
      allOf:
      - $ref: '#/components/schemas/PaginatedResponseNoTotalSize'
      - properties:
          totalSize:
            type: integer
            readOnly: true
            description: 'Size of the total result set.

              '
        required:
        - totalSize
    MacAddress:
      type:
      - string
      - 'null'
      pattern: ^([A-F0-9]{2}:){5}[A-F0-9]{2}$
      example: 8A:D4:AD:09:DF:91
    ArgumentViolation:
      properties:
        argumentName:
          type: string
          description: Name of the argument
        description:
          type: string
          description: Description of the violation
    ApiSwitchMain:
      type: object
      properties:
        id:
          type: string
          example: 25c72162-cfe0-57d1-a94a-ac43904ed01a
          format: uuid
          description: Unique switch identifier
        accountId:
          type: string
          description: Account ID.
          example: '00001106'
        name:
          $ref: '#/components/schemas/Name1'
        bridgeId:
          $ref: '#/components/schemas/BridgeId2'
        portCount:
          type: integer
          example: 4
      required:
      - id
      - name
      - accountId
    ApiSwitchActionUpdate:
      type: object
      properties:
        action:
          type: string
          enum:
          - reboot
          description: 'Possible values: * `reboot` - Reboot the switch.

            '
          example: reboot
      required:
      - action
    DeviceStatus:
      description: Indicates various aspects of the device's status. The statuses defined here should be in sync with the events schema defined for the Device Cloud Status Update.
      type: object
      x-jsoninclude-nonnull-annotation: true
      properties:
        connectionStatus:
          $ref: '#/components/schemas/DeviceConnectionStatus'
    ExceptionMetadata:
      properties:
        path:
          description: Path of the request
          type: string
        method:
          description: Method of the request
          type: string
    DeviceStatusV2:
      description: Status as reported by the edge device.
      type: object
      x-jsoninclude-nonnull-annotation: true
      properties:
        cloudConnectionStatus:
          $ref: '#/components/schemas/deviceCloudConnectionStatusV2'
        edgeReportedDeviceStatus:
          $ref: '#/components/schemas/DeviceCommonStatus'
        deviceSpecificError:
          $ref: '#/components/schemas/DeviceErrorStatus'
      required:
      - cloudConnectionStatus
      - edgeReportedDeviceStatus
    ApiEsns1:
      type: array
      example:
      - '00001106'
      - '00001107'
      items:
        type: string
    ApiSwitchPort:
      type: object
      x-jsoninclude-nonnull-annotation: true
      properties:
        id:
          type: integer
          example: 11
          description: Port identifier, unique for the given switch
        enabled:
          type: boolean
          description: Indicates whether the port is on (true) or off (false)
        power:
          type: number
          description: Power in Watts that this port is drawing
          example: 9.8
        detectedDeviceCount:
          type: integer
          description: 'Number of devices connected to the port. If a single device has been detected, the Mac address and possibly the IP Address are returned.

            '
          example: 4
        devices:
          type: array
          description: List of devices that are known to be connected to the port.
          items:
            $ref: '#/components/schemas/DetectedDevice'
    DeviceConnectionStatus:
      type: string
      description: "Indicates the connection status of the device:\n  * `online`: The device is online and operational.\n  * `deviceOffline`: The device is offline.\n  * `invalidCredentials`: The known credentials for this device, including the default credentials, are invalid. This is causing the device to appear offline.\n  * `bridgeOffline`: The bridge that connects this device to the cloud is offline. However, both the device and the bridge may still be operational locally, even though the cloud has no visibility into their status.\n  * `off`: The device is online, but has been turned off by the user.\n  * `error`: The device is offline due to some problem that has not been described by any of the other statuses.\n  * `busy`: The device is currently busy and unavailable for other operations.\n  * `unknown`: The device state is unknown for some reason.\n"
      enum:
      - online
      - deviceOffline
      - invalidCredentials
      - bridgeOffline
      - 'off'
      - error
      - busy
      - unknown
    DetectedDevice:
      type: object
      description: Describes a device detected behind a port.
      properties:
        macAddress:
          allOf:
          - $ref: '#/components/schemas/MacAddress1'
          - description: MAC address behind the port.
        ipAddress:
          allOf:
          - $ref: '#/components/schemas/IpAddress1'
          - description: IP Address found using ARP for the given MAC address.
        guid:
          type: string
          format: uuid
          description: GUID of the device that corresponds to the MAC or IP connected to the port.
        esn:
          type: string
          description: Esn of the device that corresponds to the MAC or IP connected to the port.
          example: '100052842'
        deviceName:
          type:
          - string
          - 'null'
          description: Name of the device that corresponds to the MAC or IP connected to the port. The value is null if no device is connected to the port.
          example: CAM 1
        deviceId:
          type:
          - string
          - 'null'
          description: Id of the device that corresponds to the MAC or IP connected to the port. The value is null if no device is connected to the port.
          example: '100052842'
        deviceType:
          type:
          - string
          - 'null'
          description: 'Type of the device that corresponds to the MAC or IP connected to the port. The value is null if no device is connected to the port. new devices might be added in the future.

            '
          enum:
          - camera
          - speaker
          - bridge
          - multiCamera
    ApiSwitchIncludes:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/DeviceStatus'
        statusV2:
          $ref: '#/components/schemas/DeviceStatusV2'
        notes:
          type: string
          x-jsoninclude-nonnull-annotation: true
          example: Switch with label "SW001"
        ports:
          type: array
          x-jsoninclude-nonnull-annotation: true
          description: List of ports of the switch and details about each port and what is possibly connected to it.
          items:
            $ref: '#/components/schemas/ApiSwitchPort'
        networkInfo:
          $ref: '#/components/schemas/ApiNetworkInfo'
        firmware:
          $ref: '#/components/schemas/ApiFirmware'
        visibleByBridges:
          type: array
          x-jsoninclude-nonnull-annotation: true
          items:
            $ref: '#/components/schemas/BridgeId2'
    MacAddress1:
      type: string
      pattern: ^([A-F0-9]{2}:){5}[A-F0-9]{2}$
      example: 8A:D4:AD:09:DF:91
    IpAddress:
      type:
      - string
      - 'null'
      pattern: ^(?:25[0-5]|2[0-4]\d|[0-1]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d{1,2})){3}$
      example: 10.143.55.140
  responses:
    forbidden:
      description: You have no permission to access the specified resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          examples:
            invalidPermission:
              value:
                code: 403
                status: permissionDenied
                message: The client caller does not have permission for the specified operation
                details:
                - type: errorInfo
                  reason: invalidPermission
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            wrongEdition:
              value:
                code: 403
                status: permissionDenied
                message: This feature is not enabled for the account
                details:
                - type: errorInfo
                  reason: wrongEdition
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/locations
            wrongAccountType:
              value:
                code: 403
                status: permissionDenied
                message: This feature is only available for end users
                details:
                - type: errorInfo
                  reason: wrongAccountType
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/locations
    resourceNotFound:
      description: Referenced resource could not be found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          examples:
            endpointNotFound:
              value:
                code: 404
                status: notFound
                message: The API endpoint was not found
                details:
                - type: errorInfo
                  reason: endpointNotFound
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            resourceNotFound:
              value:
                code: 404
                status: notFound
                message: The resource was not found
                details:
                - type: errorInfo
                  reason: resourceNotFound
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
                - type: resourceInfo
                  resource: <resource>
                  ids:
                  - <ids>
    internalServerError:
      description: Something went wrong in the server. Please try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          example:
            code: 500
            status: internal
            message: An internal error has occurred. Please try again later.
            details:
            - type: errorInfo
              reason: unexpectedError
              domain: apiv3
              metadata:
                path: /api/v3.0/<resource>
    validationError:
      description: The supplied object is invalid. Error detail will contain the validation error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          examples:
            unexpectedArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Unexpected argument: name'
                details:
                - type: errorInfo
                  reason: unexpectedArgument
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            missingRequiredArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Missing required arguments: name, id'
                details:
                - type: errorInfo
                  reason: missingRequiredArgument
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            badRequestInvalidJSON:
              value:
                code: 400
                status: invalidArgument
                message: Invalid JSON
                details:
                - type: errorInfo
                  reason: invalidJSON
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            badRequestInvalidArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Invalid Argument: Argument name is too long'
                details:
                - type: errorInfo
                  reason: wrongArgumentValue
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
                - type: badRequest
                  argumentViolations:
                  - argumentName: name
                    description: Name is too long
    unauthorized:
      description: You are not authenticated. Please authenticate and try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          example:
            code: 401
            status: unauthenticated
            message: The client caller does not have a valid authentication credential
            details:
            - type: errorInfo
              reason: unauthenticated
              domain: apiv3
              metadata:
                path: /api/v3.0/<resource>
  parameters:
    name__contains3:
      in: query
      name: name__contains
      required: false
      description: 'Filter to get the switches whose the name contains the provided substring. The lookup is exact and case insensitive

        '
      schema:
        type: string
    portId1:
      in: path
      name: portId
      schema:
        type: integer
      required: true
    include2:
      in: query
      name: include
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          enum:
          - status
          - statusV2
          - notes
          - networkInfo
          - firmware
          - ports
          - visibleByBridges
    pageSize:
      in: query
      name: pageSize
      description: 'The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and  maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a `nextPageToken` value.

        '
      example: 100
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 500
        default: 100
    id__contains3:
      in: query
      name: id__contains
      required: false
      description: 'Filter to get the switches whose the id contains the provided substring. The lookup is exact and case insensitive

        '
      schema:
        type: string
    pageToken:
      in: query
      name: pageToken
      description: 'Token string value that references a page for pagination. This value is received when retrieving the first page in the `nextPageToken` and `prevPageToken` fields.

        When a pageToken is provided, the backend remembers search parameters from the original request, so search  parameters that affect the result set or order are optional and will be ignored if provided. Representation  parameters like `include` should still be applied.

        '
      example: b2Zmc2V0PTEwJmxpbWl0PTEw
      required: false
      schema:
        type: string
    id__in3:
      in: query
      name: id__in
      required: false
      description: List of IDs to filter on that is comma separated.
      style: form
      explode: false
      schema:
        $ref: '#/components/schemas/ApiEsns1'
    switchId:
      in: path
      name: switchId
      schema:
        type: string
      required: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: searched
  source: https://developer.eagleeyenetworks.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.eagleeyenetworks.com/reference/addcamera.md
  - https://developer.eagleeyenetworks.com/reference/addmulticamera.md
  - https://developer.eagleeyenetworks.com/reference/addspeaker.md
  - https://developer.eagleeyenetworks.com/reference/createbridge.md
  - https://developer.eagleeyenetworks.com/reference/deletebridge.md
  - https://developer.eagleeyenetworks.com/reference/deletecamera.md
  - https://developer.eagleeyenetworks.com/reference/deletecameratunnel.md
  - https://developer.eagleeyenetworks.com/reference/deletemulticamera.md
  - https://developer.eagleeyenetworks.com/reference/deletespeaker.md
  - https://developer.eagleeyenetworks.com/reference/getbridge.md
  - https://developer.eagleeyenetworks.com/reference/getbridgemetrics.md
  - https://developer.eagleeyenetworks.com/reference/getbridgesettings.md
  - https://developer.eagleeyenetworks.com/reference/getcamera.md
  - https://developer.eagleeyenetworks.com/reference/getcamerametrics.md
  - https://developer.eagleeyenetworks.com/reference/getcamerasettings.md
  - https://developer.eagleeyenetworks.com/reference/getcurrentposition.md
  - https://developer.eagleeyenetworks.com/reference/getmulticamera.md
  - https://developer.eagleeyenetworks.com/reference/getmulticamerachannels.md
  - https://developer.eagleeyenetworks.com/reference/getport.md
  - https://developer.eagleeyenetworks.com/reference/getport1.md
  - https://developer.eagleeyenetworks.com/reference/getportrecorder.md
  - https://developer.eagleeyenetworks.com/reference/getportrecorders.md
  - https://developer.eagleeyenetworks.com/reference/getports.md
  - https://developer.eagleeyenetworks.com/reference/getports1.md
  - https://developer.eagleeyenetworks.com/reference/getptzsettings.md
  - https://developer.eagleeyenetworks.com/reference/getspeaker.md
  - https://developer.eagleeyenetworks.com/reference/getspeakersettings.md
  - https://developer.eagleeyenetworks.com/reference/getswitch.md
  - https://developer.eagleeyenetworks.com/reference/listavailabledevices.md
  - https://developer.eagleeyenetworks.com/reference/listbridges.md
  - https://developer.eagleeyenetworks.com/reference/listcameras.md
  - https://developer.eagleeyenetworks.com/reference/listmulticameras.md
  - https://developer.eagleeyenetworks.com/reference/listspeakers.md
  - https://developer.eagleeyenetworks.com/reference/listswitches.md
  - https://developer.eagleeyenetworks.com/reference/moveto.md
  - https://developer.eagleeyenetworks.com/reference/putcameratunnel.md
  - https://developer.eagleeyenetworks.com/reference/swapbridge.md
  - https://developer.eagleeyenetworks.com/reference/swapcamera.md
  - https://developer.eagleeyenetworks.com/reference/switchaction.md
  - https://developer.eagleeyenetworks.com/reference/updateallports.md
  - https://developer.eagleeyenetworks.com/reference/updatebridge.md
  - https://developer.eagleeyenetworks.com/reference/updatebridgesettings.md
  - https://developer.eagleeyenetworks.com/reference/updatebulkbridges.md
  - https://developer.eagleeyenetworks.com/reference/updatebulkcameras.md
  - https://developer.eagleeyenetworks.com/reference/updatecamera.md
  - https://developer.eagleeyenetworks.com/reference/updatecamerasettings.md
  - https://developer.eagleeyenetworks.com/reference/updatemulticamera.md
  - https://developer.eagleeyenetworks.com/reference/updateport.md
  - https://developer.eagleeyenetworks.com/reference/updateport1.md
  - https://developer.eagleeyenetworks.com/reference/updateport2.md
  - https://developer.eagleeyenetworks.com/reference/updateport3.md
  - https://developer.eagleeyenetworks.com/reference/updateportrecorder.md
  - https://developer.eagleeyenetworks.com/reference/updateptzsettings.md
  - https://developer.eagleeyenetworks.com/reference/updatespeaker.md
  - https://developer.eagleeyenetworks.com/reference/updatespeakersettings.md
  - https://developer.eagleeyenetworks.com/reference/updateswitch.md
  merge:
    pages: 56
    deduped: 1179
    conflicts_kept_first: 0