Forward Networks Network Endpoints API

openapi: 3.2.0
info:
  title: 'Forward Networks: Complete Network Endpoints API'
  description: Model and verify networks
  contact:
    email: support@forwardnetworks.com
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  version: '26.6'
servers:
- url: /api
tags:
- name: Network Endpoints
  description: Configure network endpoint profiles and specify the network endpoints to collect from
  summary: Network Endpoints
paths:
  /endpoint-profiles:
    get:
      tags:
      - Network Endpoints
      summary: Get all endpoint profiles
      operationId: getEndpointProfiles
      x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointProfiles'
      security:
      - api_token: []
  /endpoint-profiles?type=CLI:
    post:
      tags:
      - Network Endpoints
      summary: Add a CLI endpoint profile
      operationId: createCliEndpointProfile
      x-position: 2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CliEndpointProfileDef'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointProfile'
      security:
      - api_token: []
  /endpoint-profiles?type=HTTP:
    post:
      tags:
      - Network Endpoints
      summary: Add an HTTP endpoint profile
      operationId: createHttpEndpointProfile
      x-position: 3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HttpEndpointProfileDef'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointProfile'
      security:
      - api_token: []
  /endpoint-profiles?type=SNMP:
    post:
      tags:
      - Network Endpoints
      summary: Add an SNMP endpoint profile
      operationId: createSnmpEndpointProfile
      x-position: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnmpEndpointProfileDef'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointProfile'
      security:
      - api_token: []
  /endpoint-profiles/CLI-{profileId}:
    patch:
      tags:
      - Network Endpoints
      summary: Update a CLI endpoint profile
      operationId: updateCliEndpointProfile
      x-position: 6
      parameters:
      - name: profileId
        in: path
        description: Profile ID (the numeric part)
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CliEndpointProfilePatch'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointProfile'
      security:
      - api_token: []
  /endpoint-profiles/HTTP-{profileId}:
    patch:
      tags:
      - Network Endpoints
      summary: Update an HTTP endpoint profile
      operationId: updateHttpEndpointProfile
      x-position: 7
      parameters:
      - name: profileId
        in: path
        description: Profile ID (the numeric part)
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HttpEndpointProfilePatch'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointProfile'
      security:
      - api_token: []
  /endpoint-profiles/SNMP-{profileId}:
    patch:
      tags:
      - Network Endpoints
      summary: Update an SNMP endpoint profile
      operationId: updateSnmpEndpointProfile
      x-position: 8
      parameters:
      - name: profileId
        in: path
        description: Profile ID (the numeric part)
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnmpEndpointProfilePatch'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointProfile'
      security:
      - api_token: []
  /endpoint-profiles/{profileId}:
    get:
      tags:
      - Network Endpoints
      summary: Get an endpoint profile
      operationId: getEndpointProfile
      x-position: 5
      parameters:
      - name: profileId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointProfile'
      security:
      - api_token: []
    delete:
      tags:
      - Network Endpoints
      summary: Delete an endpoint profile
      operationId: deleteEndpointProfile
      x-position: 9
      parameters:
      - name: profileId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
          content: {}
      security:
      - api_token: []
  /networks/{networkId}/endpoints:
    get:
      tags:
      - Network Endpoints
      summary: Get a network’s endpoints
      operationId: getNetworkEndpoints
      x-position: 10
      parameters:
      - name: networkId
        in: path
        required: true
        schema:
          type: string
      - name: with
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - tags
            - locationId
            - testResult
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkEndpoints'
      security:
      - api_token: []
    patch:
      tags:
      - Network Endpoints
      summary: Update specific network endpoints
      description: 'All JSON properties in the `update` object are optional. Include only the properties you wish

        to change.'
      operationId: patchNetworkEndpoints
      x-position: 18
      parameters:
      - name: networkId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkEndpointsPatchRequest'
        required: true
      responses:
        '204':
          description: No Content
          content: {}
      security:
      - api_token: []
  /networks/{networkId}/endpoints?type=CLI:
    post:
      tags:
      - Network Endpoints
      summary: Add a CLI network endpoint
      operationId: createCliNetworkEndpoint
      x-position: 11
      parameters:
      - name: networkId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewCliNetworkEndpoint'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CliNetworkEndpoint'
      security:
      - api_token: []
  /networks/{networkId}/endpoints?type=HTTP:
    post:
      tags:
      - Network Endpoints
      summary: Add an HTTP network endpoint
      operationId: createHttpNetworkEndpoint
      x-position: 12
      parameters:
      - name: networkId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewHttpNetworkEndpoint'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpNetworkEndpoint'
      security:
      - api_token: []
  /networks/{networkId}/endpoints?type=SNMP:
    post:
      tags:
      - Network Endpoints
      summary: Add an SNMP network endpoint
      operationId: createSnmpNetworkEndpoint
      x-position: 13
      parameters:
      - name: networkId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewSnmpNetworkEndpoint'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnmpNetworkEndpoint'
      security:
      - api_token: []
  /networks/{networkId}/endpoints?action=addBatch&type=CLI:
    post:
      tags:
      - Network Endpoints
      summary: Add CLI network endpoints
      operationId: createCliNetworkEndpoints
      x-position: 14
      parameters:
      - name: networkId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/NewCliNetworkEndpoint'
        required: true
      responses:
        '204':
          description: No Content
          content: {}
      security:
      - api_token: []
  /networks/{networkId}/endpoints?action=addBatch&type=HTTP:
    post:
      tags:
      - Network Endpoints
      summary: Add HTTP network endpoints
      operationId: createHttpNetworkEndpoints
      x-position: 15
      parameters:
      - name: networkId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/NewHttpNetworkEndpoint'
        required: true
      responses:
        '204':
          description: No Content
          content: {}
      security:
      - api_token: []
  /networks/{networkId}/endpoints?action=addBatch&type=SNMP:
    post:
      tags:
      - Network Endpoints
      summary: Add SNMP network endpoints
      operationId: createSnmpNetworkEndpoints
      x-position: 16
      parameters:
      - name: networkId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/NewSnmpNetworkEndpoint'
        required: true
      responses:
        '204':
          description: No Content
          content: {}
      security:
      - api_token: []
  /networks/{networkId}/endpoints?action=deleteBatch:
    post:
      tags:
      - Network Endpoints
      summary: Delete specific network endpoints
      operationId: deleteNetworkEndpoints
      x-position: 17
      parameters:
      - name: networkId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceNames'
        required: true
      responses:
        '204':
          description: No Content
          content: {}
      security:
      - api_token: []
  /networks/{networkId}/endpoints/{endpointName}:
    get:
      tags:
      - Network Endpoints
      summary: Get a network endpoint
      operationId: getNetworkEndpoint
      x-position: 19
      parameters:
      - name: networkId
        in: path
        required: true
        schema:
          type: string
      - name: endpointName
        in: path
        required: true
        schema:
          type: string
      - name: with
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - tags
            - locationId
            - testResult
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkEndpoint'
      security:
      - api_token: []
    delete:
      tags:
      - Network Endpoints
      summary: Delete a network endpoint
      operationId: deleteNetworkEndpoint
      x-position: 23
      parameters:
      - name: networkId
        in: path
        required: true
        schema:
          type: string
      - name: endpointName
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
          content: {}
      security:
      - api_token: []
  /networks/{networkId}/endpoints/{endpointName}?type=CLI:
    patch:
      tags:
      - Network Endpoints
      summary: Update a CLI network endpoint
      description: 'All JSON properties in the request body are optional. Include only the properties you wish to

        change.'
      operationId: updateCliNetworkEndpoint
      x-position: 20
      parameters:
      - name: networkId
        in: path
        required: true
        schema:
          type: string
      - name: endpointName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CliNetworkEndpointPatch'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CliNetworkEndpoint'
      security:
      - api_token: []
  /networks/{networkId}/endpoints/{endpointName}?type=HTTP:
    patch:
      tags:
      - Network Endpoints
      summary: Update an HTTP network endpoint
      description: 'All JSON properties in the request body are optional. Include only the properties you wish to

        change.'
      operationId: updateHttpNetworkEndpoint
      x-position: 21
      parameters:
      - name: networkId
        in: path
        required: true
        schema:
          type: string
      - name: endpointName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HttpNetworkEndpointPatch'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpNetworkEndpoint'
      security:
      - api_token: []
  /networks/{networkId}/endpoints/{endpointName}?type=SNMP:
    patch:
      tags:
      - Network Endpoints
      summary: Update an SNMP network endpoint
      description: 'All JSON properties in the request body are optional. Include only the properties you wish to

        change.'
      operationId: updateSnmpNetworkEndpoint
      x-position: 22
      parameters:
      - name: networkId
        in: path
        required: true
        schema:
          type: string
      - name: endpointName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnmpNetworkEndpointPatch'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnmpNetworkEndpoint'
      security:
      - api_token: []
