Aethir
  • Executive Summary
  • Aethir Introduction
    • Key Features
    • Aethir Token ($ATH)
    • Important Links
    • FAQ
  • Aethir Network
    • The Container
      • Staking and Rewards
    • The Checker
      • Proof of Capacity and Delivery
    • The Indexer
    • Session Dynamics
    • Service Fees
  • Aethir Tokenomics
    • Token Overview
    • Token Distribution of Aethir
    • Token Vesting
    • ATH Token’s Utility & Purpose
    • Compute Rewards
    • Compute Reward Emissions
    • ATH Circulating Supply
    • Complete KYC Verfication
  • Aethir Staking
    • Staking User How-to Guide
    • Staking Key Information
    • Pre-deposit How-To Guide
    • Pre-deposit Vault - Reward Mechanics
    • Eigen Pre-deposit FAQ's
    • Staking Pools Emission Schedule for ATH
  • Aethir Ecosystem
    • CARV Rewards for Aethir Gaming Pool Stakers
  • Aethir Governance
    • Aethir Foundation Bylaws
  • Checker Guide
    • What is the Checker Node
      • How do Checker Nodes Work
      • What is the Checker Node License (NFT)
    • How to Purchase Checker Nodes
      • How to purchase using Arbiscan
      • Checker Node Sale Dynamics
        • Node Purchase Caps
        • Smart Contract Addresses
      • FAQ
        • General
        • Node Sale Tiers & Whitelists
        • User Discounts & Referrals
    • How to Manage Checker Nodes
      • Quick Start
      • Connect Wallet
      • Delegate & Undelegate
        • Virtual Private Servers (VPS) and Node-as-a-Service (NaaS) Provider
      • View Rewards
      • Claim & Withdraw
      • Dashboard
      • FAQ
      • API for Querying License Rewards
    • How to Run Checker Nodes
      • What is a Checker Node Client
        • Who can run a Checker Node Client
        • What is the hardware requirements for running Checker Node Client
        • The Relationship between Checker License Owner and Checker Node Operator
      • Quick Start
      • Install & Update
      • Create or Import a Burner Wallet
      • Export Burner Wallet
      • View License Status
      • Accept/Deny Pending Delegations & Undelegate
      • Set Capacity Limit
      • FAQ
      • API for Querying Client Status
    • Checker Node NFT Buyback Program
      • Checker Node NFT Buyback Program
      • Checker Node NFT Buyback Program FAQs
    • Operator Portal
      • Connect Wallet
      • Manage Burner Wallets
      • View Rewards
      • View License Status
      • FAQ
    • Support
    • Release Notes
      • July 5, 2024
      • July 8, 2024
      • July 9, 2024
      • July 12, 2024
      • July 17, 2024
      • July 25, 2024
      • August 5, 2024
      • August 9, 2024
      • August 28, 2024
      • October 8, 2024
      • October 11, 2024
      • November 4, 2024
      • November 15, 2024
      • November 28, 2024
      • December 10, 2024
      • January 14, 2025
      • April 7, 2025
  • Staking and Rewards for Cloud Host (Compute Providers)
    • Staking as a Cloud Host
    • Rewards For Cloud Host
    • Service Fees
    • Slashing Mechanism
    • Key Terms and Concepts
    • K Value Table
    • Acquiring ATH for Cloud Host Staking
    • Bridging ATH for Cloud Host Staking (ETH to ARB)
  • Aethir Cloud Host Guide
    • Role of a Cloud Host
    • Why Provide GPU Compute on Aethir
    • What is Aethir Earth (AI)
      • Operational Requirements (Aethir Earth)
    • What is Aethir Atmosphere (Cloud Gaming)
    • How to Provide GPU Compute
      • Manage Your ATH Rewards (Wallet)
      • How to Provide Aethir Earth (AI)
      • How to Provide Aethir Atmosphere (Cloud Gaming)
    • Miscellaneous
      • Manage Orders
      • System Events
  • Aethir Cloud Customer Guide
    • What is Aethir Cloud
      • Aethir Earth Service Guide
    • Why Use Aethir Cloud
    • Dashboard
    • How to Rent an Aethir Earth Server
    • How to Deploy Your Game on Aethir Atmosphere
      • Add Game and Versions
      • Deploy(On-Demand)
      • Deploy(Reserved)
    • Manage Your Wallet
    • Miscellaneous
      • Manage Orders
  • Aethir Ecosystem Fund
  • Users & Community
    • User Portal (UP) Guide
  • Protocol Roadmap
  • Terms of Service
    • Privacy Policy
    • Aethir General Terms of Service
    • Aethir Staking Terms of Service
    • Airdrop Terms of Service
  • Whitepaper
Powered by GitBook
On this page
  • Prerequisite
  • Query Client Online Status
  1. Checker Guide
  2. How to Run Checker Nodes

API for Querying Client Status

PreviousFAQNextChecker Node NFT Buyback Program

Last updated 4 months ago

This feature is currently only available to NaaS partners, enabling efficient querying of the status of multiple clients in bulk.

Prerequisite

Please make sure you obtain x-ak & x-sk issued by Aethir.

Query Client Online Status

Description

This interface is used to query whether the client is online.

URL

Method

POST

Rate Limit

Each x-ak can make a request every 5 seconds.

Request Headers

Header
Type
Mandatory

x-ak

string

Yes

x-op-token

string

Yes

x-ak is a verification code issued to qualified partner Node Operators.

x-op-token is consists of three parts

x-op-token = header.payload.signature
  • Header

    A compact JSON string encoded with base64, representing the header.

    {
      "alg": "HS256",  // Encryption algorithm, fixed as HS256
      "typ": "CHK_OP"  // Token type, fixed as CHK_OP
    }
  • Payload

    A compact JSON string encoded with base64, representing the payload.

    {
      "ak": "",       // Issued to nodeOperator's AK
      "exp": 1,       // Token expiration timestamp in ms, configured by the user
      "ip": "",       // Client IP
      "nonce": 1      // Random number generated by the user
    }
  • Signature

    signature = base64UrlEncode(HmacSHA256.sign(base64UrlEncode(header) + "." + base64UrlEncode(payload), sk))

    where skis a verification code issued to qualified partner Node Operators.

Request Body

The request body is an array of clientId, supporting a maximum of 100 IDs.

[
  "clientId1",
  "clientId2",
  ...
]

Response

Possible responses and their corresponding meanings are:

  • HttpStatus 200: Query successful; the query result is parsed in the HttpResponseBody.

  • HttpStatus 401: The client needs to regenerate the x-op-token and retry the query.

Response Body

[
  {
    "clientId": "clientId1",
    "onLineState": 1
  }
]
Field
Type
Description

clientId

string

Client ID

onLineState

int

1: Online, 0: Offline

HttpStatus 400: The x-op-token format is incorrect or exceeded.

https://app.aethir.com/console-api/v2/client/onLineState
rate limit