Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account

get

account.get Read the account the token belongs to, with its name and primary email Risk: read
Input: empty object Output

usage

account.usage Read the account quota and how much of it is used, for errors, uptime and check-ins Risk: read
Input: empty object Output

Check Ins

create

checkIns.create Create a check-in on a simple period or a cron schedule; a simple schedule needs report_period and a cron schedule needs cron_schedule Risk: write
Input A simple schedule needs report_period. A cron schedule needs cron_schedule and takes the web app timezone name, not an IANA identifier. Output

delete

checkIns.delete Delete a check-in, which stops monitoring that scheduled job Risk: destructive · Irreversible
Input Output

events

checkIns.events List a check-in’s state changes newest first, paging backwards on a timestamp Risk: read
Input Output

get

checkIns.get Read one check-in with its schedule, last report and next expected report Risk: read
Input Output

list

checkIns.list List a project’s check-ins with their state and next expected report Risk: read
Input Output

replace

checkIns.replace Replace the project’s whole set of check-ins by slug; every check-in the list does not name is deleted Risk: destructive · Irreversible
Input This replaces the whole set: every check-in the list does not name is deleted.
Output

update

checkIns.update Change a check-in’s name, slug, schedule or grace period; switching schedule type clears the other one’s fields Risk: write
Input Output

Comments

create

comments.create Comment on a fault; @mentions notify the named project members Risk: write
Input Output

delete

comments.delete Permanently delete a comment from a fault Risk: destructive · Irreversible
Input Output

get

comments.get Read one comment on a fault, with its author and body Risk: read
Input Output

list

comments.list List a fault’s comments newest first, paging backwards with a cursor Risk: read
Input Output

update

comments.update Replace the text of a comment on a fault; other comment fields cannot be changed Risk: write
Input Output

Deploys

delete

deploys.delete Delete a deploy record; the deploy is not re-read anywhere Risk: destructive · Irreversible
Input Output

get

deploys.get Read one deploy record, with its environment, revision and author Risk: read
Input Output

list

deploys.list List deploys oldest-page-first with cursors, optionally by exact environment or deploy username Risk: read
Input Output

Environments

bulkDelete

environments.bulkDelete Delete several environments at once; if any ID is not one of the project’s, nothing is deleted Risk: destructive · Irreversible
Input Output

bulkUpdate

environments.bulkUpdate Turn notifications on or off for several environments at once; if any ID is not one of the project’s, nothing changes Risk: write
Input Output

create

environments.create Create an environment; names are unique per project and case-sensitive Risk: write
Input Output

delete

environments.delete Delete an environment; its faults and notices stay, and the next notice under that name recreates it with notifications on Risk: destructive · Irreversible
Input Output

get

environments.get Read one environment and whether its errors send notifications Risk: read
Input Output

list

environments.list List a project’s environments and whether each sends notifications Risk: read
Input Output

update

environments.update Change whether an environment notifies; an environment cannot be renamed Risk: write
Input Output

Faults

affectedUsers

faults.affectedUsers Read the 500 users a fault affected most, ranked by notice count Risk: read
Input Output

assign

faults.assign Assign a fault to a project member, who is notified of it Risk: write
Input Output

delete

faults.delete Permanently delete a fault; its notices stay readable by ID until retention removes them Risk: destructive · Irreversible
Input Output

get

faults.get Read one fault by ID; a merged fault redirects to the fault it was merged into Risk: read
Input Output

ignore

faults.ignore Ignore faults, which stops data collection for them, by ID or by query with all: true Risk: write
Input Output

list

faults.list List faults with error search, sorting and time filters; occurrence counts cover the requested window Risk: read
Input q uses the web UI error search syntax. occurred_after also narrows the occurrence counts each fault reports. Output

merge

faults.merge Merge one fault into another in the background; the merged fault keeps its tags, assignee and state on neither side, and its ID redirects for the retention period Risk: destructive · Irreversible
Input Answers 202 with a batch_id; the merge runs in the background. Until it finishes the old fault is readable, then reads redirect. Output

occurrences

