Common Resources v1.0
Created Dec 18, 2020 at 07:09 PM

Resource: auth_info

Information that may be necessary to properly authenticate to the device.

http://{device}/api/common/1.0/auth_info
  • JSON
  • {
      "login_banner": string,
      "specify_purpose": boolean,
      "supported_methods": [
        string
      ]
    }
    Property Name Type Description Notes
    auth_info <object> Information that may be necessary to properly authenticate to the device.
    auth_info.login_banner <string> A free-form text string that should be displayed to the user prior to logging in, ala /etc/issue on UNIX systems Optional;
    auth_info.specify_purpose <boolean> Indicates whether or not this device can make use of the purpose string when logging in Optional;
    auth_info.supported_methods <array of <string>> List of supported authentication methods Optional;
    auth_info.supported_methods[items] <string> A supported authentication method Values: BASIC, COOKIE, OAUTH_2_0;

    Resource: info

    Device Info

    http://{device}/api/common/1.0/info
  • JSON
  • {
      "device_name": string,
      "hw_version": string,
      "mgmt_addresses": [
        string
      ],
      "model": string,
      "serial": string,
      "sw_version": string
    }
    Property Name Type Description Notes
    info <object> Device Info Required properties: [device_name, model, sw_version];
    info.device_name <string> Device name
    info.hw_version <string> Device hardware version (if applicable) Optional;
    info.mgmt_addresses <array of <string>> IP addresses configured/assigned to the management interface(s) of this device. Optional;
    info.mgmt_addresses[items] <string> One management IP address
    info.model <string> Device model
    info.serial <string> Device serial number (if applicable) Optional;
    info.sw_version <string> Device software version

    Resource: ping

    Safe resource for determining if the system is running.

    http://{device}/api/common/1.0/ping
  • JSON
  • {
    }
    Property Name Type Description Notes
    ping <object> Safe resource for determining if the system is running.

    Resource: services

    Available services on this device

    http://{device}/api/common/1.0/services
  • JSON
  • [
      {
        "id": string,
        "versions": [
          string
        ],
        <prop>: any
      }
    ]
    Property Name Type Description Notes
    services <array of <object>> Available services on this device
    services[items] <object> One service
    services[items].id <string> Service identifier / namespace Optional;
    services[items].versions <array of <string>> API versions supported Optional;
    services[items].versions[items] <string> One service version
    services[items].<prop> <any> Optional;

    Resource: session_auth

    Authentication via session-based cookies

    http://{device}/api/common/1.0/login
  • JSON
  • {
    }
    Property Name Type Description Notes
    session_auth <object> Authentication via session-based cookies