DEV3 Faultsnare REST API
Base URL /api/v1 · Authenticate with Authorization: Bearer n3k_… · OpenAPI 3.1 JSON
/api/v1/projectsscope: project:readList projects
Parameters: page (query), limit (query)
/api/v1/projectsscope: project:writeCreate a project and its first DSN key
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"slug": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{0,58}[a-z0-9]$|^[a-z0-9]$"
},
"platform": {
"type": "string",
"enum": [
"browser",
"node",
"php"
]
},
"environments": {
"default": [],
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 60
}
},
"allowedOrigins": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
},
"notInApp": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
},
"fingerprintRules": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"match": {
"type": "object",
"properties": {
"type": {
"type": "string",
"maxLength": 200
},
"message": {
"type": "string",
"maxLength": 300
},
"module": {
"type": "string",
"maxLength": 200
},
"function": {
"type": "string",
"maxLength": 200
},
"level": {
"type": "string",
"maxLength": 10
}
},
"additionalProperties": false
},
"fingerprint": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"match",
"fingerprint"
],
"additionalProperties": false
}
},
"scrub": {
"default": {
"extraKeys": [],
"keepUserId": false,
"keepFeedbackName": false,
"feedbackPerDay": 200
},
"type": "object",
"properties": {
"extraKeys": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 60
}
},
"keepUserId": {
"default": false,
"type": "boolean"
},
"keepFeedbackName": {
"default": false,
"type": "boolean"
},
"feedbackPerDay": {
"default": 200,
"type": "integer",
"minimum": 1,
"maximum": 5000
}
},
"required": [
"extraKeys",
"keepUserId",
"keepFeedbackName",
"feedbackPerDay"
],
"additionalProperties": false
}
},
"required": [
"name",
"platform",
"environments",
"allowedOrigins",
"notInApp",
"fingerprintRules",
"scrub"
],
"additionalProperties": false
}/api/v1/projects/{id}scope: project:readRetrieve a project
Parameters: id (path)
/api/v1/projects/{id}scope: project:writeUpdate project settings (origins, environments, scrub, fingerprint rules, compat toggle)
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"slug": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{0,58}[a-z0-9]$|^[a-z0-9]$"
},
"platform": {
"type": "string",
"enum": [
"browser",
"node",
"php"
]
},
"environments": {
"default": [],
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 60
}
},
"allowedOrigins": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
},
"notInApp": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
},
"fingerprintRules": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"match": {
"type": "object",
"properties": {
"type": {
"type": "string",
"maxLength": 200
},
"message": {
"type": "string",
"maxLength": 300
},
"module": {
"type": "string",
"maxLength": 200
},
"function": {
"type": "string",
"maxLength": 200
},
"level": {
"type": "string",
"maxLength": 10
}
},
"additionalProperties": false
},
"fingerprint": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"match",
"fingerprint"
],
"additionalProperties": false
}
},
"scrub": {
"default": {
"extraKeys": [],
"keepUserId": false,
"keepFeedbackName": false,
"feedbackPerDay": 200
},
"type": "object",
"properties": {
"extraKeys": {
"default": [],
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 60
}
},
"keepUserId": {
"default": false,
"type": "boolean"
},
"keepFeedbackName": {
"default": false,
"type": "boolean"
},
"feedbackPerDay": {
"default": 200,
"type": "integer",
"minimum": 1,
"maximum": 5000
}
},
"required": [
"extraKeys",
"keepUserId",
"keepFeedbackName",
"feedbackPerDay"
],
"additionalProperties": false
},
"compatEnvelope": {
"type": "boolean"
}
},
"additionalProperties": false
}/api/v1/projects/{id}scope: project:writeArchive a project (it stops accepting events)
Parameters: id (path)
/api/v1/projects/{id}/keysscope: project:writeCreate a DSN key (the secret of a server key is shown once)
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 60
},
"rateLimitPerMin": {
"type": "integer",
"minimum": 1,
"maximum": 100000
}
},
"additionalProperties": false
}/api/v1/projects/{id}/keys/{keyId}/rotatescope: project:writeRotate a DSN key (the old key works for 7 more days)
Parameters: id (path), keyId (path)
/api/v1/projects/{id}/keys/{keyId}scope: project:writeRevoke a DSN key
Parameters: id (path), keyId (path)
/api/v1/issuesscope: issues:readList issues; q uses the search language (is:unresolved release:4.19.0 level:error)
Parameters: page (query), limit (query), q (query), project_id (query), sort (query)
/api/v1/issues/{id}scope: issues:readRetrieve an issue
Parameters: id (path)
/api/v1/issues/{id}scope: issues:writeUpdate state, assignee or priority (send the version you read: 409 on conflict)
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"state": {
"type": "string",
"enum": [
"unresolved",
"resolved",
"resolved_next_release",
"ignored",
"archived"
]
},
"release": {
"type": "string",
"maxLength": 120
},
"ignore": {
"type": "object",
"properties": {
"until": {
"type": "string",
"enum": [
"forever",
"count",
"time",
"users"
]
},
"n": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"at": {
"type": "string"
}
},
"required": [
"until"
],
"additionalProperties": false
},
"assigneeId": {
"type": [
"string",
"null"
]
},
"priority": {
"type": "string",
"enum": [
"critical",
"high",
"normal",
"low"
]
}
},
"additionalProperties": false
}/api/v1/issues/{id}scope: issues:writeDelete an issue and its events
Parameters: id (path)
/api/v1/issues/{id}/mergescope: issues:writeMerge other issues of the same project into this one
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"sourceIds": {
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"sourceIds"
],
"additionalProperties": false
}/api/v1/issues/{id}/eventsscope: events:readList the events of an issue (newest first)
Parameters: id (path), page (query), limit (query)
/api/v1/events/{eventId}scope: events:readRetrieve one event (scrubbed, de-minified)
Parameters: eventId (path)
/api/v1/releasesscope: project:readList releases with crash-free sessions
Parameters: page (query), limit (query)
/api/v1/releasesscope: releases:writeCreate a release (idempotent)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"version": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"projectId": {
"type": "string"
},
"commitsNote": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"version"
],
"additionalProperties": false
}/api/v1/releases/{version}/deploysscope: releases:writeRecord a deploy of a release
Parameters: version (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"environment": {
"type": "string",
"minLength": 1,
"maxLength": 60
},
"projectId": {
"type": "string"
},
"at": {
"type": "string"
}
},
"required": [
"environment"
],
"additionalProperties": false
}/api/v1/releases/{version}/filesscope: project:readList source-map artifacts of a release
Parameters: version (path)
/api/v1/releases/{version}/filesscope: releases:writeUpload a source map (multipart: file, name, project_id, dist)
Parameters: version (path)
/api/v1/releases/{version}/filesscope: releases:writeDelete a source-map artifact (query: project_id, name, dist)
Parameters: version (path), project_id (query), name (query), dist (query)
/api/v1/alert-rulesscope: project:readList alert rules
/api/v1/alert-rulesscope: project:writeCreate an alert rule (new_issue, regression, spike, frequency)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"type": "string",
"enum": [
"new_issue",
"regression",
"spike",
"frequency"
]
},
"projectId": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
{
"type": "null"
}
]
},
"conditions": {
"default": {
"windowMin": 5
},
"type": "object",
"properties": {
"windowMin": {
"default": 5,
"type": "integer",
"minimum": 1,
"maximum": 1440
},
"count": {
"type": "integer",
"minimum": 1,
"maximum": 10000000
},
"multiplier": {
"type": "number",
"minimum": 1.5,
"maximum": 1000
},
"minCount": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
}
},
"required": [
"windowMin"
],
"additionalProperties": false
},
"filters": {
"default": {},
"type": "object",
"properties": {
"environment": {
"type": "string",
"maxLength": 60
},
"level": {
"type": "string",
"enum": [
"fatal",
"error",
"warning",
"info",
"debug"
]
},
"tag": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 32
},
"value": {
"type": "string",
"maxLength": 200
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"actions": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
}
},
"cooldownMin": {
"default": 30,
"type": "integer",
"minimum": 1,
"maximum": 1440
},
"status": {
"default": "active",
"type": "string",
"enum": [
"active",
"muted"
]
}
},
"required": [
"name",
"type",
"conditions",
"filters",
"actions",
"cooldownMin",
"status"
],
"additionalProperties": false
}/api/v1/alert-rules/{id}scope: project:writeUpdate an alert rule (send version)
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"type": "string",
"enum": [
"new_issue",
"regression",
"spike",
"frequency"
]
},
"projectId": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
{
"type": "null"
}
]
},
"conditions": {
"default": {
"windowMin": 5
},
"type": "object",
"properties": {
"windowMin": {
"default": 5,
"type": "integer",
"minimum": 1,
"maximum": 1440
},
"count": {
"type": "integer",
"minimum": 1,
"maximum": 10000000
},
"multiplier": {
"type": "number",
"minimum": 1.5,
"maximum": 1000
},
"minCount": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
}
},
"required": [
"windowMin"
],
"additionalProperties": false
},
"filters": {
"default": {},
"type": "object",
"properties": {
"environment": {
"type": "string",
"maxLength": 60
},
"level": {
"type": "string",
"enum": [
"fatal",
"error",
"warning",
"info",
"debug"
]
},
"tag": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 32
},
"value": {
"type": "string",
"maxLength": 200
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"actions": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
}
},
"cooldownMin": {
"default": 30,
"type": "integer",
"minimum": 1,
"maximum": 1440
},
"status": {
"default": "active",
"type": "string",
"enum": [
"active",
"muted"
]
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"version"
],
"additionalProperties": false
}/api/v1/alert-rules/{id}scope: project:writeDelete an alert rule
Parameters: id (path)
/api/v1/channelsscope: project:readList notification channels (targets are never returned)
/api/v1/channelsscope: project:writeCreate a notification channel (email, webhook, Slack-compatible incoming webhook)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "simulated"
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
},
"required": [
"type",
"label"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "email"
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"to": {
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
}
}
},
"required": [
"type",
"label",
"to"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "webhook"
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"url": {
"type": "string",
"maxLength": 500,
"format": "uri"
},
"secret": {
"type": "string",
"maxLength": 200
}
},
"required": [
"type",
"label",
"url"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "slack_compatible"
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"url": {
"type": "string",
"maxLength": 500,
"format": "uri"
}
},
"required": [
"type",
"label",
"url"
],
"additionalProperties": false
}
]
}/api/v1/channels/{id}scope: project:writeDelete a channel
Parameters: id (path)
/api/v1/usagescope: project:readEvent usage and quota for the current month
/api/v1/feedbackscope: events:readList user feedback
Parameters: page (query), limit (query)