API Documentation
API Reference
- Inventory
- Resource
- Monitor
- Incident
- Integration
- Organization
- User
- POSTQuery logs
- POSTQuery metrics
- POSTQuery traces
Create an Incident
this operation creates a manual incident
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
an incident trigged by a monitor/alert
Unique identifier for the entity
the incident title
the incident description field
resource monitor
Unique identifier for the entity
the interval in which the monitor will be checked
the monitor name
the monitor description
the monitor type
until when the monitor will be in snoozed mode
state of the monitor during its lifecycle
status of the monitor
monitor priority
the monitor recipients of the incidents/alerts notifications
the monitor query
Unique identifier for the entity
the inventory resource name
the inventory resource type
the website resource URL
state of the incident during its lifecycle
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
timestamp when incident was acknowledged
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
timestamp when incident was reopened
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
timestamp when incident was closed
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
timestamp when incident was closed
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
until when the monitor will be in snoozed mode
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
list of incidents notes
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
an incident trigged by a monitor/alert
Unique identifier for the entity
the incident title
state of the incident during its lifecycle
ACTIVE, ACKNOWLEDGED, SNOOZED, RESOLVED, CLOSED, REOPENED the incident description field
resource monitor
Unique identifier for the entity
the monitor name
the monitor type
UP_TIME, LATENCY, LOAD_TIME, WEBSITE_TYPO, STRIPE, DOMAIN_EXPIRATION, CERT_EXPIRATION, CDN_CONFIGURATION, CLOUDFLARE_REQUESTS, CLOUDFRONT_REQUESTS, STATUS_PAGE, DATABASE_STORAGE_LIMIT, DATABASE_CPU_USAGE, DATABASE_MEMORY_USAGE state of the monitor during its lifecycle
ACTIVE, PAUSED, SNOOZED, ERROR status of the monitor
NO_DATA, OK, ALERT, WARN monitor priority
NOT_DEFINED, CRITICAL, HIGH, MEDIUM, LOW, INFO the monitor recipients of the incidents/alerts notifications
Unique identifier for the entity
the integration information
Unique identifier for the entity
the integration type
SLACK, PAGERDUTY, EMAIL the integration class
NOTIFICATION, CLOUD_PROVIDER the slack integration configuration
the team ID associated with the integration/app
the slack access token returned from the oauth
the slack incoming webhook url returned from the oauth
the default slack channel
the slack integration configuration
the team ID associated with the integration/app
the slack access token returned from the oauth
the slack incoming webhook url returned from the oauth
the default slack channel
the interval in which the monitor will be checked
the monitor description
until when the monitor will be in snoozed mode
the monitor query
Unique identifier for the entity
the inventory resource name
the inventory resource type
WEBSITE, DATABASE, COMPUTE, STRIPE, AWS_CLOUDFRONT, CLOUDFLARE, STATUS_PAGE, RDS_DATABASE the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
timestamp when incident was acknowledged
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
timestamp when incident was reopened
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
timestamp when incident was closed
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
timestamp when incident was closed
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
until when the monitor will be in snoozed mode
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
list of incidents notes
Unique identifier for the entity
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
the incident note content
Response
an incident trigged by a monitor/alert
Unique identifier for the entity
the incident title
state of the incident during its lifecycle
ACTIVE, ACKNOWLEDGED, SNOOZED, RESOLVED, CLOSED, REOPENED the incident description field
resource monitor
Unique identifier for the entity
the monitor name
the monitor type
UP_TIME, LATENCY, LOAD_TIME, WEBSITE_TYPO, STRIPE, DOMAIN_EXPIRATION, CERT_EXPIRATION, CDN_CONFIGURATION, CLOUDFLARE_REQUESTS, CLOUDFRONT_REQUESTS, STATUS_PAGE, DATABASE_STORAGE_LIMIT, DATABASE_CPU_USAGE, DATABASE_MEMORY_USAGE state of the monitor during its lifecycle
ACTIVE, PAUSED, SNOOZED, ERROR status of the monitor
NO_DATA, OK, ALERT, WARN monitor priority
NOT_DEFINED, CRITICAL, HIGH, MEDIUM, LOW, INFO the monitor recipients of the incidents/alerts notifications
Unique identifier for the entity
the integration information
Unique identifier for the entity
the integration type
SLACK, PAGERDUTY, EMAIL the integration class
NOTIFICATION, CLOUD_PROVIDER the slack integration configuration
the team ID associated with the integration/app
the slack access token returned from the oauth
the slack incoming webhook url returned from the oauth
the default slack channel
the slack integration configuration
the team ID associated with the integration/app
the slack access token returned from the oauth
the slack incoming webhook url returned from the oauth
the default slack channel
the interval in which the monitor will be checked
the monitor description
until when the monitor will be in snoozed mode
the monitor query
Unique identifier for the entity
the inventory resource name
the inventory resource type
WEBSITE, DATABASE, COMPUTE, STRIPE, AWS_CLOUDFRONT, CLOUDFLARE, STATUS_PAGE, RDS_DATABASE the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
timestamp when incident was acknowledged
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
timestamp when incident was reopened
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
timestamp when incident was closed
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
timestamp when incident was closed
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
until when the monitor will be in snoozed mode
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
list of incidents notes
Unique identifier for the entity
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
the incident note content