shadwshadw/Docs
GuidesAPIGetting Started
Dashboard
shadw REST APIOverviewErrors
  • GETGet the overview
  • GETGet logs
  • GETGet cluster resources
APIs & SDKs/shadw REST API/Get the overview

Get the overview

GEThttps://api.shadw.cloud/v1/overview

Platform overview: deployments, regions, request counters and WAF status.

Authentication

AuthorizationbearerToken

A platform API key (hive_…, created under Settings → API Keys) or a short-lived JWT minted with POST /v1/token. An API key scopes the request to the team it was created under.

ts
const response = await fetch('https://api.shadw.cloud/v1/overview', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY', // hive_… (Settings → API Keys)
  },
});

const data = await response.json();
console.log(data);
Response
json
{ "deployments": 12, "regions": ["los-angeles"], "requests": 90210 }