API for Google Wifi and OnHub; mostly untested

Google-Wifi-API.md

Endpoints

• http://onhub.here/api/v1/diagnostic-report
• http://onhub.here/api/v1/get-attestation-information
• http://onhub.here/api/v1/get-endorsement-information
• http://onhub.here/api/v1/get-shmac
• http://onhub.here/api/v1/join-group
• http://onhub.here/api/v1/prove-identity
• http://onhub.here/api/v1/register-device
• http://onhub.here/api/v1/prepare-for-setup
• http://onhub.here/api/v1/status
• http://onhub.here/api/v1/submit-feedback
• http://onhub.here/api/v1/wan-configuration
• http://onhub.here/api/v1/vorlon-registration-complete
• http://onhub.here/api/v1/vorlon-registration-info

Arbitrary error response

• Content-Type: application/json
• Body:
  • error: string
  • code: int32

Endpoint details

get-attestation-information

• URL: http://onhub.here/api/v1/get-attestation-information
• Methods: GET
• Purpose: ?

Request

• GET
  • (none)

Response

• GET; in testing:
  • Content-Type: text/plain
  • Status: 403
  • Body: Device is registered

get-endorsement-information

• URL: http://onhub.here/api/v1/get-endorsement-information
• Methods: GET
• Purpose: ?

Request

• GET
  • (none)

Response

• GET; in testing:
  • Content-Type: text/plain
  • Status: 403
  • Body: Device is registered

prepare-for-setup

• URL: http://onhub.here/api/v1/prepare-for-setup
• Methods: ?
• Purpose: Resets mesh credentials

Request

• POST
  • Content-Type: application/json
  • Body: empty JSON object ({})

Response

• POST
  • ?

wan-configuration

• URL: http://onhub.here/api/v1/wan-configuration
• Methods: GET, POST
• Purpose: Get or change WAN settings

Request

• GET
  • (empty)
• POST
  • Content-Type: application/json
  • Body:
    • type: string; one of:
      • pppoe
      • static
      • dhcp
    • (see below for others)

Set PPPoE

• type: string; "pppoe"
• username: string
• password: string

Set static IP address

• type: string; "static"
• ipAddress: string
• netmask: string
• gateway: string

Set DHCP

• type: string; "dhcp"

Response

• GET
  • Content-Type: application/json
  • Returns the type property of the current configuration; all other properties are omitted
  • Body:
    • type: string
• POST
  • ?

diagnostic-report

• URL: http://onhub.here/api/v1/diagnostic-report
• Methods: GET
• Connect timeout: 5 sec
• Read timeout: 1 min
• Purpose: ?
• Headers:
  • X-XSRF-Protection: 1

Request

• GET
  • ?

Response

• GET
  • ?

submit-feedback

• URL: http://onhub.here/api/v1/submit-feedback
• Methods: POST
• Purpose: ?

Request

• POST
  • Content-Type: application/json
  • Body: ?

Response

• POST
  • ?

join-group

• URL: http://onhub.here/api/v1/join-group
• Methods: POST
• Timeout: 30 sec
• Purpose: ?

Request

• POST
  • Content-Type: application/json
  • Body:
    • groupConfiguration: string
    • kek: string
    • mac: string

Response

• POST
  • ?

prove-identity

• URL: http://onhub.here/api/v1/prove-identity
• Methods: POST
• Purpose: ?

Request

• POST
  • Content-Type: application/x-protobuf
  • Body: ?

Response

• POST
  • ?

register-device

• URL: http://onhub.here/api/v1/register-device
• Methods: POST
• Timeout: 25 sec
• Purpose: ?

Request

• POST
  • Content-Type: application/json
  • Body:
    • ticketId: string
    • displayName: string

Response

status

• URL: http://onhub.here/api/v1/status
• Methods: GET
• Purpose: Retrieve detailed status information

Request

• GET
  • Querystring parameters:
    • type: string; optional; one of:
      • wan
      • system
      • software
      • "" (empty string): triggers a connection check

Response

Note: If type was specified as a querystring parameter, the resulting JSON object will be filtered to only include the corresponding key/value. For example, if requested with ?type=software, the response will resemble {"software":{...}}.

• software
  • softwareVersion: string
  • updateChannel: string; e.g. "stable-channel"
  • updateNewVersion: string; if no update, "0.0.0.0"
  • updateProgress: double; if no update in progress, 0.0
  • updateRequired: boolean
  • updateStatus: string; one of:
    • checking
    • downloading
    • idle
    • unknown
    • updated
    • updating
    • waiting
• system
  • countryCode: string; e.g. "us"
  • groupRole: string; e.g. "root"
  • hardwareId: string
  • lan0Link: boolean
  • modelId: string
  • uptime: int
• vorlonInfo
  • migrationMode: string; e.g. "vorlon_all"
• wan
  • captivePortal: boolean
  • ethernetLink: boolean
  • gatewayIPAddress: boolean; WAN default gateway
  • invalidCredentials: boolean
  • ipAddress: boolean
  • ipMethod: string; probably one of:
    • dhcp
    • static
    • pppoe
  • ipPrefixLength: int; e.g. 24
  • leaseDurationSeconds: int; e.g. 86400
  • localIpAddress: string; WAN IP address of Google Wifi
  • nameservers: string[]; WAN nameservers advertised by DHCP
  • online: boolean
  • pppoeDetected: boolean

connected-devices

• URL: http://onhub.here/api/v1/connected-devices
• Methods: GET
• Purpose: Probably used to discover home automation devices like Philips Hue bridges
• Note: I couldn't actually find this in the APK, but it definitely exists.

Request

• GET
  • ?

Response

• GET
  • Content-Type: application/json
  • Body:
    • _hueBridges: array
      • ?

get-shmac

• URL: http://onhub.here/api/v1/get-shmac
• Methods: GET
• Timeout: 500 ms
• Purpose: Retrieves a station's ID by IP address

Request

• GET
  • Content-Type: application/json (ignored)
  • Body: (none)
  • Querystring parameters:
    • ip: string; station's IP address

Response

• GET
  • Content-Type: application/json
  • Body:
    • id: string; 64-digit hex identifier for station

vorlon-registration-complete

• URL: http://onhub.here/api/v1/vorlon-registration-complete
• Methods: POST
• Purpose: ?

Request

• POST
  • Content-Type: application/json
  • Body: (empty JSON object?)

Response

• POST
  • ?

vorlon-registration-info

• URL: http://onhub.here/api/v1/vorlon-registration-info
• Methods: GET
• Purpose: ?

Request

• GET
  • empty

Response

• GET
  • Content-Type: text/plain
  • Body:
    • Only known possible value:
      • Device is already setup