Vendor Status Page
Reads a vendor's public status page and returns its overall state, open incidents with their latest update, scheduled maintenance and affected components.
- Price per call
- 1 credit
- per successful call
- Price ceiling
- 1 credit
- every call, same price
- Failed calls
- Free
- retried automatically
- Billed
- Per call
- only on success
Endpoint
api.primaryapi.com/ v1/ run/ vendor. statusAuth: API key with run or full access, or a dashboard session
Send the input below as a JSON body. The call is routed to a healthy upstream; if an attempt fails, it is retried automatically inside the same request and you pay only for the answer you get. To check an input and see the exact price without running anything, call POST /v1/quote/vendor.status with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/vendor.status" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"vendor":"github"}'const res = await fetch('https://api.primaryapi.com/v1/run/vendor.status', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
vendor: 'github',
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/vendor.status",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"vendor": "github",
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"]){
"name": "run_api",
"arguments": {
"sku": "vendor.status",
"input": {
"vendor": "github"
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/vendor.status" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"vendor":"github"}'Returns credits (what the call is expected to cost) and maxCredits (the most it can cost, which is set aside while it runs). Invalid input fails here the same way it would on run.
Input
JSON body fields. Unknown fields are rejected with 400 invalid_input (never silently ignored). You may add the routing controls preferLatencyUnderMs and maxCredits to the same object.
vendorstringrequired- Status page URL ("https://www.githubstatus.com"), a known vendor ("github", "openai", "aws"), or the vendor's domain ("stripe.com" works only when it is in the built-in list).max 2048 chars
includeComponentsbooleandefaultfalse- Also return every component with its status (large pages list hundreds).
Output
When output.found is true, output.data has these fields.
vendorstring | null- Registry key when the input matched a known vendor ("github"), else null.
namestring- Name the status page gives itself.
pageUrlstringpageTypeenum- Status page format that was read.one of: statuspage, incident_io, instatus, betterstack, google_cloud, aws, azure
indicatorenum- Overall state: operational, minor (degraded), major (partial or major outage), critical, maintenance.one of: operational, minor, major, critical, maintenance, unknown
descriptionstring | null- The page's own overall status text, e.g. "All Systems Operational".
incidentsobject[]- Unresolved incidents, newest first.
incidents[].idstringincidents[].namestringincidents[].statusstring- The page's own incident status, lower-cased (investigating, identified, monitoring, …).
incidents[].impactenum- Normalised impact (pages without an impact field report unknown).one of: none, minor, major, critical, maintenance, unknown
incidents[].startedAtstring | nullincidents[].updatedAtstring | null- Time of the latest published update.
incidents[].urlstring | nullincidents[].latestUpdatestring | null- Text of the latest published update, trimmed to 1,000 characters.
incidents[].componentsstring[]- Affected component names, sorted.
incidentsAvailableboolean- false when the page does not publish incidents in machine-readable form (only component states are known).
maintenancesobject[]- Maintenance in progress or scheduled, soonest first.
maintenances[].idstringmaintenances[].namestringmaintenances[].statusstring- scheduled, in_progress, verifying, …
maintenances[].scheduledForstring | nullmaintenances[].scheduledUntilstring | nullmaintenances[].urlstring | nullmaintenances[].componentsstring[]affectedComponentsobject[]- Components that are not operational, sorted by group and name.
affectedComponents[].namestringaffectedComponents[].groupstring | null- Parent group / section name, when the page groups components.
affectedComponents[].statusenum- Normalised component status.one of: operational, degraded_performance, partial_outage, major_outage, under_maintenance, unknown
componentCountintegercomponentsobject[] | null- Every component (sorted) when includeComponents=true, else null.
components[].namestringcomponents[].groupstring | null- Parent group / section name, when the page groups components.
components[].statusenum- Normalised component status.one of: operational, degraded_performance, partial_outage, major_outage, under_maintenance, unknown
TypeScript type
/** output.data when output.found is true */
type VendorStatus = {
/** Registry key when the input matched a known vendor ("github"), else null. */
vendor: string | null;
/** Name the status page gives itself. */
name: string;
pageUrl: string;
/** Status page format that was read. */
pageType: "statuspage" | "incident_io" | "instatus" | "betterstack" | "google_cloud" | "aws" | "azure";
/** Overall state: operational, minor (degraded), major (partial or major outage), critical, maintenance. */
indicator: "operational" | "minor" | "major" | "critical" | "maintenance" | "unknown";
/** The page's own overall status text, e.g. "All Systems Operational". */
description: string | null;
/** Unresolved incidents, newest first. */
incidents: {
id: string;
name: string;
/** The page's own incident status, lower-cased (investigating, identified, monitoring, …). */
status: string;
/** Normalised impact (pages without an impact field report unknown). */
impact: "none" | "minor" | "major" | "critical" | "maintenance" | "unknown";
startedAt: string | null;
/** Time of the latest published update. */
updatedAt: string | null;
url: string | null;
/** Text of the latest published update, trimmed to 1,000 characters. */
latestUpdate: string | null;
/** Affected component names, sorted. */
components: string[];
}[];
/** false when the page does not publish incidents in machine-readable form (only component states are known). */
incidentsAvailable: boolean;
/** Maintenance in progress or scheduled, soonest first. */
maintenances: {
id: string;
name: string;
/** scheduled, in_progress, verifying, … */
status: string;
scheduledFor: string | null;
scheduledUntil: string | null;
url: string | null;
components: string[];
}[];
/** Components that are not operational, sorted by group and name. */
affectedComponents: {
name: string;
/** Parent group / section name, when the page groups components. */
group: string | null;
/** Normalised component status. */
status: "operational" | "degraded_performance" | "partial_outage" | "major_outage" | "under_maintenance" | "unknown";
}[];
componentCount: number;
/** Every component (sorted) when includeComponents=true, else null. */
components: {
name: string;
/** Parent group / section name, when the page groups components. */
group: string | null;
/** Normalised component status. */
status: "operational" | "degraded_performance" | "partial_outage" | "major_outage" | "under_maintenance" | "unknown";
}[] | null;
};If what you asked about does not exist, is private, or a search matches nothing, the call still succeeds: output.found is false, output.data is null and output.reason says why. Such misses are free unless the notes below say misses are billed, in which case a miss costs the price of one call.
Example response
Values are placeholders that follow the output schema (strings as "string", numbers as 0); credits shows what this call would cost at the usual price.
{
"output": {
"found": true,
"data": {
"vendor": "github",
"name": "string",
"pageUrl": "https://example.com",
"pageType": "statuspage",
"indicator": "operational",
"description": "string",
"incidents": [
{
"id": "string",
"name": "string",
"status": "string",
"impact": "none",
"startedAt": "string",
"updatedAt": "string",
"url": "https://example.com",
"latestUpdate": "string",
"components": [
"string"
]
}
],
"incidentsAvailable": true,
"maintenances": [
{
"id": "string",
"name": "string",
"status": "string",
"scheduledFor": "string",
"scheduledUntil": "string",
"url": "https://example.com",
"components": [
"string"
]
}
],
"affectedComponents": [
{
"name": "string",
"group": "string",
"status": "operational"
}
],
"componentCount": 0,
"components": [
{
"name": "string",
"group": "string",
"status": "operational"
}
]
}
},
"provider": "PrimaryAPI",
"credits": 1,
"items": 1,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}Pricing and reliability
Calls go only to upstreams that are healthy right now. If an attempt fails, the call is retried automatically inside the same request; a failed attempt costs nothing, and a call never costs more than its quote’s maxCredits. Live figures below are measured on real traffic.
Success rate, uptime, latency and call counts are measured live from real traffic over 30 days and show “—” until there is data.
Errors
Errors are JSON { code, error, requestId } and are never charged. The ones to handle for this endpoint:
- invalid_inputThe request failed validation before anything ran.
- unauthorizedNo valid API key or session was presented.
- insufficient_balanceThe balance cannot cover the most this call could cost.
- key_limit_reachedThe key’s own spend limit is used up for the current window.
- trial_cap_reachedAn agent trial key has used its whole trial budget.
- forbiddenThe credential is valid but may not do this.
- not_foundThe thing addressed by the URL does not exist for you.
- idempotency_conflictThe
Idempotency-Keyis already bound to a different request. - rate_limitedToo many requests in the current window.
- all_sources_failedThe call could not be answered, even after automatic retries.
- service_unavailableThis API cannot run in this deployment right now.
- timeoutThe request passed its deadline before it finished.
Notes
An unknown vendor name, or a URL that is not a supported status page, is a free miss (reason not_a_status_page or unknown_vendor). Sorted output without fetch timestamps: a monitor fires when an incident opens, updates or resolves, or a component changes state.
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/vendor.status.