DEVELOPER TOOLS
Check a GitHub Account's Health API
Check whether a GitHub token still authenticates and whether its account has been suspended. Returns the account's login/id and a verdict (active / suspended / auth-expired / forbidden). Bring your own GitHub token: it is used for this one call, never stored; sent only to api.github.com.
Last updated
How to call it
Send one POST to api.upapi.io/github-account-health.get with your key in the X-Api-Key header and the parameters below as a JSON body. Each call spends 1 weighted unit of your monthly quota. The operation times out after 30 seconds. Responses are not cached; every call runs the operation.
POST https://api.upapi.io/github-account-health.get
Check a GitHub Account's Health API reference
Request parameters
- token
- stringrequired — GitHub token of the account to health-check
- proxyUrl
- string — Optional proxy URL. Use the same one across related calls when the upstream expects a consistent IP.
Response fields
- login
- string — The authenticated account's login
- verdict
- stringrequired — active | suspended | auth-expired | forbidden
- accountId
- integer — The account's numeric GitHub id
- checkedAt
- stringrequired
- createdAt
- string — Account creation timestamp
- rateLimit
- object — Rate-limit block from the /user response, when one was received
- twoFactorAuthentication
- boolean — Whether 2FA is enabled (only present when the token can read it)
Example request and response
The example response is generated from this operation’s published output schema — it shows the shape and field names, not values from a recorded call.
{
"token": "example"
}{
"login": "example",
"verdict": "example",
"accountId": 1,
"checkedAt": "example",
"createdAt": "example",
"rateLimit": {
"limit": 5,
"resetAt": "example",
"resource": "example",
"remaining": 1,
"resetEpoch": 1
},
"twoFactorAuthentication": false
}Code snippets
cURL
curl -X POST https://api.upapi.io/github-account-health.get \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY' \
-d '{ "token": "example" }'JavaScript
const response = await fetch('https://api.upapi.io/github-account-health.get', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'YOUR_API_KEY',
},
body: JSON.stringify({
"token": "example"
}),
});
const data = await response.json();
console.log(data);Python
import requests
response = requests.post(
'https://api.upapi.io/github-account-health.get',
headers={
'Content-Type': 'application/json',
'x-api-key': 'YOUR_API_KEY',
},
json={
"token": "example"
},
)
print(response.json())Go
package main
import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
)
func main() {
payload := []byte(`{ "token": "example" }`)
req, _ := http.NewRequest("POST", "https://api.upapi.io/github-account-health.get", bytes.NewBuffer(payload))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("x-api-key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
var result map[string]any
json.Unmarshal(body, &result)
fmt.Println(result)
}PHP
<?php
$payload = json_encode([
'token' => 'example',
]);
$ch = curl_init('https://api.upapi.io/github-account-health.get');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $payload,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'x-api-key: YOUR_API_KEY',
],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
var_dump($data);Ruby
require 'net/http'
require 'uri'
require 'json'
uri = URI('https://api.upapi.io/github-account-health.get')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'
request = Net::HTTP::Post.new(uri.path)
request['Content-Type'] = 'application/json'
request['x-api-key'] = 'YOUR_API_KEY'
request.body = { "token": "example" }.to_json
response = http.request(request)
puts JSON.parse(response.body)Java
import okhttp3.*;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
OkHttpClient client = new OkHttpClient();
ObjectMapper mapper = new ObjectMapper();
String json = "{ \"token\": \"example\" }";
RequestBody body = RequestBody.create(json, MediaType.get("application/json"));
Request request = new Request.Builder()
.url("https://api.upapi.io/github-account-health.get")
.post(body)
.addHeader("Content-Type", "application/json")
.addHeader("x-api-key", "YOUR_API_KEY")
.build();
try (Response response = client.newCall(request).execute()) {
Map<?, ?> result = mapper.readValue(response.body().string(), Map.class);
System.out.println(result);
}C#
using System.Net.Http;
using System.Net.Http.Json;
using System.Text.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
var payload = JsonSerializer.Deserialize<object>("{ \"token\": \"example\" }");
var response = await client.PostAsJsonAsync("https://api.upapi.io/github-account-health.get", payload);
var result = await response.Content.ReadFromJsonAsync<JsonElement>();
Console.WriteLine(result);Frequently asked questions
How much does the Check a GitHub Account's Health API cost per call?
Each call spends 1 weighted unit of your plan's monthly quota. Full pricing is at https://upapi.io/pricing.
How do I authenticate to the Check a GitHub Account's Health API?
Send your key in the X-Api-Key header. A free guest key is available without creating an account.
Are Check a GitHub Account's Health API responses cached?
No — every call runs the operation live; responses are not cached.