components:
  schemas:
    NetworkEndpoints:
      type: object
      required:
      - endpoints
      properties:
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/NetworkEndpoint'
    CliEndpointProfile:
      allOf:
      - type: object
        required:
        - id
        properties:
          id:
            type: string
            description: System-assigned identifier of this endpoint profile. Always begins with "CLI-".
            examples:
            - CLI-7
      - $ref: '#/components/schemas/CliEndpointProfileDef'
    CustomOid:
      type: object
      required:
      - name
      - oid
      properties:
        name:
          type: string
          description: 'A concise name for the OID’s value. Used in the name of the file the Collector creates when it retrieves the

            OID’s value from a device. Can contain only letters, digits, underscores, and hyphens.'
          examples:
          - system_desc
        oid:
          type: string
          description: 'A numeric object identifier (OID) from the Management Information Base (MIB) for the Simple Network

            Management Protocol (SNMP).'
          examples:
          - 1.3.6.1.2.1.1.1
    CommandSet:
      type: string
      const: UNIX
    HttpEndpointProfileDef:
      type: object
      required:
      - type
      - name
      - https
      - authType
      - endpoints
      properties:
        type:
          type: string
          const: HTTP
        name:
          type: string
          description: Name of this profile ("HpPrinter", "SamsungTV", etc.)
          examples:
          - nsxt_https
        https:
          type: boolean
          description: Whether to use HTTPS to connect rather than HTTP.
          examples:
          - true
        authType:
          $ref: '#/components/schemas/HttpAuthStrategy'
          description: The type of HTTP authentication that devices of this type require for API requests.
          examples:
          - BASIC_AUTH
        headers:
          type: object
          additionalProperties:
            type: string
          description: 'HTTP headers to send in API requests to devices of this type. These headers should not contain sensitive

            data. Authentication should be handled separately if required using credentials assigned or discovered on a

            per-device basis. Use `authType` to specify what type of HTTP authentication this device type requires.'
          examples:
          - accept: application/json
        detectorUri:
          type: string
          description: 'HTTP GET URI (path and optional query string) used to detect whether a device of unknown type is this kind

            of network endpoint. If absent, the profile can be manually assigned to a network endpoint, but not

            auto-detected.'
          examples:
          - /login.jsp
        detectorPatterns:
          type: array
          items:
            type: string
          description: 'Case-insensitive glob patterns used on the response of a request to `detectorUri` to determine whether a

            device of unknown type is of this type. Absent if `detectorUri` is absent. Never empty.'
          examples:
          - - VMware NSX
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/HttpEndpoint'
          description: HTTP GET endpoints to collect from network endpoints with this profile. Never empty.
          examples:
          - - name: compute_managers
              path: /api/v1/fabric/compute-managers
            - name: logical_router_ports
              path: /api/v1/logical-router-ports
              paginationModel:
                type: OFFSET
                itemsArrayField: ports
                parameterName: page
                offsetIncrementExpression:
                  operator: PLUS_ONE
    CliNetworkEndpoint:
      allOf:
      - type: object
        required:
        - type
        - name
        - host
        properties:
          type:
            type: string
            const: CLI
          name:
            type: string
            description: 'A name that’s unique (ignoring case) among all of the network’s collection source names. May consist of

              letters, digits, dots, hyphens, and underscores.'
            examples:
            - my-endpoint
          host:
            type: string
            description: IP address or hostname used to connect to the device.
            examples:
            - 10.121.7.13
          port:
            type: integer
            format: int32
            minimum: 1
            maximum: 65535
            description: 'Port used to connect to the device. The default value depends on the collection protocol: 22 for SSH, 443

              for HTTPS, etc.'
            examples:
            - 22
          protocol:
            type: string
            description: The collection protocol to use. Defaults to SSH.
            examples:
            - SSH
            enum:
            - SSH
            - TELNET
          profileId:
            type: string
            description: ID of the endpoint profile to use. Auto-detected during connectivity testing if unspecified.
            examples:
            - CLI-7
          credentialId:
            type: string
            description: 'The `id` of a CliCredential of type `LOGIN`. Credential auto-association will be attempted using credentials

              configured to allow it if this property is unspecified and collecting from this endpoint requires this kind

              of credential.'
            examples:
            - L-3
          jumpServerId:
            type: string
            description: The `id` of the JumpServer that should be used to collect from this device.
            examples:
            - J-0
          fullCollectionLog:
            type: boolean
            description: Enables more detailed logging during collection. Defaults to false.
            examples:
            - false
          largeRtt:
            type: boolean
            description: Whether the device has a large round-trip time (requires a longer response timeout).
            examples:
            - false
          collect:
            type: boolean
            description: Whether to collect from this network endpoint. Defaults to true.
            examples:
            - true
          note:
            type: string
            description: An optional description or note about this network endpoint.
            examples:
            - Yada yada yada
      - $ref: '#/components/schemas/Attribution'
    HttpNetworkEndpointPatch:
      type: object
      properties:
        name:
          type: string
          description: 'A name that’s unique (ignoring case) among all of the network’s collection source names. May consist of

            letters, digits, dots, hyphens, and underscores. Omit to leave this property alone.'
          examples:
          - my-endpoint
        host:
          type: string
          description: IP address or hostname used to connect to the device. Omit to leave this property alone.
          examples:
          - 10.121.7.13
        port:
          type: integer
          format: int32
          minimum: 1
          maximum: 65535
          description: 'Port used to connect to the device. The default value depends on the collection protocol: 22 for SSH, 443

            for HTTPS, etc. Use `null` to clear. Omit to leave this property alone.'
          examples:
          - 22
        profileId:
          type: string
          description: 'ID of the endpoint profile to use. Auto-detected during connectivity testing if unspecified. Use `null` to

            clear. Omit to leave this property alone.'
          examples:
          - HTTP-4
        credentialId:
          type: string
          description: 'The `id` of an HttpCredential. The type of the credential must match the HttpAuthStrategy of the endpoint’s

            assigned or discovered profile (see `authType` in HttpEndpointProfileDef). Credential auto-association will

            be attempted using credentials configured to allow it if this property is unspecified and collecting from

            this endpoint requires this kind of credential. Use `null` to clear. Omit to leave this property alone.'
          examples:
          - H-5
        disableSslValidation:
          type: boolean
          description: 'Whether to skip TLS validation. Can be useful for an endpoint whose certificate isn’t trusted. Not

            recommended. Defaults to false. Use `null` to clear. Omit to leave this property alone.'
          examples:
          - false
        collect:
          type: boolean
          description: 'Whether to collect from this network endpoint. Defaults to true. Use `null` to clear. Omit to leave this

            property alone.'
          examples:
          - true
        note:
          type: string
          description: 'An optional description or note about this network endpoint. Use `null` to clear. Omit to leave this

            property alone.'
          examples:
          - Yada yada yada
    ConnectivityTestError:
      type: string
      enum:
      - PING_FAILED
      - PORT_REACHABILITY_FAILED
      - UNSUPPORTED_SSH_PROTOCOL
      - CONNECTION_FAILED
      - PROMPT_DISCOVERY_FAILED
      - AUTHENTICATION_FAILED
      - TWO_FACTOR_AUTHENTICATION_FAILED
      - KEY_EXCHANGE_FAILED
      - UNEXPECTED_KEY_EXCHANGE_MESSAGE
      - CERTIFICATE_CHECK_FAILED
      - PASSWORD_EXPIRED
      - JUMP_SERVER_PING_FAILED
      - JUMP_SERVER_PORT_REACHABILITY_FAILED
      - JUMP_SERVER_CONNECTION_FAILED
      - JUMP_SERVER_AUTHENTICATION_FAILED
      - JUMP_SERVER_KEY_EXCHANGE_FAILED
      - JUMP_SERVER_PASSWORD_EXPIRED
      - PROXY_SERVER_PING_FAILED
      - PROXY_SERVER_PORT_REACHABILITY_FAILED
      - PROXY_SERVER_CONNECTION_FAILED
      - PROXY_SERVER_AUTHENTICATION_FAILED
      - SERVER_FINGERPRINT_CHECK_FAILED
      - SESSION_LIMIT_REACHED
      - DEVICE_TYPE_MISMATCH
      - DEVICE_TYPE_UNDETECTED
      - SESSION_CLOSED
      - PRIV_PASSWORD_ERROR
      - EXPERT_PASSWORD_ERROR
      - DEVICE_IS_CHILD_CONTEXT
      - GUEST_MISSING_HOST_RESULTS
      - HOST_MISSING_GUEST_RESULTS
      - HOST_NOT_REPORTING_ANY_GUEST
      - GUEST_NOT_REPORTING_ANY_NAME
      - UNSUPPORTED_VERSION
      - AVI_SHELL_AUTH_FAILED
      - KEY_BASED_ACCESS_TO_AVI_CONTAINER_FAILED
      - AVI_SERVICE_ENGINE_DISCOVERED
      - AVI_VIA_LINUX_OVER_JUMP_SERVER_UNSUPPORTED
      - AVI_CONTROLLER_WITHOUT_HEALTHY_SERVICE_ENGINES
      - T128_CONDUCTOR_WITHOUT_HEALTHY_ROUTERS
      - API_CALL_FAILED
      - CHECKPOINT_MANAGER_FOUND
      - AUTHORIZATION_FAILED
      - INCOMPLETE_AUTHORIZATION_CHECK
      - CUSTOM_COMMAND_AUTHORIZATION_FAILED
      - TACACS_SESSION_EXPIRED
      - AZURE_SUBSCRIPTION_NOT_FOUND
      - TIMED_OUT
      - DEVICE_IN_BAD_STATE
      - PROJECT_VIEW_PERMISSION_MISSING
      - UNSUPPORTED_DEVICE_TYPE
      - LIMITED_DEVICE_SUPPORT
      - SLOW_READ_RATE
      - TRANSIENT_SLOW_READ_RATE_DETECTED
      - NO_SPACE_LEFT_ON_COLLECTOR
      - NO_SPACE_LEFT_ON_COLLECTED_DEVICE
      - VERSA_DIRECTOR_DISCOVERED
      - DEVICE_PROTOCOL_MISMATCH
      - API_SERVER_FAILED_TO_RESPOND
      - UNRESOLVABLE_HOSTNAME
      - UNSUPPORTED_SSL_CONNECTION
      - PASSWD_DISCOVERY_ON_INSECURE_PROTOCOL
      - INCOMPLETE_SETUP
      - CONFIG_COLLECTION_UNAUTHORIZED
      - FILE_TRANSFER_FAILED
      - VELOS_CONTROLLER_DISCOVERED
      - CANCELED
      - OTHER
    CliEndpointProfileDef:
      type: object
      required:
      - type
      - name
      properties:
        type:
          type: string
          const: CLI
        name:
          type: string
          description: Name of this profile ("HpPrinter", "SamsungTV", etc.).
          examples:
          - sentry_pdu_ssh
        detectorCommand:
          type: string
          description: 'CLI command to run to detect a network endpoint of this type. If absent, the profile can be manually

            assigned to a network endpoint, but not auto-detected.'
          examples:
          - version
        detectorPatterns:
          type: array
          items:
            type: string
          description: 'Patterns matching on output of `detectorCommand` to determine whether the device is of this type. Absent if

            `detectorCommand` is absent. Never empty.'
          examples:
          - - Sentry Switched PDU
        detectorErrorPatterns:
          type: array
          items:
            type: string
          description: Patterns matching an error message if a device doesn’t recognize `detectorCommand`.
          examples:
          - - Invalid command
            - 'Switched PDU commands:'
        nameDetectorCommand:
          type: string
          description: 'Command to use to detect the name of a network endpoint of this type. If absent, the name cannot be

            detected.'
          examples:
          - show network
        nameDetectorPatterns:
          type: array
          items:
            type: string
          description: 'Glob patterns used to extract the device name from the output of `nameDetectorCommand`. The word immediately

            after a matched glob pattern is the desired name. If no glob patterns are specified, the first word/token in

            the `nameDetectorCommand` output will be used.'
          examples:
          - - FQDN:*enabled
        prompt:
          type: string
          description: 'A case-insensitive glob pattern used to identify an interactive console menu prompt. When this pattern

            matches the end of the prompt, ignoring any trailing whitespace, the Collector will enter the configured

            `promptResponse`.'
          examples:
          - y/n
        promptResponse:
          type: string
          description: 'What the Collector should enter in response to an interactive console menu prompt matching `prompt` in order

            to proceed. Required if `prompt` is set.'
          examples:
          - y
        pagePrompt:
          type: string
          description: 'Case-insensitive glob pattern used to identify a new page banner. Works like `prompt`. If the device doesn’t

            generate paginated command output or if paging is like the “more” command, omit this property.'
          examples:
          - continue\?
        pagePromptResponse:
          type: string
          description: 'What the Collector should enter in response to an interactive pagination prompt detected via `pagePrompt` in

            order to proceed. Required if `pagePrompt` is set.'
          examples:
          - c
        ptyType:
          type: string
          description: Device’s terminal type ("xterm-256color", "vt100", etc.).
          examples:
          - vt100
        ptyColumnSize:
          type: integer
          format: int32
          description: Column size of the output. Defaults to 500.
          examples:
          - 240
        clearPrompt:
          type: string
          description: 'Command to clear the prompt. Can be specified like "ctrl-[a-z]" or "ctrl+[a-z]". Defaults to

            "ctrl+c".'
          examples:
          - ctrl+z
        responseTimeoutSec:
          type: integer
          format: int32
          description: Timeout in seconds applied to this profile’s CLI commands run during discovery and collection.
          examples:
          - 15
        commandSets:
          type: array
          items:
            $ref: '#/components/schemas/CommandSet'
          description: 'Predefined command sets to run on network endpoints with this profile. The "UNIX" set includes the commands

            "ifconfig", "netstat -ln", "hostname", and "uname -a".'
          examples:
          - - UNIX
        customCommands:
          type: array
          items:
            type: string
          description: 'Additional commands to run on network endpoints with this profile. Commands should be

            read-only.'
          examples:
          - - uptime
            - iptables -L
    SnmpNetworkEndpointPatch:
  

# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/forward-networks/refs/heads/main/openapi/forward-networks-network-endpoints-api-openapi.yml