faults.occurrences Read occurrence counts for one fault over a window, one bucket per interval including empty ones Risk: read
Input Output

pauseRecording

faults.pauseRecording Stop recording a fault for an hour, a day or a week, discarding notices during the pause Risk: write
Input Output

resolve

faults.resolve Resolve named faults, or every fault a query and time filter match with all: true; dry_run reports what would change Risk: write
Input Answers the number changed, which counts what changed rather than what matched: resolving a hundred faults of which ninety were already resolved reports ten. Output

resumeRecording

faults.resumeRecording Resume recording a fault; a fault that is not paused is unchanged Risk: write
Input Output

snooze

faults.snooze Snooze notifications for a duration or an occurrence count, replacing any existing snooze Risk: write
Input Send exactly one of time or count. count is one of 10, 100 or 1000. Output

summary

faults.summary Read fault counts grouped by environment and resolved or ignored state, with the same filters as the fault list Risk: read
Input Output

unassign

faults.unassign Remove the assignment from a fault, leaving it unowned Risk: write
Input Output

unignore

faults.unignore Stop ignoring faults, so collection resumes, by ID or by query with all: true Risk: write
Input Output

unresolve

faults.unresolve Mark faults unresolved, by ID or by query with all: true; dry_run reports what would change Risk: write
Input Output

unsnooze

faults.unsnooze Remove a fault’s snooze, so notifications resume from the next occurrence Risk: write
Input Output

update

faults.update Change a fault resolved or ignored state, assignee, tags, or whether it resolves on the next deploy Risk: write
Input Output

Insights

query

insights.query Run a BadgerQL query over the project event streams and return its rows; a POST that changes nothing Risk: read
Input A POST that changes nothing, so it is a read and safe to replay. The data columns depend on the query. Output

Notices

get

notices.get Read one notice by its UUID, without naming its project or fault Risk: read
Input Output

list

notices.list List a fault’s notices newest first, with source-mapped backtraces unless unmapped is set Risk: read
Input The first page is the newest notices. Follow links.older for earlier ones; links.newer is always null here. Output

Occurrences

list

occurrences.list Read notice counts for every project the token can see, ordered by project name Risk: read
Input Output

Projects

create

projects.create Create a project, optionally in a team; team_id requires team:write and rejects the whole request without it Risk: write
Input Output

delete

projects.delete Permanently delete a project and all its data Risk: destructive · Irreversible
Input Output

get

projects.get Read one project by ID, including its fault counts and environment names Risk: read
Input Output

list

projects.list List projects the token can reach, optionally filtered by exact name, with paging Risk: read
Input Returns data and pagination. name is an exact match, not a search. Output

occurrences

projects.occurrences Read notice counts for one project over an hour, day, week or month, one count per interval Risk: read
Input Output

stats

projects.stats Read a project fault and notice counts for the last day, week and month Risk: read
Input Output

update

projects.update Change a project’s settings; a null clears a nullable field and a field left out keeps its value Risk: write
Input Output

Sites

checks

sites.checks List a site’s individual uptime check results, newest page first Risk: read
Input Output

create

sites.create Create an uptime site; match is required for every match type except success, which refuses it, and timeout must be shorter than the check interval Risk: write
Input match is required for every match type except success, which refuses it. timeout must be less than the frequency in seconds. Output

delete

sites.delete Delete an uptime site and stop monitoring it Risk: destructive · Irreversible
Input Output

get

sites.get Read one uptime site with its URL, match rule and current state Risk: read
Input Output

list

sites.list List a project’s uptime monitoring sites with their URLs and current state Risk: read
Input Output

outages

sites.outages List a site’s outage periods, with the status and reason each failed Risk: read
Input Output

update

sites.update Change an uptime site’s URL, matching, headers, locations, frequency or active state Risk: write
Input Output

Streams

list

streams.list List event streams; the ID is what insights.query takes in stream_ids Risk: read
Input Output

Token

get

token.get Report what the current token is: its kind, scopes, account and the projects it can reach. Needs no scope Risk: read
Input: empty object Needs no scope, so it is the cheapest way to check that a token works and which region it belongs to. Output