Incidite GraphQL API Reference
Welcome to our API reference. Here you can find all the information you need to interact with our API.
Terms of Service
API Endpoints
# Production:
https://api.incidite.com/graphql
Headers
# Your API token
Authorization: Bearer <YOUR_TOKEN_HERE>Queries
alert
Example
Query
query Alert(
$organizationId: ID!,
$alertId: ID!
) {
alert(
organizationId: $organizationId,
alertId: $alertId
) {
id
state
name
description
referenceId
metadata {
labels
annotations
}
processingStatus {
processedAt
error
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{"organizationId": 4, "alertId": "4"}
Response
{
"data": {
"alert": {
"id": 4,
"state": "ACTIVE",
"name": "abc123",
"description": "abc123",
"referenceId": "xyz789",
"metadata": AlertMetadata,
"processingStatus": AlertProcessingStatus,
"alertedAt": "10:15:30Z",
"startedAt": "10:15:30Z",
"resolvedAt": "10:15:30Z",
"createdAt": "10:15:30Z",
"relationGroupId": 4,
"relatedAlerts": [Alert]
}
}
}
alertProcessor
Response
Returns an AlertProcessor
Example
Query
query AlertProcessor(
$organizationId: ID!,
$alertProcessorId: ID!
) {
alertProcessor(
organizationId: $organizationId,
alertProcessorId: $alertProcessorId
) {
id
name
configuration {
autoCreateIncidents
correlatorType
statisticalAlertCorrelator {
...StatisticalAlertCorrelatorFragment
}
}
statistics {
totalAlertsProcessed
lastAlertProcessedAt
}
createdAt
updatedAt
}
}
Variables
{
"organizationId": "4",
"alertProcessorId": "4"
}
Response
{
"data": {
"alertProcessor": {
"id": "abc123",
"name": "abc123",
"configuration": AlertProcessorConfiguration,
"statistics": AlertProcessorStatistics,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
alertProcessors
Response
Returns [AlertProcessor!]!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
Example
Query
query AlertProcessors($organizationId: ID!) {
alertProcessors(organizationId: $organizationId) {
id
name
configuration {
autoCreateIncidents
correlatorType
statisticalAlertCorrelator {
...StatisticalAlertCorrelatorFragment
}
}
statistics {
totalAlertsProcessed
lastAlertProcessedAt
}
createdAt
updatedAt
}
}
Variables
{"organizationId": 4}
Response
{
"data": {
"alertProcessors": [
{
"id": "xyz789",
"name": "xyz789",
"configuration": AlertProcessorConfiguration,
"statistics": AlertProcessorStatistics,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
]
}
}
alertSource
Response
Returns an AlertSource
Example
Query
query AlertSource(
$organizationId: ID!,
$alertSourceId: ID!
) {
alertSource(
organizationId: $organizationId,
alertSourceId: $alertSourceId
) {
id
type
token
name
version
configuration {
... on AlertmanagerSourceConfiguration {
...AlertmanagerSourceConfigurationFragment
}
}
webhookEndpoint
createdAt
updatedAt
alerts {
totalSize
alerts {
...AlertFragment
}
}
processor {
id
name
configuration {
...AlertProcessorConfigurationFragment
}
statistics {
...AlertProcessorStatisticsFragment
}
createdAt
updatedAt
}
}
}
Variables
{"organizationId": 4, "alertSourceId": "4"}
Response
{
"data": {
"alertSource": {
"id": "4",
"type": "ALERTMANAGER",
"token": "abc123",
"name": "xyz789",
"version": 987,
"configuration": AlertmanagerSourceConfiguration,
"webhookEndpoint": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"alerts": AlertList,
"processor": AlertProcessor
}
}
}
alertSources
Response
Returns [AlertSource!]!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
Example
Query
query AlertSources($organizationId: ID!) {
alertSources(organizationId: $organizationId) {
id
type
token
name
version
configuration {
... on AlertmanagerSourceConfiguration {
...AlertmanagerSourceConfigurationFragment
}
}
webhookEndpoint
createdAt
updatedAt
alerts {
totalSize
alerts {
...AlertFragment
}
}
processor {
id
name
configuration {
...AlertProcessorConfigurationFragment
}
statistics {
...AlertProcessorStatisticsFragment
}
createdAt
updatedAt
}
}
}
Variables
{"organizationId": 4}
Response
{
"data": {
"alertSources": [
{
"id": 4,
"type": "ALERTMANAGER",
"token": "xyz789",
"name": "xyz789",
"version": 123,
"configuration": AlertmanagerSourceConfiguration,
"webhookEndpoint": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"alerts": AlertList,
"processor": AlertProcessor
}
]
}
}
alerts
Response
Returns a ListAlertsResponse!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
|
listAlertsRequest - ListAlertsRequest
|
Example
Query
query Alerts(
$organizationId: ID!,
$listAlertsRequest: ListAlertsRequest
) {
alerts(
organizationId: $organizationId,
listAlertsRequest: $listAlertsRequest
) {
totalSize
alerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{
"organizationId": "4",
"listAlertsRequest": ListAlertsRequest
}
Response
{
"data": {
"alerts": {"totalSize": 123, "alerts": [Alert]}
}
}
broadcastChannels
Response
Returns [BroadcastChannel!]!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
Example
Query
query BroadcastChannels($organizationId: ID!) {
broadcastChannels(organizationId: $organizationId) {
id
endpoint {
id
providerType
providerProfileId
config {
... on ProviderChannelMetadata {
...ProviderChannelMetadataFragment
}
... on ProviderAddressMetadata {
...ProviderAddressMetadataFragment
}
}
doiConfirmed
doiConfirmedAt
}
iql
}
}
Variables
{"organizationId": 4}
Response
{
"data": {
"broadcastChannels": [
{
"id": "4",
"endpoint": RecipientEndpoint,
"iql": "abc123"
}
]
}
}
incident
Example
Query
query Incident(
$organizationUUID: ID!,
$id: Int!
) {
incident(
organizationUUID: $organizationUUID,
id: $id
) {
id
schemaVersion {
id
schema {
...IncidentSchemaFragment
}
version
states {
...IncidentSchemaStateFragment
}
priorities {
...IncidentSchemaPriorityFragment
}
}
title
summary
priority {
id
name
order
color
icon
}
state {
id
name
order
icon
color
isDefault
isAcknowledged
isResolved
}
createdAt
timings {
impactStarted
impactDetected
impactResolved
}
roles {
role {
...IncidentRoleFragment
}
assignments {
...IncidentRoleAssignmentFragment
}
}
events {
totalSize
nextPageToken
events {
...IncidentEventFragment
}
}
affectedServices {
service {
...ServiceFragment
}
impact
}
statuspageLinks {
statuspage {
...StatuspageFragment
}
}
communicationChannels {
provider
channelName
channelLink
}
broadcastMessages {
id
channel {
...BroadcastChannelFragment
}
createdAt
updatedAt
}
relatedAlerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{"organizationUUID": "4", "id": 987}
Response
{
"data": {
"incident": {
"id": 987,
"schemaVersion": IncidentSchemaVersion,
"title": "xyz789",
"summary": "xyz789",
"priority": IncidentSchemaPriority,
"state": IncidentSchemaState,
"createdAt": "10:15:30Z",
"timings": IncidentTimings,
"roles": [IncidentRoleWithAssignment],
"events": IncidentEventList,
"affectedServices": [AffectedService],
"statuspageLinks": [IncidentStatuspageLink],
"communicationChannels": [CommunicationChannel],
"broadcastMessages": [BroadcastMessage],
"relatedAlerts": [Alert]
}
}
}
incidentRoles
Response
Returns [IncidentRole!]!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
Example
Query
query IncidentRoles($organizationUUID: ID!) {
incidentRoles(organizationUUID: $organizationUUID) {
id
name
description
createdAt
updatedAt
}
}
Variables
{"organizationUUID": "4"}
Response
{
"data": {
"incidentRoles": [
{
"id": 4,
"name": "abc123",
"description": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
]
}
}
incidentSchema
Response
Returns an IncidentSchema!
Example
Query
query IncidentSchema(
$organizationId: ID!,
$schemaId: ID!
) {
incidentSchema(
organizationId: $organizationId,
schemaId: $schemaId
) {
id
name
type
currentVersion {
id
schema {
...IncidentSchemaFragment
}
version
states {
...IncidentSchemaStateFragment
}
priorities {
...IncidentSchemaPriorityFragment
}
}
createdAt
}
}
Variables
{"organizationId": "4", "schemaId": 4}
Response
{
"data": {
"incidentSchema": {
"id": "xyz789",
"name": "xyz789",
"type": "INCIDENT",
"currentVersion": IncidentSchemaVersion,
"createdAt": "10:15:30Z"
}
}
}
incidentSchemaVersion
Response
Returns an IncidentSchemaVersion!
Example
Query
query IncidentSchemaVersion(
$organizationId: ID!,
$schemaVersionId: ID!
) {
incidentSchemaVersion(
organizationId: $organizationId,
schemaVersionId: $schemaVersionId
) {
id
schema {
id
name
type
currentVersion {
...IncidentSchemaVersionFragment
}
createdAt
}
version
states {
id
name
order
icon
color
isDefault
isAcknowledged
isResolved
}
priorities {
id
name
order
color
icon
}
}
}
Variables
{
"organizationId": 4,
"schemaVersionId": "4"
}
Response
{
"data": {
"incidentSchemaVersion": {
"id": "abc123",
"schema": IncidentSchema,
"version": 987,
"states": [IncidentSchemaState],
"priorities": [IncidentSchemaPriority]
}
}
}
incidentSchemas
Response
Returns a ListIncidentSchemasResponse!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
Example
Query
query IncidentSchemas($organizationId: ID!) {
incidentSchemas(organizationId: $organizationId) {
schemas {
id
name
type
currentVersion {
...IncidentSchemaVersionFragment
}
createdAt
}
}
}
Variables
{"organizationId": 4}
Response
{
"data": {
"incidentSchemas": {"schemas": [IncidentSchema]}
}
}
incidents
Response
Returns a ListIncidentsResponse!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
listIncidentsRequest - ListIncidentsRequest
|
Example
Query
query Incidents(
$organizationUUID: ID!,
$listIncidentsRequest: ListIncidentsRequest
) {
incidents(
organizationUUID: $organizationUUID,
listIncidentsRequest: $listIncidentsRequest
) {
totalSize
incidents {
id
schemaVersion {
...IncidentSchemaVersionFragment
}
title
summary
priority {
...IncidentSchemaPriorityFragment
}
state {
...IncidentSchemaStateFragment
}
createdAt
timings {
...IncidentTimingsFragment
}
roles {
...IncidentRoleWithAssignmentFragment
}
events {
...IncidentEventListFragment
}
affectedServices {
...AffectedServiceFragment
}
statuspageLinks {
...IncidentStatuspageLinkFragment
}
communicationChannels {
...CommunicationChannelFragment
}
broadcastMessages {
...BroadcastMessageFragment
}
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{
"organizationUUID": "4",
"listIncidentsRequest": ListIncidentsRequest
}
Response
{
"data": {
"incidents": {
"totalSize": 123,
"incidents": [Incident]
}
}
}
incidentsStatistics
Response
Returns [IncidentsStatistic!]!
Example
Query
query IncidentsStatistics(
$organizationId: ID!,
$days: Int!
) {
incidentsStatistics(
organizationId: $organizationId,
days: $days
) {
name
unit
datapoints {
date
value
}
}
}
Variables
{"organizationId": "4", "days": 987}
Response
{
"data": {
"incidentsStatistics": [
{
"name": "abc123",
"unit": "abc123",
"datapoints": [DataPoint]
}
]
}
}
invitations
Response
Returns [Invitation!]!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
Example
Query
query Invitations($organizationUUID: ID!) {
invitations(organizationUUID: $organizationUUID) {
id
email
role {
id
name
permissionRoles
}
validUntil
token
createdAt
updatedAt
organization {
id
name
members {
...OrganizationMemberFragment
}
subscription {
...PlanSubscriptionFragment
}
}
}
}
Variables
{"organizationUUID": "4"}
Response
{
"data": {
"invitations": [
{
"id": 4,
"email": "abc123",
"role": OrganizationMemberRole,
"validUntil": "10:15:30Z",
"token": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"organization": Organization
}
]
}
}
invoices
Response
Returns [Invoice!]!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
Example
Query
query Invoices($organizationId: ID!) {
invoices(organizationId: $organizationId) {
id
amountDue
currency
paid
pdfURL
createdAt
}
}
Variables
{"organizationId": "4"}
Response
{
"data": {
"invoices": [
{
"id": 4,
"amountDue": 123,
"currency": "abc123",
"paid": true,
"pdfURL": "abc123",
"createdAt": "10:15:30Z"
}
]
}
}
me
Response
Returns a User!
Example
Query
query Me {
me {
id
firstname
lastname
avatar
email
verified
memberships {
id
organizationId
organization {
...OrganizationFragment
}
role {
...OrganizationMemberRoleFragment
}
}
}
}
Response
{
"data": {
"me": {
"id": "xyz789",
"firstname": "xyz789",
"lastname": "abc123",
"avatar": "xyz789",
"email": "xyz789",
"verified": false,
"memberships": [UserOrganizationMembership]
}
}
}
monitor
Example
Query
query Monitor(
$organizationId: ID!,
$monitorId: ID!
) {
monitor(
organizationId: $organizationId,
monitorId: $monitorId
) {
id
service {
id
name
description
incidents {
...IncidentFragment
}
owner {
...TeamFragment
}
state
isDeleted
deletedAt
}
scheduling {
intervalSeconds
retries
}
probeType
probeConfiguration {
... on ICMPProbeConfiguration {
...ICMPProbeConfigurationFragment
}
... on HTTPProbeConfiguration {
...HTTPProbeConfigurationFragment
}
}
probeResults {
metadata {
...ProbeResultMetadataFragment
}
result {
... on ICMPProbeResult {
...ICMPProbeResultFragment
}
... on HTTPProbeResult {
...HTTPProbeResultFragment
}
}
}
createdAt
updatedAt
deletedAt
}
}
Variables
{"organizationId": "4", "monitorId": 4}
Response
{
"data": {
"monitor": {
"id": "xyz789",
"service": Service,
"scheduling": SchedulingConfiguration,
"probeType": "ICMP",
"probeConfiguration": ICMPProbeConfiguration,
"probeResults": [ProbeResult],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"deletedAt": "10:15:30Z"
}
}
}
monitors
Response
Returns a ListMonitorsResponse!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
|
listMonitorsRequest - ListMonitorsRequest!
|
Example
Query
query Monitors(
$organizationId: ID!,
$listMonitorsRequest: ListMonitorsRequest!
) {
monitors(
organizationId: $organizationId,
listMonitorsRequest: $listMonitorsRequest
) {
totalSize
monitors {
id
service {
...ServiceFragment
}
scheduling {
...SchedulingConfigurationFragment
}
probeType
probeConfiguration {
... on ICMPProbeConfiguration {
...ICMPProbeConfigurationFragment
}
... on HTTPProbeConfiguration {
...HTTPProbeConfigurationFragment
}
}
probeResults {
...ProbeResultFragment
}
createdAt
updatedAt
deletedAt
}
}
}
Variables
{
"organizationId": 4,
"listMonitorsRequest": ListMonitorsRequest
}
Response
{
"data": {
"monitors": {"totalSize": 123, "monitors": [Monitor]}
}
}
organization
Response
Returns an Organization
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
Example
Query
query Organization($organizationUUID: ID!) {
organization(organizationUUID: $organizationUUID) {
id
name
members {
id
identityId
role {
...OrganizationMemberRoleFragment
}
joinedAt
meta {
...UserFragment
}
}
subscription {
id
plan {
...PlanFragment
}
status
canStartTrial
createdAt
updatedAt
details {
...SubscriptionDetailsFragment
}
}
}
}
Variables
{"organizationUUID": 4}
Response
{
"data": {
"organization": {
"id": "abc123",
"name": "xyz789",
"members": [OrganizationMember],
"subscription": PlanSubscription
}
}
}
service
Example
Query
query Service(
$organizationUUID: ID!,
$serviceId: Int!
) {
service(
organizationUUID: $organizationUUID,
serviceId: $serviceId
) {
id
name
description
incidents {
id
schemaVersion {
...IncidentSchemaVersionFragment
}
title
summary
priority {
...IncidentSchemaPriorityFragment
}
state {
...IncidentSchemaStateFragment
}
createdAt
timings {
...IncidentTimingsFragment
}
roles {
...IncidentRoleWithAssignmentFragment
}
events {
...IncidentEventListFragment
}
affectedServices {
...AffectedServiceFragment
}
statuspageLinks {
...IncidentStatuspageLinkFragment
}
communicationChannels {
...CommunicationChannelFragment
}
broadcastMessages {
...BroadcastMessageFragment
}
relatedAlerts {
...AlertFragment
}
}
owner {
id
name
createdAt
updatedAt
members {
...TeamMemberFragment
}
services {
...ServiceFragment
}
}
state
isDeleted
deletedAt
}
}
Variables
{"organizationUUID": "4", "serviceId": 123}
Response
{
"data": {
"service": {
"id": 123,
"name": "abc123",
"description": "abc123",
"incidents": [Incident],
"owner": Team,
"state": "OPERATIONAL",
"isDeleted": true,
"deletedAt": "10:15:30Z"
}
}
}
services
Response
Returns [Service!]!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
Example
Query
query Services($organizationUUID: ID!) {
services(organizationUUID: $organizationUUID) {
id
name
description
incidents {
id
schemaVersion {
...IncidentSchemaVersionFragment
}
title
summary
priority {
...IncidentSchemaPriorityFragment
}
state {
...IncidentSchemaStateFragment
}
createdAt
timings {
...IncidentTimingsFragment
}
roles {
...IncidentRoleWithAssignmentFragment
}
events {
...IncidentEventListFragment
}
affectedServices {
...AffectedServiceFragment
}
statuspageLinks {
...IncidentStatuspageLinkFragment
}
communicationChannels {
...CommunicationChannelFragment
}
broadcastMessages {
...BroadcastMessageFragment
}
relatedAlerts {
...AlertFragment
}
}
owner {
id
name
createdAt
updatedAt
members {
...TeamMemberFragment
}
services {
...ServiceFragment
}
}
state
isDeleted
deletedAt
}
}
Variables
{"organizationUUID": 4}
Response
{
"data": {
"services": [
{
"id": 987,
"name": "xyz789",
"description": "abc123",
"incidents": [Incident],
"owner": Team,
"state": "OPERATIONAL",
"isDeleted": true,
"deletedAt": "10:15:30Z"
}
]
}
}
statuspage
Response
Returns a Statuspage
Example
Query
query Statuspage(
$organizationUUID: ID!,
$statuspageId: Int!
) {
statuspage(
organizationUUID: $organizationUUID,
statuspageId: $statuspageId
) {
id
name
slug
visibility
customDomain
domain
components {
id
position
type
description
component {
... on StatuspageComponentPayloadService {
...StatuspageComponentPayloadServiceFragment
}
}
createdAt
updatedAt
}
incidents {
publicId
type
title
summary
priority {
...StatuspageIncidentPriorityFragment
}
state {
...StatuspageIncidentStateFragment
}
severity
events {
...StatuspageIncidentEventListFragment
}
affectedComponents {
...StatuspageIncidentAffectedComponentFragment
}
timings {
...IncidentTimingsFragment
}
createdAt
updatedAt
statuspage {
...StatuspageFragment
}
}
whitelabelConfig {
colors {
...StatuspageWhitelabelColorsV1Fragment
}
logoUrl
showPoweredBy
}
createdAt
updatedAt
}
}
Variables
{"organizationUUID": 4, "statuspageId": 123}
Response
{
"data": {
"statuspage": {
"id": 123,
"name": "abc123",
"slug": "abc123",
"visibility": "PUBLIC",
"customDomain": "xyz789",
"domain": "xyz789",
"components": [StatuspageComponent],
"incidents": [StatuspageIncident],
"whitelabelConfig": StatuspageWhitelabelConfigV1,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
statuspageSubscriptions
Response
Returns a ListStatuspageSubscriptionsResponse!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
|
statuspageId - Int!
|
|
options - ListSubscriptionsOptions
|
Example
Query
query StatuspageSubscriptions(
$organizationId: ID!,
$statuspageId: Int!,
$options: ListSubscriptionsOptions
) {
statuspageSubscriptions(
organizationId: $organizationId,
statuspageId: $statuspageId,
options: $options
) {
totalSize
subscriptions {
id
manageToken
endpoints {
...RecipientEndpointFragment
}
createdAt
updatedAt
}
}
}
Variables
{
"organizationId": 4,
"statuspageId": 987,
"options": ListSubscriptionsOptions
}
Response
{
"data": {
"statuspageSubscriptions": {
"totalSize": 987,
"subscriptions": [StatuspageSubscription]
}
}
}
statuspages
Response
Returns a ListStatuspagesResponse!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
Example
Query
query Statuspages($organizationUUID: ID!) {
statuspages(organizationUUID: $organizationUUID) {
totalSize
statuspages {
id
name
slug
visibility
customDomain
domain
components {
...StatuspageComponentFragment
}
incidents {
...StatuspageIncidentFragment
}
whitelabelConfig {
...StatuspageWhitelabelConfigV1Fragment
}
createdAt
updatedAt
}
}
}
Variables
{"organizationUUID": "4"}
Response
{
"data": {
"statuspages": {
"totalSize": 123,
"statuspages": [Statuspage]
}
}
}
subscription
Response
Returns a PlanSubscription!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
Example
Query
query Subscription($organizationId: ID!) {
subscription(organizationId: $organizationId) {
id
plan {
id
name
order
prices {
...PriceFragment
}
features {
...FeatureFragment
}
}
status
canStartTrial
createdAt
updatedAt
details {
currentPlan {
...SubscriptionPlanDetailsFragment
}
changeAt
nextPlan {
...SubscriptionPlanDetailsFragment
}
currentPeriodStart
currentPeriodEnd
cancelAt
upcomingInvoice {
...PreviewInvoiceFragment
}
}
}
}
Variables
{"organizationId": 4}
Response
{
"data": {
"subscription": {
"id": "4",
"plan": Plan,
"status": "ACTIVE",
"canStartTrial": false,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"details": SubscriptionDetails
}
}
}
team
Example
Query
query Team(
$organizationUUID: ID!,
$teamId: Int!
) {
team(
organizationUUID: $organizationUUID,
teamId: $teamId
) {
id
name
createdAt
updatedAt
members {
id
orgMemberId
role
meta {
...UserMetaFragment
}
}
services {
id
name
description
incidents {
...IncidentFragment
}
owner {
...TeamFragment
}
state
isDeleted
deletedAt
}
}
}
Variables
{"organizationUUID": 4, "teamId": 987}
Response
{
"data": {
"team": {
"id": 123,
"name": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"members": [TeamMember],
"services": [Service]
}
}
}
teams
Example
Query
query Teams($organizationUUID: ID!) {
teams(organizationUUID: $organizationUUID) {
id
name
createdAt
updatedAt
members {
id
orgMemberId
role
meta {
...UserMetaFragment
}
}
services {
id
name
description
incidents {
...IncidentFragment
}
owner {
...TeamFragment
}
state
isDeleted
deletedAt
}
}
}
Variables
{"organizationUUID": 4}
Response
{
"data": {
"teams": [
{
"id": 123,
"name": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"members": [TeamMember],
"services": [Service]
}
]
}
}
Mutations
addCommentToIncident
Response
Returns an IncidentEvent!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
incidentId - Int!
|
|
commentSpec - CommentSpec!
|
Example
Query
mutation AddCommentToIncident(
$organizationUUID: ID!,
$incidentId: Int!,
$commentSpec: CommentSpec!
) {
addCommentToIncident(
organizationUUID: $organizationUUID,
incidentId: $incidentId,
commentSpec: $commentSpec
) {
id
type
payload {
... on IncidentEventPayloadEmpty {
...IncidentEventPayloadEmptyFragment
}
... on IncidentEventPayloadComment {
...IncidentEventPayloadCommentFragment
}
... on IncidentEventPayloadRole {
...IncidentEventPayloadRoleFragment
}
... on IncidentEventPayloadFieldUpdated {
...IncidentEventPayloadFieldUpdatedFragment
}
... on IncidentEventPayloadAffectedService {
...IncidentEventPayloadAffectedServiceFragment
}
... on IncidentEventPayloadResponder {
...IncidentEventPayloadResponderFragment
}
... on IncidentEventPayloadStatuspage {
...IncidentEventPayloadStatuspageFragment
}
... on IncidentEventPayloadState {
...IncidentEventPayloadStateFragment
}
... on IncidentEventPayloadPriority {
...IncidentEventPayloadPriorityFragment
}
}
createdAt
actor {
... on ServiceAccountActor {
...ServiceAccountActorFragment
}
... on OrgMemberActor {
...OrgMemberActorFragment
}
}
}
}
Variables
{
"organizationUUID": "4",
"incidentId": 123,
"commentSpec": CommentSpec
}
Response
{
"data": {
"addCommentToIncident": {
"id": 4,
"type": "xyz789",
"payload": IncidentEventPayloadEmpty,
"createdAt": "10:15:30Z",
"actor": ServiceAccountActor
}
}
}
addRelatedAlerts
Response
Returns a Boolean!
Example
Query
mutation AddRelatedAlerts(
$organizationId: ID!,
$relatedAlertIds: [ID!]!,
$existingRelationGroupId: ID
) {
addRelatedAlerts(
organizationId: $organizationId,
relatedAlertIds: $relatedAlertIds,
existingRelationGroupId: $existingRelationGroupId
)
}
Variables
{
"organizationId": "4",
"relatedAlertIds": ["4"],
"existingRelationGroupId": 4
}
Response
{"data": {"addRelatedAlerts": false}}
addTeamMember
Response
Returns a TeamMember!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
newTeamMemberSpec - JoinTeamRequest
|
Example
Query
mutation AddTeamMember(
$organizationUUID: ID!,
$newTeamMemberSpec: JoinTeamRequest
) {
addTeamMember(
organizationUUID: $organizationUUID,
newTeamMemberSpec: $newTeamMemberSpec
) {
id
orgMemberId
role
meta {
firstname
lastname
avatar
}
}
}
Variables
{
"organizationUUID": "4",
"newTeamMemberSpec": JoinTeamRequest
}
Response
{
"data": {
"addTeamMember": {
"id": "4",
"orgMemberId": "4",
"role": "abc123",
"meta": UserMeta
}
}
}
assignResponderRole
Response
Returns an IncidentRoleAssignment!
Example
Query
mutation AssignResponderRole(
$organizationUUID: ID!,
$incidentId: Int!,
$memberId: ID!,
$roleId: ID!
) {
assignResponderRole(
organizationUUID: $organizationUUID,
incidentId: $incidentId,
memberId: $memberId,
roleId: $roleId
) {
id
memberId
user {
firstname
lastname
avatar
}
createdAt
updatedAt
}
}
Variables
{
"organizationUUID": "4",
"incidentId": 123,
"memberId": "4",
"roleId": 4
}
Response
{
"data": {
"assignResponderRole": {
"id": "4",
"memberId": 4,
"user": UserMeta,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
createAlertProcessor
Response
Returns an AlertProcessor!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
|
processorSpec - AlertProcessorSpec!
|
Example
Query
mutation CreateAlertProcessor(
$organizationId: ID!,
$processorSpec: AlertProcessorSpec!
) {
createAlertProcessor(
organizationId: $organizationId,
processorSpec: $processorSpec
) {
id
name
configuration {
autoCreateIncidents
correlatorType
statisticalAlertCorrelator {
...StatisticalAlertCorrelatorFragment
}
}
statistics {
totalAlertsProcessed
lastAlertProcessedAt
}
createdAt
updatedAt
}
}
Variables
{
"organizationId": "4",
"processorSpec": AlertProcessorSpec
}
Response
{
"data": {
"createAlertProcessor": {
"id": "abc123",
"name": "xyz789",
"configuration": AlertProcessorConfiguration,
"statistics": AlertProcessorStatistics,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
createAlertSource
Response
Returns an AlertSource!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
|
sourceSpec - AlertSourceSpec!
|
Example
Query
mutation CreateAlertSource(
$organizationId: ID!,
$sourceSpec: AlertSourceSpec!
) {
createAlertSource(
organizationId: $organizationId,
sourceSpec: $sourceSpec
) {
id
type
token
name
version
configuration {
... on AlertmanagerSourceConfiguration {
...AlertmanagerSourceConfigurationFragment
}
}
webhookEndpoint
createdAt
updatedAt
alerts {
totalSize
alerts {
...AlertFragment
}
}
processor {
id
name
configuration {
...AlertProcessorConfigurationFragment
}
statistics {
...AlertProcessorStatisticsFragment
}
createdAt
updatedAt
}
}
}
Variables
{
"organizationId": "4",
"sourceSpec": AlertSourceSpec
}
Response
{
"data": {
"createAlertSource": {
"id": 4,
"type": "ALERTMANAGER",
"token": "xyz789",
"name": "abc123",
"version": 987,
"configuration": AlertmanagerSourceConfiguration,
"webhookEndpoint": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"alerts": AlertList,
"processor": AlertProcessor
}
}
}
createBroadcastChannel
Response
Returns a BroadcastChannel!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
|
spec - BroadcastChannelSpec!
|
Example
Query
mutation CreateBroadcastChannel(
$organizationId: ID!,
$spec: BroadcastChannelSpec!
) {
createBroadcastChannel(
organizationId: $organizationId,
spec: $spec
) {
id
endpoint {
id
providerType
providerProfileId
config {
... on ProviderChannelMetadata {
...ProviderChannelMetadataFragment
}
... on ProviderAddressMetadata {
...ProviderAddressMetadataFragment
}
}
doiConfirmed
doiConfirmedAt
}
iql
}
}
Variables
{
"organizationId": "4",
"spec": BroadcastChannelSpec
}
Response
{
"data": {
"createBroadcastChannel": {
"id": 4,
"endpoint": RecipientEndpoint,
"iql": "abc123"
}
}
}
createIncident
Response
Returns an Incident!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
newIncidentSpec - NewIncidentRequest!
|
Example
Query
mutation CreateIncident(
$organizationUUID: ID!,
$newIncidentSpec: NewIncidentRequest!
) {
createIncident(
organizationUUID: $organizationUUID,
newIncidentSpec: $newIncidentSpec
) {
id
schemaVersion {
id
schema {
...IncidentSchemaFragment
}
version
states {
...IncidentSchemaStateFragment
}
priorities {
...IncidentSchemaPriorityFragment
}
}
title
summary
priority {
id
name
order
color
icon
}
state {
id
name
order
icon
color
isDefault
isAcknowledged
isResolved
}
createdAt
timings {
impactStarted
impactDetected
impactResolved
}
roles {
role {
...IncidentRoleFragment
}
assignments {
...IncidentRoleAssignmentFragment
}
}
events {
totalSize
nextPageToken
events {
...IncidentEventFragment
}
}
affectedServices {
service {
...ServiceFragment
}
impact
}
statuspageLinks {
statuspage {
...StatuspageFragment
}
}
communicationChannels {
provider
channelName
channelLink
}
broadcastMessages {
id
channel {
...BroadcastChannelFragment
}
createdAt
updatedAt
}
relatedAlerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{
"organizationUUID": "4",
"newIncidentSpec": NewIncidentRequest
}
Response
{
"data": {
"createIncident": {
"id": 123,
"schemaVersion": IncidentSchemaVersion,
"title": "xyz789",
"summary": "abc123",
"priority": IncidentSchemaPriority,
"state": IncidentSchemaState,
"createdAt": "10:15:30Z",
"timings": IncidentTimings,
"roles": [IncidentRoleWithAssignment],
"events": IncidentEventList,
"affectedServices": [AffectedService],
"statuspageLinks": [IncidentStatuspageLink],
"communicationChannels": [CommunicationChannel],
"broadcastMessages": [BroadcastMessage],
"relatedAlerts": [Alert]
}
}
}
createIncidentCommunicationChannel
Response
Returns an Incident!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
communicationChannelSpec - CreateIncidentCommunicationChannelSpec!
|
Example
Query
mutation CreateIncidentCommunicationChannel(
$organizationUUID: ID!,
$communicationChannelSpec: CreateIncidentCommunicationChannelSpec!
) {
createIncidentCommunicationChannel(
organizationUUID: $organizationUUID,
communicationChannelSpec: $communicationChannelSpec
) {
id
schemaVersion {
id
schema {
...IncidentSchemaFragment
}
version
states {
...IncidentSchemaStateFragment
}
priorities {
...IncidentSchemaPriorityFragment
}
}
title
summary
priority {
id
name
order
color
icon
}
state {
id
name
order
icon
color
isDefault
isAcknowledged
isResolved
}
createdAt
timings {
impactStarted
impactDetected
impactResolved
}
roles {
role {
...IncidentRoleFragment
}
assignments {
...IncidentRoleAssignmentFragment
}
}
events {
totalSize
nextPageToken
events {
...IncidentEventFragment
}
}
affectedServices {
service {
...ServiceFragment
}
impact
}
statuspageLinks {
statuspage {
...StatuspageFragment
}
}
communicationChannels {
provider
channelName
channelLink
}
broadcastMessages {
id
channel {
...BroadcastChannelFragment
}
createdAt
updatedAt
}
relatedAlerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{
"organizationUUID": "4",
"communicationChannelSpec": CreateIncidentCommunicationChannelSpec
}
Response
{
"data": {
"createIncidentCommunicationChannel": {
"id": 123,
"schemaVersion": IncidentSchemaVersion,
"title": "xyz789",
"summary": "xyz789",
"priority": IncidentSchemaPriority,
"state": IncidentSchemaState,
"createdAt": "10:15:30Z",
"timings": IncidentTimings,
"roles": [IncidentRoleWithAssignment],
"events": IncidentEventList,
"affectedServices": [AffectedService],
"statuspageLinks": [IncidentStatuspageLink],
"communicationChannels": [CommunicationChannel],
"broadcastMessages": [BroadcastMessage],
"relatedAlerts": [Alert]
}
}
}
createIncidentRole
Response
Returns an IncidentRole!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
incidentRoleSpec - IncidentRoleSpec!
|
Example
Query
mutation CreateIncidentRole(
$organizationUUID: ID!,
$incidentRoleSpec: IncidentRoleSpec!
) {
createIncidentRole(
organizationUUID: $organizationUUID,
incidentRoleSpec: $incidentRoleSpec
) {
id
name
description
createdAt
updatedAt
}
}
Variables
{
"organizationUUID": 4,
"incidentRoleSpec": IncidentRoleSpec
}
Response
{
"data": {
"createIncidentRole": {
"id": 4,
"name": "abc123",
"description": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
createInvitation
Response
Returns an Invitation!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
createInvitationSpec - InvitationSpec!
|
Example
Query
mutation CreateInvitation(
$organizationUUID: ID!,
$createInvitationSpec: InvitationSpec!
) {
createInvitation(
organizationUUID: $organizationUUID,
createInvitationSpec: $createInvitationSpec
) {
id
email
role {
id
name
permissionRoles
}
validUntil
token
createdAt
updatedAt
organization {
id
name
members {
...OrganizationMemberFragment
}
subscription {
...PlanSubscriptionFragment
}
}
}
}
Variables
{
"organizationUUID": "4",
"createInvitationSpec": InvitationSpec
}
Response
{
"data": {
"createInvitation": {
"id": "4",
"email": "xyz789",
"role": OrganizationMemberRole,
"validUntil": "10:15:30Z",
"token": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"organization": Organization
}
}
}
createMonitor
Response
Returns a Monitor!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
|
spec - MonitorSpecInput!
|
Example
Query
mutation CreateMonitor(
$organizationId: ID!,
$spec: MonitorSpecInput!
) {
createMonitor(
organizationId: $organizationId,
spec: $spec
) {
id
service {
id
name
description
incidents {
...IncidentFragment
}
owner {
...TeamFragment
}
state
isDeleted
deletedAt
}
scheduling {
intervalSeconds
retries
}
probeType
probeConfiguration {
... on ICMPProbeConfiguration {
...ICMPProbeConfigurationFragment
}
... on HTTPProbeConfiguration {
...HTTPProbeConfigurationFragment
}
}
probeResults {
metadata {
...ProbeResultMetadataFragment
}
result {
... on ICMPProbeResult {
...ICMPProbeResultFragment
}
... on HTTPProbeResult {
...HTTPProbeResultFragment
}
}
}
createdAt
updatedAt
deletedAt
}
}
Variables
{
"organizationId": "4",
"spec": MonitorSpecInput
}
Response
{
"data": {
"createMonitor": {
"id": "xyz789",
"service": Service,
"scheduling": SchedulingConfiguration,
"probeType": "ICMP",
"probeConfiguration": ICMPProbeConfiguration,
"probeResults": [ProbeResult],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"deletedAt": "10:15:30Z"
}
}
}
createService
Response
Returns a Service!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
newServiceSpec - NewServiceSpec!
|
Example
Query
mutation CreateService(
$organizationUUID: ID!,
$newServiceSpec: NewServiceSpec!
) {
createService(
organizationUUID: $organizationUUID,
newServiceSpec: $newServiceSpec
) {
id
name
description
incidents {
id
schemaVersion {
...IncidentSchemaVersionFragment
}
title
summary
priority {
...IncidentSchemaPriorityFragment
}
state {
...IncidentSchemaStateFragment
}
createdAt
timings {
...IncidentTimingsFragment
}
roles {
...IncidentRoleWithAssignmentFragment
}
events {
...IncidentEventListFragment
}
affectedServices {
...AffectedServiceFragment
}
statuspageLinks {
...IncidentStatuspageLinkFragment
}
communicationChannels {
...CommunicationChannelFragment
}
broadcastMessages {
...BroadcastMessageFragment
}
relatedAlerts {
...AlertFragment
}
}
owner {
id
name
createdAt
updatedAt
members {
...TeamMemberFragment
}
services {
...ServiceFragment
}
}
state
isDeleted
deletedAt
}
}
Variables
{
"organizationUUID": "4",
"newServiceSpec": NewServiceSpec
}
Response
{
"data": {
"createService": {
"id": 123,
"name": "abc123",
"description": "xyz789",
"incidents": [Incident],
"owner": Team,
"state": "OPERATIONAL",
"isDeleted": false,
"deletedAt": "10:15:30Z"
}
}
}
createStatuspage
Response
Returns a Statuspage!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
createSpec - CreateStatuspageSpec!
|
Example
Query
mutation CreateStatuspage(
$organizationUUID: ID!,
$createSpec: CreateStatuspageSpec!
) {
createStatuspage(
organizationUUID: $organizationUUID,
createSpec: $createSpec
) {
id
name
slug
visibility
customDomain
domain
components {
id
position
type
description
component {
... on StatuspageComponentPayloadService {
...StatuspageComponentPayloadServiceFragment
}
}
createdAt
updatedAt
}
incidents {
publicId
type
title
summary
priority {
...StatuspageIncidentPriorityFragment
}
state {
...StatuspageIncidentStateFragment
}
severity
events {
...StatuspageIncidentEventListFragment
}
affectedComponents {
...StatuspageIncidentAffectedComponentFragment
}
timings {
...IncidentTimingsFragment
}
createdAt
updatedAt
statuspage {
...StatuspageFragment
}
}
whitelabelConfig {
colors {
...StatuspageWhitelabelColorsV1Fragment
}
logoUrl
showPoweredBy
}
createdAt
updatedAt
}
}
Variables
{
"organizationUUID": 4,
"createSpec": CreateStatuspageSpec
}
Response
{
"data": {
"createStatuspage": {
"id": 123,
"name": "xyz789",
"slug": "xyz789",
"visibility": "PUBLIC",
"customDomain": "abc123",
"domain": "abc123",
"components": [StatuspageComponent],
"incidents": [StatuspageIncident],
"whitelabelConfig": StatuspageWhitelabelConfigV1,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
createStatuspageComponent
Response
Returns a StatuspageComponent!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
statuspageId - Int!
|
|
componentSpec - StatuspageComponentSpec!
|
Example
Query
mutation CreateStatuspageComponent(
$organizationUUID: ID!,
$statuspageId: Int!,
$componentSpec: StatuspageComponentSpec!
) {
createStatuspageComponent(
organizationUUID: $organizationUUID,
statuspageId: $statuspageId,
componentSpec: $componentSpec
) {
id
position
type
description
component {
... on StatuspageComponentPayloadService {
...StatuspageComponentPayloadServiceFragment
}
}
createdAt
updatedAt
}
}
Variables
{
"organizationUUID": "4",
"statuspageId": 987,
"componentSpec": StatuspageComponentSpec
}
Response
{
"data": {
"createStatuspageComponent": {
"id": 4,
"position": 123,
"type": "SERVICE",
"description": "abc123",
"component": StatuspageComponentPayloadService,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
createTeam
Response
Returns a Team!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
newTeamSpec - NewTeamRequest!
|
Example
Query
mutation CreateTeam(
$organizationUUID: ID!,
$newTeamSpec: NewTeamRequest!
) {
createTeam(
organizationUUID: $organizationUUID,
newTeamSpec: $newTeamSpec
) {
id
name
createdAt
updatedAt
members {
id
orgMemberId
role
meta {
...UserMetaFragment
}
}
services {
id
name
description
incidents {
...IncidentFragment
}
owner {
...TeamFragment
}
state
isDeleted
deletedAt
}
}
}
Variables
{"organizationUUID": 4, "newTeamSpec": NewTeamRequest}
Response
{
"data": {
"createTeam": {
"id": 123,
"name": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"members": [TeamMember],
"services": [Service]
}
}
}
deleteAlertProcessor
Example
Query
mutation DeleteAlertProcessor(
$organizationId: ID!,
$alertProcessorId: ID!
) {
deleteAlertProcessor(
organizationId: $organizationId,
alertProcessorId: $alertProcessorId
)
}
Variables
{"organizationId": 4, "alertProcessorId": 4}
Response
{"data": {"deleteAlertProcessor": false}}
deleteAlertSource
Example
Query
mutation DeleteAlertSource(
$organizationId: ID!,
$alertSourceId: ID!
) {
deleteAlertSource(
organizationId: $organizationId,
alertSourceId: $alertSourceId
)
}
Variables
{"organizationId": "4", "alertSourceId": 4}
Response
{"data": {"deleteAlertSource": false}}
deleteBroadcastChannel
Response
Returns a Boolean!
Example
Query
mutation DeleteBroadcastChannel(
$organizationId: ID!,
$broadcastChannelId: ID!
) {
deleteBroadcastChannel(
organizationId: $organizationId,
broadcastChannelId: $broadcastChannelId
)
}
Variables
{"organizationId": 4, "broadcastChannelId": 4}
Response
{"data": {"deleteBroadcastChannel": false}}
deleteIncidentEvent
Response
Returns a Boolean!
Example
Query
mutation DeleteIncidentEvent(
$organizationUUID: ID!,
$incidentId: Int!,
$eventId: ID!
) {
deleteIncidentEvent(
organizationUUID: $organizationUUID,
incidentId: $incidentId,
eventId: $eventId
)
}
Variables
{
"organizationUUID": "4",
"incidentId": 123,
"eventId": "4"
}
Response
{"data": {"deleteIncidentEvent": true}}
deleteIncidentRole
Example
Query
mutation DeleteIncidentRole(
$organizationUUID: ID!,
$roleId: ID!
) {
deleteIncidentRole(
organizationUUID: $organizationUUID,
roleId: $roleId
)
}
Variables
{"organizationUUID": "4", "roleId": 4}
Response
{"data": {"deleteIncidentRole": true}}
deleteInvitation
Example
Query
mutation DeleteInvitation(
$organizationUUID: ID!,
$invitationID: ID!
) {
deleteInvitation(
organizationUUID: $organizationUUID,
invitationID: $invitationID
)
}
Variables
{"organizationUUID": 4, "invitationID": 4}
Response
{"data": {"deleteInvitation": true}}
deleteMonitor
Example
Query
mutation DeleteMonitor(
$organizationId: ID!,
$monitorId: ID!
) {
deleteMonitor(
organizationId: $organizationId,
monitorId: $monitorId
)
}
Variables
{"organizationId": 4, "monitorId": "4"}
Response
{"data": {"deleteMonitor": true}}
deleteOrganizationMember
Example
Query
mutation DeleteOrganizationMember(
$organizationUUID: ID!,
$membershipID: ID!
) {
deleteOrganizationMember(
organizationUUID: $organizationUUID,
membershipID: $membershipID
)
}
Variables
{
"organizationUUID": "4",
"membershipID": "4"
}
Response
{"data": {"deleteOrganizationMember": false}}
deleteService
Example
Query
mutation DeleteService(
$organizationUUID: ID!,
$serviceId: Int!
) {
deleteService(
organizationUUID: $organizationUUID,
serviceId: $serviceId
)
}
Variables
{"organizationUUID": "4", "serviceId": 987}
Response
{"data": {"deleteService": true}}
deleteStatuspage
Example
Query
mutation DeleteStatuspage(
$organizationUUID: ID!,
$statuspageId: Int!
) {
deleteStatuspage(
organizationUUID: $organizationUUID,
statuspageId: $statuspageId
)
}
Variables
{
"organizationUUID": "4",
"statuspageId": 987
}
Response
{"data": {"deleteStatuspage": true}}
deleteTeam
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
deleteTeamSpec - DeleteTeamRequest!
|
Example
Query
mutation DeleteTeam(
$organizationUUID: ID!,
$deleteTeamSpec: DeleteTeamRequest!
) {
deleteTeam(
organizationUUID: $organizationUUID,
deleteTeamSpec: $deleteTeamSpec
)
}
Variables
{
"organizationUUID": "4",
"deleteTeamSpec": DeleteTeamRequest
}
Response
{"data": {"deleteTeam": true}}
linkService
Response
Returns an Incident!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
linkServiceSpec - LinkServiceRequest!
|
Example
Query
mutation LinkService(
$organizationUUID: ID!,
$linkServiceSpec: LinkServiceRequest!
) {
linkService(
organizationUUID: $organizationUUID,
linkServiceSpec: $linkServiceSpec
) {
id
schemaVersion {
id
schema {
...IncidentSchemaFragment
}
version
states {
...IncidentSchemaStateFragment
}
priorities {
...IncidentSchemaPriorityFragment
}
}
title
summary
priority {
id
name
order
color
icon
}
state {
id
name
order
icon
color
isDefault
isAcknowledged
isResolved
}
createdAt
timings {
impactStarted
impactDetected
impactResolved
}
roles {
role {
...IncidentRoleFragment
}
assignments {
...IncidentRoleAssignmentFragment
}
}
events {
totalSize
nextPageToken
events {
...IncidentEventFragment
}
}
affectedServices {
service {
...ServiceFragment
}
impact
}
statuspageLinks {
statuspage {
...StatuspageFragment
}
}
communicationChannels {
provider
channelName
channelLink
}
broadcastMessages {
id
channel {
...BroadcastChannelFragment
}
createdAt
updatedAt
}
relatedAlerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{
"organizationUUID": 4,
"linkServiceSpec": LinkServiceRequest
}
Response
{
"data": {
"linkService": {
"id": 123,
"schemaVersion": IncidentSchemaVersion,
"title": "xyz789",
"summary": "abc123",
"priority": IncidentSchemaPriority,
"state": IncidentSchemaState,
"createdAt": "10:15:30Z",
"timings": IncidentTimings,
"roles": [IncidentRoleWithAssignment],
"events": IncidentEventList,
"affectedServices": [AffectedService],
"statuspageLinks": [IncidentStatuspageLink],
"communicationChannels": [CommunicationChannel],
"broadcastMessages": [BroadcastMessage],
"relatedAlerts": [Alert]
}
}
}
linkStatuspage
Response
Returns an Incident!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
linkStatuspageSpec - LinkStatuspageRequest!
|
Example
Query
mutation LinkStatuspage(
$organizationUUID: ID!,
$linkStatuspageSpec: LinkStatuspageRequest!
) {
linkStatuspage(
organizationUUID: $organizationUUID,
linkStatuspageSpec: $linkStatuspageSpec
) {
id
schemaVersion {
id
schema {
...IncidentSchemaFragment
}
version
states {
...IncidentSchemaStateFragment
}
priorities {
...IncidentSchemaPriorityFragment
}
}
title
summary
priority {
id
name
order
color
icon
}
state {
id
name
order
icon
color
isDefault
isAcknowledged
isResolved
}
createdAt
timings {
impactStarted
impactDetected
impactResolved
}
roles {
role {
...IncidentRoleFragment
}
assignments {
...IncidentRoleAssignmentFragment
}
}
events {
totalSize
nextPageToken
events {
...IncidentEventFragment
}
}
affectedServices {
service {
...ServiceFragment
}
impact
}
statuspageLinks {
statuspage {
...StatuspageFragment
}
}
communicationChannels {
provider
channelName
channelLink
}
broadcastMessages {
id
channel {
...BroadcastChannelFragment
}
createdAt
updatedAt
}
relatedAlerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{
"organizationUUID": 4,
"linkStatuspageSpec": LinkStatuspageRequest
}
Response
{
"data": {
"linkStatuspage": {
"id": 123,
"schemaVersion": IncidentSchemaVersion,
"title": "xyz789",
"summary": "xyz789",
"priority": IncidentSchemaPriority,
"state": IncidentSchemaState,
"createdAt": "10:15:30Z",
"timings": IncidentTimings,
"roles": [IncidentRoleWithAssignment],
"events": IncidentEventList,
"affectedServices": [AffectedService],
"statuspageLinks": [IncidentStatuspageLink],
"communicationChannels": [CommunicationChannel],
"broadcastMessages": [BroadcastMessage],
"relatedAlerts": [Alert]
}
}
}
orderStatuspageComponents
Response
Returns a Boolean!
Example
Query
mutation OrderStatuspageComponents(
$organizationUUID: ID!,
$statuspageId: Int!,
$orderedComponentIds: [ID!]!
) {
orderStatuspageComponents(
organizationUUID: $organizationUUID,
statuspageId: $statuspageId,
orderedComponentIds: $orderedComponentIds
)
}
Variables
{
"organizationUUID": "4",
"statuspageId": 987,
"orderedComponentIds": [4]
}
Response
{"data": {"orderStatuspageComponents": false}}
removeAlertRelations
Example
Query
mutation RemoveAlertRelations(
$organizationId: ID!,
$alertId: ID!
) {
removeAlertRelations(
organizationId: $organizationId,
alertId: $alertId
)
}
Variables
{"organizationId": 4, "alertId": "4"}
Response
{"data": {"removeAlertRelations": false}}
removeStatuspageComponent
Response
Returns a Boolean!
Example
Query
mutation RemoveStatuspageComponent(
$organizationUUID: ID!,
$statuspageId: Int!,
$componentId: ID!
) {
removeStatuspageComponent(
organizationUUID: $organizationUUID,
statuspageId: $statuspageId,
componentId: $componentId
)
}
Variables
{
"organizationUUID": 4,
"statuspageId": 123,
"componentId": "4"
}
Response
{"data": {"removeStatuspageComponent": true}}
removeTeamMember
Example
Query
mutation RemoveTeamMember(
$organizationUUID: ID!,
$membershipID: ID!
) {
removeTeamMember(
organizationUUID: $organizationUUID,
membershipID: $membershipID
)
}
Variables
{"organizationUUID": "4", "membershipID": 4}
Response
{"data": {"removeTeamMember": false}}
subscribeToStatuspage
Response
Returns a StatuspageSubscription!
Arguments
| Name | Description |
|---|---|
statuspageSlug - String!
|
|
endpointSpec - EndpointSpec!
|
Example
Query
mutation SubscribeToStatuspage(
$statuspageSlug: String!,
$endpointSpec: EndpointSpec!
) {
subscribeToStatuspage(
statuspageSlug: $statuspageSlug,
endpointSpec: $endpointSpec
) {
id
manageToken
endpoints {
id
providerType
providerProfileId
config {
... on ProviderChannelMetadata {
...ProviderChannelMetadataFragment
}
... on ProviderAddressMetadata {
...ProviderAddressMetadataFragment
}
}
doiConfirmed
doiConfirmedAt
}
createdAt
updatedAt
}
}
Variables
{
"statuspageSlug": "xyz789",
"endpointSpec": EndpointSpec
}
Response
{
"data": {
"subscribeToStatuspage": {
"id": 4,
"manageToken": "abc123",
"endpoints": [RecipientEndpoint],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
unAssignResponderRole
Response
Returns a Boolean!
Example
Query
mutation UnAssignResponderRole(
$organizationUUID: ID!,
$incidentId: Int!,
$assignmentId: ID!
) {
unAssignResponderRole(
organizationUUID: $organizationUUID,
incidentId: $incidentId,
assignmentId: $assignmentId
)
}
Variables
{
"organizationUUID": 4,
"incidentId": 123,
"assignmentId": "4"
}
Response
{"data": {"unAssignResponderRole": false}}
unLinkService
Response
Returns an Incident!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
unLinkServiceSpec - UnLinkServiceRequest!
|
Example
Query
mutation UnLinkService(
$organizationUUID: ID!,
$unLinkServiceSpec: UnLinkServiceRequest!
) {
unLinkService(
organizationUUID: $organizationUUID,
unLinkServiceSpec: $unLinkServiceSpec
) {
id
schemaVersion {
id
schema {
...IncidentSchemaFragment
}
version
states {
...IncidentSchemaStateFragment
}
priorities {
...IncidentSchemaPriorityFragment
}
}
title
summary
priority {
id
name
order
color
icon
}
state {
id
name
order
icon
color
isDefault
isAcknowledged
isResolved
}
createdAt
timings {
impactStarted
impactDetected
impactResolved
}
roles {
role {
...IncidentRoleFragment
}
assignments {
...IncidentRoleAssignmentFragment
}
}
events {
totalSize
nextPageToken
events {
...IncidentEventFragment
}
}
affectedServices {
service {
...ServiceFragment
}
impact
}
statuspageLinks {
statuspage {
...StatuspageFragment
}
}
communicationChannels {
provider
channelName
channelLink
}
broadcastMessages {
id
channel {
...BroadcastChannelFragment
}
createdAt
updatedAt
}
relatedAlerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{
"organizationUUID": "4",
"unLinkServiceSpec": UnLinkServiceRequest
}
Response
{
"data": {
"unLinkService": {
"id": 987,
"schemaVersion": IncidentSchemaVersion,
"title": "xyz789",
"summary": "xyz789",
"priority": IncidentSchemaPriority,
"state": IncidentSchemaState,
"createdAt": "10:15:30Z",
"timings": IncidentTimings,
"roles": [IncidentRoleWithAssignment],
"events": IncidentEventList,
"affectedServices": [AffectedService],
"statuspageLinks": [IncidentStatuspageLink],
"communicationChannels": [CommunicationChannel],
"broadcastMessages": [BroadcastMessage],
"relatedAlerts": [Alert]
}
}
}
unlinkStatuspage
Response
Returns an Incident!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
unlinkStatuspageSpec - UnlinkStatuspageRequest!
|
Example
Query
mutation UnlinkStatuspage(
$organizationUUID: ID!,
$unlinkStatuspageSpec: UnlinkStatuspageRequest!
) {
unlinkStatuspage(
organizationUUID: $organizationUUID,
unlinkStatuspageSpec: $unlinkStatuspageSpec
) {
id
schemaVersion {
id
schema {
...IncidentSchemaFragment
}
version
states {
...IncidentSchemaStateFragment
}
priorities {
...IncidentSchemaPriorityFragment
}
}
title
summary
priority {
id
name
order
color
icon
}
state {
id
name
order
icon
color
isDefault
isAcknowledged
isResolved
}
createdAt
timings {
impactStarted
impactDetected
impactResolved
}
roles {
role {
...IncidentRoleFragment
}
assignments {
...IncidentRoleAssignmentFragment
}
}
events {
totalSize
nextPageToken
events {
...IncidentEventFragment
}
}
affectedServices {
service {
...ServiceFragment
}
impact
}
statuspageLinks {
statuspage {
...StatuspageFragment
}
}
communicationChannels {
provider
channelName
channelLink
}
broadcastMessages {
id
channel {
...BroadcastChannelFragment
}
createdAt
updatedAt
}
relatedAlerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{
"organizationUUID": 4,
"unlinkStatuspageSpec": UnlinkStatuspageRequest
}
Response
{
"data": {
"unlinkStatuspage": {
"id": 987,
"schemaVersion": IncidentSchemaVersion,
"title": "xyz789",
"summary": "xyz789",
"priority": IncidentSchemaPriority,
"state": IncidentSchemaState,
"createdAt": "10:15:30Z",
"timings": IncidentTimings,
"roles": [IncidentRoleWithAssignment],
"events": IncidentEventList,
"affectedServices": [AffectedService],
"statuspageLinks": [IncidentStatuspageLink],
"communicationChannels": [CommunicationChannel],
"broadcastMessages": [BroadcastMessage],
"relatedAlerts": [Alert]
}
}
}
unsubscribeFromStatuspage
Response
Returns a Boolean!
Example
Query
mutation UnsubscribeFromStatuspage(
$statuspageSlug: String!,
$manageToken: String!
) {
unsubscribeFromStatuspage(
statuspageSlug: $statuspageSlug,
manageToken: $manageToken
)
}
Variables
{
"statuspageSlug": "xyz789",
"manageToken": "abc123"
}
Response
{"data": {"unsubscribeFromStatuspage": false}}
updateAlertProcessor
Response
Returns an AlertProcessor!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
|
alertProcessorId - ID!
|
|
processorSpec - AlertProcessorSpec!
|
Example
Query
mutation UpdateAlertProcessor(
$organizationId: ID!,
$alertProcessorId: ID!,
$processorSpec: AlertProcessorSpec!
) {
updateAlertProcessor(
organizationId: $organizationId,
alertProcessorId: $alertProcessorId,
processorSpec: $processorSpec
) {
id
name
configuration {
autoCreateIncidents
correlatorType
statisticalAlertCorrelator {
...StatisticalAlertCorrelatorFragment
}
}
statistics {
totalAlertsProcessed
lastAlertProcessedAt
}
createdAt
updatedAt
}
}
Variables
{
"organizationId": 4,
"alertProcessorId": "4",
"processorSpec": AlertProcessorSpec
}
Response
{
"data": {
"updateAlertProcessor": {
"id": "xyz789",
"name": "xyz789",
"configuration": AlertProcessorConfiguration,
"statistics": AlertProcessorStatistics,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
updateBroadcastChannel
Response
Returns a BroadcastChannel!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
|
broadcastChannelId - ID!
|
|
spec - BroadcastChannelSpec!
|
Example
Query
mutation UpdateBroadcastChannel(
$organizationId: ID!,
$broadcastChannelId: ID!,
$spec: BroadcastChannelSpec!
) {
updateBroadcastChannel(
organizationId: $organizationId,
broadcastChannelId: $broadcastChannelId,
spec: $spec
) {
id
endpoint {
id
providerType
providerProfileId
config {
... on ProviderChannelMetadata {
...ProviderChannelMetadataFragment
}
... on ProviderAddressMetadata {
...ProviderAddressMetadataFragment
}
}
doiConfirmed
doiConfirmedAt
}
iql
}
}
Variables
{
"organizationId": "4",
"broadcastChannelId": 4,
"spec": BroadcastChannelSpec
}
Response
{
"data": {
"updateBroadcastChannel": {
"id": "4",
"endpoint": RecipientEndpoint,
"iql": "xyz789"
}
}
}
updateIncidentPriority
Response
Returns an Incident!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
updateIncidentPrioritySpec - UpdateIncidentPriorityRequest!
|
Example
Query
mutation UpdateIncidentPriority(
$organizationUUID: ID!,
$updateIncidentPrioritySpec: UpdateIncidentPriorityRequest!
) {
updateIncidentPriority(
organizationUUID: $organizationUUID,
updateIncidentPrioritySpec: $updateIncidentPrioritySpec
) {
id
schemaVersion {
id
schema {
...IncidentSchemaFragment
}
version
states {
...IncidentSchemaStateFragment
}
priorities {
...IncidentSchemaPriorityFragment
}
}
title
summary
priority {
id
name
order
color
icon
}
state {
id
name
order
icon
color
isDefault
isAcknowledged
isResolved
}
createdAt
timings {
impactStarted
impactDetected
impactResolved
}
roles {
role {
...IncidentRoleFragment
}
assignments {
...IncidentRoleAssignmentFragment
}
}
events {
totalSize
nextPageToken
events {
...IncidentEventFragment
}
}
affectedServices {
service {
...ServiceFragment
}
impact
}
statuspageLinks {
statuspage {
...StatuspageFragment
}
}
communicationChannels {
provider
channelName
channelLink
}
broadcastMessages {
id
channel {
...BroadcastChannelFragment
}
createdAt
updatedAt
}
relatedAlerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{
"organizationUUID": 4,
"updateIncidentPrioritySpec": UpdateIncidentPriorityRequest
}
Response
{
"data": {
"updateIncidentPriority": {
"id": 123,
"schemaVersion": IncidentSchemaVersion,
"title": "xyz789",
"summary": "abc123",
"priority": IncidentSchemaPriority,
"state": IncidentSchemaState,
"createdAt": "10:15:30Z",
"timings": IncidentTimings,
"roles": [IncidentRoleWithAssignment],
"events": IncidentEventList,
"affectedServices": [AffectedService],
"statuspageLinks": [IncidentStatuspageLink],
"communicationChannels": [CommunicationChannel],
"broadcastMessages": [BroadcastMessage],
"relatedAlerts": [Alert]
}
}
}
updateIncidentRole
Response
Returns an IncidentRole!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
roleId - ID!
|
|
incidentRoleSpec - IncidentRoleSpec!
|
Example
Query
mutation UpdateIncidentRole(
$organizationUUID: ID!,
$roleId: ID!,
$incidentRoleSpec: IncidentRoleSpec!
) {
updateIncidentRole(
organizationUUID: $organizationUUID,
roleId: $roleId,
incidentRoleSpec: $incidentRoleSpec
) {
id
name
description
createdAt
updatedAt
}
}
Variables
{
"organizationUUID": "4",
"roleId": "4",
"incidentRoleSpec": IncidentRoleSpec
}
Response
{
"data": {
"updateIncidentRole": {
"id": "4",
"name": "xyz789",
"description": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
updateIncidentState
Response
Returns an Incident!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
updateIncidentStateSpec - UpdateIncidentStateRequest!
|
Example
Query
mutation UpdateIncidentState(
$organizationUUID: ID!,
$updateIncidentStateSpec: UpdateIncidentStateRequest!
) {
updateIncidentState(
organizationUUID: $organizationUUID,
updateIncidentStateSpec: $updateIncidentStateSpec
) {
id
schemaVersion {
id
schema {
...IncidentSchemaFragment
}
version
states {
...IncidentSchemaStateFragment
}
priorities {
...IncidentSchemaPriorityFragment
}
}
title
summary
priority {
id
name
order
color
icon
}
state {
id
name
order
icon
color
isDefault
isAcknowledged
isResolved
}
createdAt
timings {
impactStarted
impactDetected
impactResolved
}
roles {
role {
...IncidentRoleFragment
}
assignments {
...IncidentRoleAssignmentFragment
}
}
events {
totalSize
nextPageToken
events {
...IncidentEventFragment
}
}
affectedServices {
service {
...ServiceFragment
}
impact
}
statuspageLinks {
statuspage {
...StatuspageFragment
}
}
communicationChannels {
provider
channelName
channelLink
}
broadcastMessages {
id
channel {
...BroadcastChannelFragment
}
createdAt
updatedAt
}
relatedAlerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{
"organizationUUID": 4,
"updateIncidentStateSpec": UpdateIncidentStateRequest
}
Response
{
"data": {
"updateIncidentState": {
"id": 123,
"schemaVersion": IncidentSchemaVersion,
"title": "abc123",
"summary": "xyz789",
"priority": IncidentSchemaPriority,
"state": IncidentSchemaState,
"createdAt": "10:15:30Z",
"timings": IncidentTimings,
"roles": [IncidentRoleWithAssignment],
"events": IncidentEventList,
"affectedServices": [AffectedService],
"statuspageLinks": [IncidentStatuspageLink],
"communicationChannels": [CommunicationChannel],
"broadcastMessages": [BroadcastMessage],
"relatedAlerts": [Alert]
}
}
}
updateIncidentSummary
Response
Returns an Incident!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
updateIncidentSummarySpec - UpdateIncidentSummaryRequest!
|
Example
Query
mutation UpdateIncidentSummary(
$organizationUUID: ID!,
$updateIncidentSummarySpec: UpdateIncidentSummaryRequest!
) {
updateIncidentSummary(
organizationUUID: $organizationUUID,
updateIncidentSummarySpec: $updateIncidentSummarySpec
) {
id
schemaVersion {
id
schema {
...IncidentSchemaFragment
}
version
states {
...IncidentSchemaStateFragment
}
priorities {
...IncidentSchemaPriorityFragment
}
}
title
summary
priority {
id
name
order
color
icon
}
state {
id
name
order
icon
color
isDefault
isAcknowledged
isResolved
}
createdAt
timings {
impactStarted
impactDetected
impactResolved
}
roles {
role {
...IncidentRoleFragment
}
assignments {
...IncidentRoleAssignmentFragment
}
}
events {
totalSize
nextPageToken
events {
...IncidentEventFragment
}
}
affectedServices {
service {
...ServiceFragment
}
impact
}
statuspageLinks {
statuspage {
...StatuspageFragment
}
}
communicationChannels {
provider
channelName
channelLink
}
broadcastMessages {
id
channel {
...BroadcastChannelFragment
}
createdAt
updatedAt
}
relatedAlerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{
"organizationUUID": "4",
"updateIncidentSummarySpec": UpdateIncidentSummaryRequest
}
Response
{
"data": {
"updateIncidentSummary": {
"id": 123,
"schemaVersion": IncidentSchemaVersion,
"title": "xyz789",
"summary": "xyz789",
"priority": IncidentSchemaPriority,
"state": IncidentSchemaState,
"createdAt": "10:15:30Z",
"timings": IncidentTimings,
"roles": [IncidentRoleWithAssignment],
"events": IncidentEventList,
"affectedServices": [AffectedService],
"statuspageLinks": [IncidentStatuspageLink],
"communicationChannels": [CommunicationChannel],
"broadcastMessages": [BroadcastMessage],
"relatedAlerts": [Alert]
}
}
}
updateIncidentTimings
Response
Returns an Incident!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
updateIncidentTimingsSpec - UpdateIncidentTimingsRequest!
|
Example
Query
mutation UpdateIncidentTimings(
$organizationUUID: ID!,
$updateIncidentTimingsSpec: UpdateIncidentTimingsRequest!
) {
updateIncidentTimings(
organizationUUID: $organizationUUID,
updateIncidentTimingsSpec: $updateIncidentTimingsSpec
) {
id
schemaVersion {
id
schema {
...IncidentSchemaFragment
}
version
states {
...IncidentSchemaStateFragment
}
priorities {
...IncidentSchemaPriorityFragment
}
}
title
summary
priority {
id
name
order
color
icon
}
state {
id
name
order
icon
color
isDefault
isAcknowledged
isResolved
}
createdAt
timings {
impactStarted
impactDetected
impactResolved
}
roles {
role {
...IncidentRoleFragment
}
assignments {
...IncidentRoleAssignmentFragment
}
}
events {
totalSize
nextPageToken
events {
...IncidentEventFragment
}
}
affectedServices {
service {
...ServiceFragment
}
impact
}
statuspageLinks {
statuspage {
...StatuspageFragment
}
}
communicationChannels {
provider
channelName
channelLink
}
broadcastMessages {
id
channel {
...BroadcastChannelFragment
}
createdAt
updatedAt
}
relatedAlerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{
"organizationUUID": "4",
"updateIncidentTimingsSpec": UpdateIncidentTimingsRequest
}
Response
{
"data": {
"updateIncidentTimings": {
"id": 123,
"schemaVersion": IncidentSchemaVersion,
"title": "xyz789",
"summary": "xyz789",
"priority": IncidentSchemaPriority,
"state": IncidentSchemaState,
"createdAt": "10:15:30Z",
"timings": IncidentTimings,
"roles": [IncidentRoleWithAssignment],
"events": IncidentEventList,
"affectedServices": [AffectedService],
"statuspageLinks": [IncidentStatuspageLink],
"communicationChannels": [CommunicationChannel],
"broadcastMessages": [BroadcastMessage],
"relatedAlerts": [Alert]
}
}
}
updateIncidentTitle
Response
Returns an Incident!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
updateIncidentTitleSpec - UpdateIncidentTitleRequest!
|
Example
Query
mutation UpdateIncidentTitle(
$organizationUUID: ID!,
$updateIncidentTitleSpec: UpdateIncidentTitleRequest!
) {
updateIncidentTitle(
organizationUUID: $organizationUUID,
updateIncidentTitleSpec: $updateIncidentTitleSpec
) {
id
schemaVersion {
id
schema {
...IncidentSchemaFragment
}
version
states {
...IncidentSchemaStateFragment
}
priorities {
...IncidentSchemaPriorityFragment
}
}
title
summary
priority {
id
name
order
color
icon
}
state {
id
name
order
icon
color
isDefault
isAcknowledged
isResolved
}
createdAt
timings {
impactStarted
impactDetected
impactResolved
}
roles {
role {
...IncidentRoleFragment
}
assignments {
...IncidentRoleAssignmentFragment
}
}
events {
totalSize
nextPageToken
events {
...IncidentEventFragment
}
}
affectedServices {
service {
...ServiceFragment
}
impact
}
statuspageLinks {
statuspage {
...StatuspageFragment
}
}
communicationChannels {
provider
channelName
channelLink
}
broadcastMessages {
id
channel {
...BroadcastChannelFragment
}
createdAt
updatedAt
}
relatedAlerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{
"organizationUUID": 4,
"updateIncidentTitleSpec": UpdateIncidentTitleRequest
}
Response
{
"data": {
"updateIncidentTitle": {
"id": 123,
"schemaVersion": IncidentSchemaVersion,
"title": "xyz789",
"summary": "abc123",
"priority": IncidentSchemaPriority,
"state": IncidentSchemaState,
"createdAt": "10:15:30Z",
"timings": IncidentTimings,
"roles": [IncidentRoleWithAssignment],
"events": IncidentEventList,
"affectedServices": [AffectedService],
"statuspageLinks": [IncidentStatuspageLink],
"communicationChannels": [CommunicationChannel],
"broadcastMessages": [BroadcastMessage],
"relatedAlerts": [Alert]
}
}
}
updateMonitor
Response
Returns a Monitor!
Arguments
| Name | Description |
|---|---|
organizationId - ID!
|
|
monitorId - ID!
|
|
spec - MonitorSpecInput
|
Example
Query
mutation UpdateMonitor(
$organizationId: ID!,
$monitorId: ID!,
$spec: MonitorSpecInput
) {
updateMonitor(
organizationId: $organizationId,
monitorId: $monitorId,
spec: $spec
) {
id
service {
id
name
description
incidents {
...IncidentFragment
}
owner {
...TeamFragment
}
state
isDeleted
deletedAt
}
scheduling {
intervalSeconds
retries
}
probeType
probeConfiguration {
... on ICMPProbeConfiguration {
...ICMPProbeConfigurationFragment
}
... on HTTPProbeConfiguration {
...HTTPProbeConfigurationFragment
}
}
probeResults {
metadata {
...ProbeResultMetadataFragment
}
result {
... on ICMPProbeResult {
...ICMPProbeResultFragment
}
... on HTTPProbeResult {
...HTTPProbeResultFragment
}
}
}
createdAt
updatedAt
deletedAt
}
}
Variables
{
"organizationId": 4,
"monitorId": 4,
"spec": MonitorSpecInput
}
Response
{
"data": {
"updateMonitor": {
"id": "abc123",
"service": Service,
"scheduling": SchedulingConfiguration,
"probeType": "ICMP",
"probeConfiguration": ICMPProbeConfiguration,
"probeResults": [ProbeResult],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"deletedAt": "10:15:30Z"
}
}
}
updateOrganizationMemberRole
Response
Returns an OrganizationMemberRole!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
updateRoleRequest - UpdateOrganizationMemberRoleRequest!
|
Example
Query
mutation UpdateOrganizationMemberRole(
$organizationUUID: ID!,
$updateRoleRequest: UpdateOrganizationMemberRoleRequest!
) {
updateOrganizationMemberRole(
organizationUUID: $organizationUUID,
updateRoleRequest: $updateRoleRequest
) {
id
name
permissionRoles
}
}
Variables
{
"organizationUUID": 4,
"updateRoleRequest": UpdateOrganizationMemberRoleRequest
}
Response
{
"data": {
"updateOrganizationMemberRole": {
"id": "abc123",
"name": "abc123",
"permissionRoles": ["abc123"]
}
}
}
updateService
Response
Returns a Service!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
serviceId - Int!
|
|
updateServiceSpec - UpdateServiceSpec!
|
Example
Query
mutation UpdateService(
$organizationUUID: ID!,
$serviceId: Int!,
$updateServiceSpec: UpdateServiceSpec!
) {
updateService(
organizationUUID: $organizationUUID,
serviceId: $serviceId,
updateServiceSpec: $updateServiceSpec
) {
id
name
description
incidents {
id
schemaVersion {
...IncidentSchemaVersionFragment
}
title
summary
priority {
...IncidentSchemaPriorityFragment
}
state {
...IncidentSchemaStateFragment
}
createdAt
timings {
...IncidentTimingsFragment
}
roles {
...IncidentRoleWithAssignmentFragment
}
events {
...IncidentEventListFragment
}
affectedServices {
...AffectedServiceFragment
}
statuspageLinks {
...IncidentStatuspageLinkFragment
}
communicationChannels {
...CommunicationChannelFragment
}
broadcastMessages {
...BroadcastMessageFragment
}
relatedAlerts {
...AlertFragment
}
}
owner {
id
name
createdAt
updatedAt
members {
...TeamMemberFragment
}
services {
...ServiceFragment
}
}
state
isDeleted
deletedAt
}
}
Variables
{
"organizationUUID": 4,
"serviceId": 123,
"updateServiceSpec": UpdateServiceSpec
}
Response
{
"data": {
"updateService": {
"id": 123,
"name": "xyz789",
"description": "xyz789",
"incidents": [Incident],
"owner": Team,
"state": "OPERATIONAL",
"isDeleted": false,
"deletedAt": "10:15:30Z"
}
}
}
updateServiceImpact
Response
Returns an Incident!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
updateServiceImpactSpec - UpdateServiceImpactRequest!
|
Example
Query
mutation UpdateServiceImpact(
$organizationUUID: ID!,
$updateServiceImpactSpec: UpdateServiceImpactRequest!
) {
updateServiceImpact(
organizationUUID: $organizationUUID,
updateServiceImpactSpec: $updateServiceImpactSpec
) {
id
schemaVersion {
id
schema {
...IncidentSchemaFragment
}
version
states {
...IncidentSchemaStateFragment
}
priorities {
...IncidentSchemaPriorityFragment
}
}
title
summary
priority {
id
name
order
color
icon
}
state {
id
name
order
icon
color
isDefault
isAcknowledged
isResolved
}
createdAt
timings {
impactStarted
impactDetected
impactResolved
}
roles {
role {
...IncidentRoleFragment
}
assignments {
...IncidentRoleAssignmentFragment
}
}
events {
totalSize
nextPageToken
events {
...IncidentEventFragment
}
}
affectedServices {
service {
...ServiceFragment
}
impact
}
statuspageLinks {
statuspage {
...StatuspageFragment
}
}
communicationChannels {
provider
channelName
channelLink
}
broadcastMessages {
id
channel {
...BroadcastChannelFragment
}
createdAt
updatedAt
}
relatedAlerts {
id
state
name
description
referenceId
metadata {
...AlertMetadataFragment
}
processingStatus {
...AlertProcessingStatusFragment
}
alertedAt
startedAt
resolvedAt
createdAt
relationGroupId
relatedAlerts {
...AlertFragment
}
}
}
}
Variables
{
"organizationUUID": 4,
"updateServiceImpactSpec": UpdateServiceImpactRequest
}
Response
{
"data": {
"updateServiceImpact": {
"id": 987,
"schemaVersion": IncidentSchemaVersion,
"title": "xyz789",
"summary": "xyz789",
"priority": IncidentSchemaPriority,
"state": IncidentSchemaState,
"createdAt": "10:15:30Z",
"timings": IncidentTimings,
"roles": [IncidentRoleWithAssignment],
"events": IncidentEventList,
"affectedServices": [AffectedService],
"statuspageLinks": [IncidentStatuspageLink],
"communicationChannels": [CommunicationChannel],
"broadcastMessages": [BroadcastMessage],
"relatedAlerts": [Alert]
}
}
}
updateStatuspage
Response
Returns a Statuspage!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
statuspageId - Int!
|
|
updateSpec - UpdateStatuspageSpec
|
Example
Query
mutation UpdateStatuspage(
$organizationUUID: ID!,
$statuspageId: Int!,
$updateSpec: UpdateStatuspageSpec
) {
updateStatuspage(
organizationUUID: $organizationUUID,
statuspageId: $statuspageId,
updateSpec: $updateSpec
) {
id
name
slug
visibility
customDomain
domain
components {
id
position
type
description
component {
... on StatuspageComponentPayloadService {
...StatuspageComponentPayloadServiceFragment
}
}
createdAt
updatedAt
}
incidents {
publicId
type
title
summary
priority {
...StatuspageIncidentPriorityFragment
}
state {
...StatuspageIncidentStateFragment
}
severity
events {
...StatuspageIncidentEventListFragment
}
affectedComponents {
...StatuspageIncidentAffectedComponentFragment
}
timings {
...IncidentTimingsFragment
}
createdAt
updatedAt
statuspage {
...StatuspageFragment
}
}
whitelabelConfig {
colors {
...StatuspageWhitelabelColorsV1Fragment
}
logoUrl
showPoweredBy
}
createdAt
updatedAt
}
}
Variables
{
"organizationUUID": 4,
"statuspageId": 987,
"updateSpec": UpdateStatuspageSpec
}
Response
{
"data": {
"updateStatuspage": {
"id": 123,
"name": "abc123",
"slug": "abc123",
"visibility": "PUBLIC",
"customDomain": "abc123",
"domain": "xyz789",
"components": [StatuspageComponent],
"incidents": [StatuspageIncident],
"whitelabelConfig": StatuspageWhitelabelConfigV1,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
updateStatuspageComponent
Response
Returns a StatuspageComponent!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
statuspageId - Int!
|
|
componentId - ID!
|
|
updateSpec - StatuspageComponentUpdateSpec!
|
Example
Query
mutation UpdateStatuspageComponent(
$organizationUUID: ID!,
$statuspageId: Int!,
$componentId: ID!,
$updateSpec: StatuspageComponentUpdateSpec!
) {
updateStatuspageComponent(
organizationUUID: $organizationUUID,
statuspageId: $statuspageId,
componentId: $componentId,
updateSpec: $updateSpec
) {
id
position
type
description
component {
... on StatuspageComponentPayloadService {
...StatuspageComponentPayloadServiceFragment
}
}
createdAt
updatedAt
}
}
Variables
{
"organizationUUID": 4,
"statuspageId": 123,
"componentId": "4",
"updateSpec": StatuspageComponentUpdateSpec
}
Response
{
"data": {
"updateStatuspageComponent": {
"id": 4,
"position": 123,
"type": "SERVICE",
"description": "abc123",
"component": StatuspageComponentPayloadService,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
updateTeam
Response
Returns a Team!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
updateTeamSpec - UpdateTeamRequest!
|
Example
Query
mutation UpdateTeam(
$organizationUUID: ID!,
$updateTeamSpec: UpdateTeamRequest!
) {
updateTeam(
organizationUUID: $organizationUUID,
updateTeamSpec: $updateTeamSpec
) {
id
name
createdAt
updatedAt
members {
id
orgMemberId
role
meta {
...UserMetaFragment
}
}
services {
id
name
description
incidents {
...IncidentFragment
}
owner {
...TeamFragment
}
state
isDeleted
deletedAt
}
}
}
Variables
{
"organizationUUID": 4,
"updateTeamSpec": UpdateTeamRequest
}
Response
{
"data": {
"updateTeam": {
"id": 987,
"name": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"members": [TeamMember],
"services": [Service]
}
}
}
updateTeamMemberRole
Response
Returns a TeamMember!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
|
updateRoleRequest - UpdateTeamMemberRoleRequest!
|
Example
Query
mutation UpdateTeamMemberRole(
$organizationUUID: ID!,
$updateRoleRequest: UpdateTeamMemberRoleRequest!
) {
updateTeamMemberRole(
organizationUUID: $organizationUUID,
updateRoleRequest: $updateRoleRequest
) {
id
orgMemberId
role
meta {
firstname
lastname
avatar
}
}
}
Variables
{
"organizationUUID": 4,
"updateRoleRequest": UpdateTeamMemberRoleRequest
}
Response
{
"data": {
"updateTeamMemberRole": {
"id": "4",
"orgMemberId": 4,
"role": "xyz789",
"meta": UserMeta
}
}
}
Subscriptions
incidentEvents
Response
Returns an IncidentSubscriptionEvent!
Arguments
| Name | Description |
|---|---|
organizationUUID - ID!
|
Example
Query
subscription IncidentEvents($organizationUUID: ID!) {
incidentEvents(organizationUUID: $organizationUUID) {
incidentId
event {
id
type
payload {
... on IncidentEventPayloadEmpty {
...IncidentEventPayloadEmptyFragment
}
... on IncidentEventPayloadComment {
...IncidentEventPayloadCommentFragment
}
... on IncidentEventPayloadRole {
...IncidentEventPayloadRoleFragment
}
... on IncidentEventPayloadFieldUpdated {
...IncidentEventPayloadFieldUpdatedFragment
}
... on IncidentEventPayloadAffectedService {
...IncidentEventPayloadAffectedServiceFragment
}
... on IncidentEventPayloadResponder {
...IncidentEventPayloadResponderFragment
}
... on IncidentEventPayloadStatuspage {
...IncidentEventPayloadStatuspageFragment
}
... on IncidentEventPayloadState {
...IncidentEventPayloadStateFragment
}
... on IncidentEventPayloadPriority {
...IncidentEventPayloadPriorityFragment
}
}
createdAt
actor {
... on ServiceAccountActor {
...ServiceAccountActorFragment
}
... on OrgMemberActor {
...OrgMemberActorFragment
}
}
}
}
}
Variables
{"organizationUUID": 4}
Response
{
"data": {
"incidentEvents": {
"incidentId": 123,
"event": IncidentEvent
}
}
}
Types
AffectedService
Alert
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
state - AlertState!
|
|
name - String!
|
|
description - String!
|
|
referenceId - String!
|
|
metadata - AlertMetadata!
|
|
processingStatus - AlertProcessingStatus
|
|
alertedAt - Time!
|
|
startedAt - Time!
|
|
resolvedAt - Time
|
|
createdAt - Time!
|
|
relationGroupId - ID
|
|
relatedAlerts - [Alert!]!
|
Example
{
"id": 4,
"state": "ACTIVE",
"name": "xyz789",
"description": "xyz789",
"referenceId": "abc123",
"metadata": AlertMetadata,
"processingStatus": AlertProcessingStatus,
"alertedAt": "10:15:30Z",
"startedAt": "10:15:30Z",
"resolvedAt": "10:15:30Z",
"createdAt": "10:15:30Z",
"relationGroupId": "4",
"relatedAlerts": [Alert]
}
AlertCorrelatorType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"STATISTICAL"
AlertList
AlertMetadata
AlertProcessingStatus
AlertProcessor
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
name - String!
|
|
configuration - AlertProcessorConfiguration!
|
|
statistics - AlertProcessorStatistics!
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
Example
{
"id": "xyz789",
"name": "abc123",
"configuration": AlertProcessorConfiguration,
"statistics": AlertProcessorStatistics,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
AlertProcessorConfiguration
Fields
| Field Name | Description |
|---|---|
autoCreateIncidents - Boolean!
|
|
correlatorType - AlertCorrelatorType!
|
|
statisticalAlertCorrelator - StatisticalAlertCorrelator
|
Example
{
"autoCreateIncidents": false,
"correlatorType": "STATISTICAL",
"statisticalAlertCorrelator": StatisticalAlertCorrelator
}
AlertProcessorConfigurationSpec
Fields
| Input Field | Description |
|---|---|
autoCreateIncidents - Boolean!
|
|
correlatorType - AlertCorrelatorType!
|
|
statisticalAlertCorrelatorSpec - StatisticalAlertCorrelatorSpec
|
|
mlAlertCorrelatorSpec - MLAlertCorrelatorSpec
|
Example
{
"autoCreateIncidents": true,
"correlatorType": "STATISTICAL",
"statisticalAlertCorrelatorSpec": StatisticalAlertCorrelatorSpec,
"mlAlertCorrelatorSpec": MLAlertCorrelatorSpec
}
AlertProcessorSpec
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
configuration - AlertProcessorConfigurationSpec!
|
Example
{
"name": "abc123",
"configuration": AlertProcessorConfigurationSpec
}
AlertProcessorStatistics
AlertSource
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
type - AlertSourceType!
|
|
token - String!
|
|
name - String!
|
|
version - Int!
|
|
configuration - AlertSourceConfiguration!
|
|
webhookEndpoint - String!
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
|
alerts - AlertList!
|
|
processor - AlertProcessor!
|
|
Example
{
"id": 4,
"type": "ALERTMANAGER",
"token": "xyz789",
"name": "abc123",
"version": 123,
"configuration": AlertmanagerSourceConfiguration,
"webhookEndpoint": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"alerts": AlertList,
"processor": AlertProcessor
}
AlertSourceConfiguration
Types
| Union Types |
|---|
Example
AlertmanagerSourceConfiguration
AlertSourceConfigurationSpec
Fields
| Input Field | Description |
|---|---|
alertmanager - AlertmanagerSourceConfigurationSpec
|
Example
{"alertmanager": AlertmanagerSourceConfigurationSpec}
AlertSourceSpec
Fields
| Input Field | Description |
|---|---|
processorId - ID!
|
|
type - AlertSourceType!
|
|
name - String!
|
|
version - Int!
|
|
configuration - AlertSourceConfigurationSpec!
|
Example
{
"processorId": 4,
"type": "ALERTMANAGER",
"name": "abc123",
"version": 987,
"configuration": AlertSourceConfigurationSpec
}
AlertSourceType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"ALERTMANAGER"
AlertState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
AlertmanagerSourceConfiguration
AlertmanagerSourceConfigurationSpec
AppliedDiscount
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
description - String!
|
|
duration - DiscountDuration!
|
|
durationInMonths - Int
|
|
discount - DiscountValue!
|
Example
{
"code": "xyz789",
"description": "xyz789",
"duration": "ONCE",
"durationInMonths": 123,
"discount": PercentageDiscountValue
}
BillingAddress
BillingDetails
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
address - BillingAddress
|
Example
{
"name": "xyz789",
"address": BillingAddress
}
Boolean
Description
The Boolean scalar type represents true or false.
BroadcastChannel
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
endpoint - RecipientEndpoint!
|
|
iql - String!
|
Example
{
"id": 4,
"endpoint": RecipientEndpoint,
"iql": "xyz789"
}
BroadcastChannelSpec
BroadcastMessage
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
channel - BroadcastChannel!
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
Example
{
"id": "4",
"channel": BroadcastChannel,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
CommentSpec
Fields
| Input Field | Description |
|---|---|
comment - String!
|
Example
{"comment": "abc123"}
CommunicationChannel
CreateIncidentCommunicationChannelSpec
CreateStatuspageSpec
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
visibility - StatuspageVisibility!
|
Example
{"name": "xyz789", "visibility": "PUBLIC"}
DataPoint
DeleteTeamRequest
Fields
| Input Field | Description |
|---|---|
teamId - Int!
|
Example
{"teamId": 123}
DiscountDuration
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ONCE"
DiscountValue
Types
| Union Types |
|---|
Example
PercentageDiscountValue
EndpointSpec
Fields
| Input Field | Description |
|---|---|
email - String
|
Example
{"email": "xyz789"}
EventActor
Types
| Union Types |
|---|
Example
ServiceAccountActor
Feature
FieldIntValue
Fields
| Field Name | Description |
|---|---|
intValue - Int!
|
Example
{"intValue": 123}
FieldStringValue
Fields
| Field Name | Description |
|---|---|
stringValue - String!
|
Example
{"stringValue": "xyz789"}
FieldValue
Types
| Union Types |
|---|
Example
FieldIntValue
FixedDiscountValue
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
HTTPProbeCertificateInformation
HTTPProbeConfiguration
HTTPProbeConfigurationInput
HTTPProbeResult
Fields
| Field Name | Description |
|---|---|
address - String!
|
|
durationMs - Int!
|
|
statusCode - Int!
|
|
httpVersion - String!
|
|
httpContentLength - Int!
|
|
redirectCount - Int!
|
|
ipProtocolVersion - Int!
|
|
isSSL - Boolean!
|
|
tlsInformation - HTTPProbeTLSInformation
|
|
timingInformation - HTTPProbeTimingInformation!
|
Example
{
"address": "abc123",
"durationMs": 987,
"statusCode": 123,
"httpVersion": "xyz789",
"httpContentLength": 123,
"redirectCount": 987,
"ipProtocolVersion": 987,
"isSSL": false,
"tlsInformation": HTTPProbeTLSInformation,
"timingInformation": HTTPProbeTimingInformation
}
HTTPProbeTLSInformation
Fields
| Field Name | Description |
|---|---|
earliestCertExpiry - Time!
|
|
version - String!
|
|
certificateInformation - HTTPProbeCertificateInformation!
|
Example
{
"earliestCertExpiry": "10:15:30Z",
"version": "xyz789",
"certificateInformation": HTTPProbeCertificateInformation
}
HTTPProbeTimingInformation
ICMPProbeConfiguration
ICMPProbeConfigurationInput
ICMPProbeResult
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
Incident
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
schemaVersion - IncidentSchemaVersion!
|
|
title - String!
|
|
summary - String!
|
|
priority - IncidentSchemaPriority!
|
|
state - IncidentSchemaState!
|
|
createdAt - Time!
|
|
timings - IncidentTimings!
|
|
roles - [IncidentRoleWithAssignment!]
|
|
events - IncidentEventList
|
|
Arguments
|
|
affectedServices - [AffectedService!]
|
|
statuspageLinks - [IncidentStatuspageLink!]
|
|
communicationChannels - [CommunicationChannel!]
|
|
broadcastMessages - [BroadcastMessage!]
|
|
relatedAlerts - [Alert!]
|
|
Example
{
"id": 123,
"schemaVersion": IncidentSchemaVersion,
"title": "xyz789",
"summary": "abc123",
"priority": IncidentSchemaPriority,
"state": IncidentSchemaState,
"createdAt": "10:15:30Z",
"timings": IncidentTimings,
"roles": [IncidentRoleWithAssignment],
"events": IncidentEventList,
"affectedServices": [AffectedService],
"statuspageLinks": [IncidentStatuspageLink],
"communicationChannels": [CommunicationChannel],
"broadcastMessages": [BroadcastMessage],
"relatedAlerts": [Alert]
}
IncidentEvent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
type - String!
|
|
payload - IncidentEventPayload
|
|
createdAt - Time!
|
|
actor - EventActor!
|
Example
{
"id": "4",
"type": "xyz789",
"payload": IncidentEventPayloadEmpty,
"createdAt": "10:15:30Z",
"actor": ServiceAccountActor
}
IncidentEventList
Fields
| Field Name | Description |
|---|---|
totalSize - Int!
|
|
nextPageToken - String!
|
|
events - [IncidentEvent!]!
|
Example
{
"totalSize": 987,
"nextPageToken": "abc123",
"events": [IncidentEvent]
}
IncidentEventPayload
Example
IncidentEventPayloadEmpty
IncidentEventPayloadAffectedService
IncidentEventPayloadComment
Fields
| Field Name | Description |
|---|---|
comment - String!
|
Example
{"comment": "xyz789"}
IncidentEventPayloadEmpty
Fields
| Field Name | Description |
|---|---|
empty - Boolean
|
Example
{"empty": false}
IncidentEventPayloadFieldUpdated
Fields
| Field Name | Description |
|---|---|
field - String!
|
|
oldValue - FieldValue!
|
|
newValue - FieldValue!
|
Example
{
"field": "abc123",
"oldValue": FieldIntValue,
"newValue": FieldIntValue
}
IncidentEventPayloadPriority
Fields
| Field Name | Description |
|---|---|
oldPriority - IncidentSchemaPriority!
|
|
newPriority - IncidentSchemaPriority!
|
Example
{
"oldPriority": IncidentSchemaPriority,
"newPriority": IncidentSchemaPriority
}
IncidentEventPayloadResponder
Fields
| Field Name | Description |
|---|---|
responder - UserMeta!
|
Example
{"responder": UserMeta}
IncidentEventPayloadRole
Fields
| Field Name | Description |
|---|---|
role - IncidentRole!
|
|
assignee - UserMeta!
|
Example
{
"role": IncidentRole,
"assignee": UserMeta
}
IncidentEventPayloadState
Fields
| Field Name | Description |
|---|---|
oldState - IncidentSchemaState!
|
|
newState - IncidentSchemaState!
|
Example
{
"oldState": IncidentSchemaState,
"newState": IncidentSchemaState
}
IncidentEventPayloadStatuspage
Fields
| Field Name | Description |
|---|---|
statuspage - Statuspage!
|
Example
{"statuspage": Statuspage}
IncidentRole
IncidentRoleAssignment
IncidentRoleSpec
IncidentRoleWithAssignment
Fields
| Field Name | Description |
|---|---|
role - IncidentRole!
|
|
assignments - [IncidentRoleAssignment!]!
|
Example
{
"role": IncidentRole,
"assignments": [IncidentRoleAssignment]
}
IncidentSchema
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
name - String!
|
|
type - IncidentSchemaType!
|
|
currentVersion - IncidentSchemaVersion!
|
|
createdAt - Time!
|
Example
{
"id": "xyz789",
"name": "abc123",
"type": "INCIDENT",
"currentVersion": IncidentSchemaVersion,
"createdAt": "10:15:30Z"
}
IncidentSchemaPriority
IncidentSchemaState
Example
{
"id": "abc123",
"name": "xyz789",
"order": 123,
"icon": "abc123",
"color": "xyz789",
"isDefault": true,
"isAcknowledged": false,
"isResolved": true
}
IncidentSchemaType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INCIDENT"
IncidentSchemaVersion
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
schema - IncidentSchema!
|
|
version - Int!
|
|
states - [IncidentSchemaState!]!
|
|
priorities - [IncidentSchemaPriority!]!
|
Example
{
"id": "xyz789",
"schema": IncidentSchema,
"version": 987,
"states": [IncidentSchemaState],
"priorities": [IncidentSchemaPriority]
}
IncidentStatuspageLink
Fields
| Field Name | Description |
|---|---|
statuspage - Statuspage!
|
Example
{"statuspage": Statuspage}
IncidentSubscriptionEvent
Fields
| Field Name | Description |
|---|---|
incidentId - Int!
|
|
event - IncidentEvent!
|
Example
{"incidentId": 987, "event": IncidentEvent}
IncidentTimings
IncidentsStatistic
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
unit - String!
|
|
datapoints - [DataPoint!]!
|
Example
{
"name": "xyz789",
"unit": "xyz789",
"datapoints": [DataPoint]
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
Invitation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
email - String!
|
|
role - OrganizationMemberRole!
|
|
validUntil - Time!
|
|
token - String!
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
|
organization - Organization!
|
Example
{
"id": "4",
"email": "abc123",
"role": OrganizationMemberRole,
"validUntil": "10:15:30Z",
"token": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"organization": Organization
}
InvitationSpec
Invoice
InvoiceItem
JoinTeamRequest
LinkServiceRequest
LinkStatuspageRequest
ListAlertsRequest
ListAlertsResponse
ListEventOptions
ListIncidentSchemasResponse
Fields
| Field Name | Description |
|---|---|
schemas - [IncidentSchema!]!
|
Example
{"schemas": [IncidentSchema]}
ListIncidentsRequest
ListIncidentsResponse
Fields
| Field Name | Description |
|---|---|
totalSize - Int!
|
|
incidents - [Incident!]!
|
Example
{"totalSize": 987, "incidents": [Incident]}
ListMonitorsRequest
ListMonitorsResponse
Fields
| Field Name | Description |
|---|---|
totalSize - Int!
|
|
monitors - [Monitor!]!
|
Example
{"totalSize": 987, "monitors": [Monitor]}
ListStatuspageSubscriptionsResponse
Fields
| Field Name | Description |
|---|---|
totalSize - Int!
|
|
subscriptions - [StatuspageSubscription!]!
|
Example
{
"totalSize": 123,
"subscriptions": [StatuspageSubscription]
}
ListStatuspagesResponse
Fields
| Field Name | Description |
|---|---|
totalSize - Int!
|
|
statuspages - [Statuspage!]!
|
Example
{"totalSize": 123, "statuspages": [Statuspage]}
ListSubscriptionsOptions
MLAlertCorrelatorSpec
Fields
| Input Field | Description |
|---|---|
model - String!
|
Example
{"model": "xyz789"}
Map
Example
Map
Monitor
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
service - Service!
|
|
scheduling - SchedulingConfiguration!
|
|
probeType - ProbeTypes!
|
|
probeConfiguration - ProbeConfiguration!
|
|
probeResults - [ProbeResult!]!
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
|
deletedAt - Time!
|
|
Example
{
"id": "abc123",
"service": Service,
"scheduling": SchedulingConfiguration,
"probeType": "ICMP",
"probeConfiguration": ICMPProbeConfiguration,
"probeResults": [ProbeResult],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"deletedAt": "10:15:30Z"
}
MonitorSpecInput
Fields
| Input Field | Description |
|---|---|
publicServiceId - Int!
|
|
scheduling - SchedulingConfigurationInput!
|
|
probeType - ProbeTypes!
|
|
icmpProbeConfiguration - ICMPProbeConfigurationInput
|
|
httpProbeConfiguration - HTTPProbeConfigurationInput
|
Example
{
"publicServiceId": 123,
"scheduling": SchedulingConfigurationInput,
"probeType": "ICMP",
"icmpProbeConfiguration": ICMPProbeConfigurationInput,
"httpProbeConfiguration": HTTPProbeConfigurationInput
}
NewIncidentRequest
Example
{
"schemaVersionId": "abc123",
"priorityId": "abc123",
"title": "abc123",
"summary": "xyz789",
"affectedServiceIds": [123],
"statuspageIds": [987]
}
NewServiceSpec
NewTeamRequest
Fields
| Input Field | Description |
|---|---|
name - String!
|
Example
{"name": "xyz789"}
OrgMemberActor
Fields
| Field Name | Description |
|---|---|
user - UserMeta!
|
Example
{"user": UserMeta}
Organization
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
name - String!
|
|
members - [OrganizationMember!]!
|
|
subscription - PlanSubscription
|
Example
{
"id": "xyz789",
"name": "abc123",
"members": [OrganizationMember],
"subscription": PlanSubscription
}
OrganizationMember
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
identityId - String!
|
|
role - OrganizationMemberRole!
|
|
joinedAt - Time!
|
|
meta - User!
|
Example
{
"id": "xyz789",
"identityId": "xyz789",
"role": OrganizationMemberRole,
"joinedAt": "10:15:30Z",
"meta": User
}
OrganizationMemberRole
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
name - String!
|
|
permissionRoles - [String!]!
|
Example
{
"id": "abc123",
"name": "abc123",
"permissionRoles": ["xyz789"]
}
PercentageDiscountValue
Fields
| Field Name | Description |
|---|---|
percentage - Float!
|
Example
{"percentage": 987.65}
Plan
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
order - Int!
|
|
prices - [Price!]!
|
|
features - [Feature!]!
|
Example
{
"id": 4,
"name": "abc123",
"order": 123,
"prices": [Price],
"features": [Feature]
}
PlanSubscription
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
plan - Plan!
|
|
status - SubscriptionStatus!
|
|
canStartTrial - Boolean!
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
|
details - SubscriptionDetails
|
Example
{
"id": "4",
"plan": Plan,
"status": "ACTIVE",
"canStartTrial": false,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"details": SubscriptionDetails
}
PreviewInvoice
Fields
| Field Name | Description |
|---|---|
customer - BillingDetails!
|
|
currency - String!
|
|
subtotal - Int!
|
|
subtotalExcludingTax - Int!
|
|
tax - Int!
|
|
items - [InvoiceItem!]!
|
|
appliedDiscounts - [AppliedDiscount!]!
|
|
creationDate - Time!
|
Example
{
"customer": BillingDetails,
"currency": "xyz789",
"subtotal": 987,
"subtotalExcludingTax": 123,
"tax": 987,
"items": [InvoiceItem],
"appliedDiscounts": [AppliedDiscount],
"creationDate": "10:15:30Z"
}
Price
ProbeConfiguration
Types
| Union Types |
|---|
Example
ICMPProbeConfiguration
ProbeResult
Fields
| Field Name | Description |
|---|---|
metadata - ProbeResultMetadata!
|
|
result - ProbeResultUnion
|
Example
{
"metadata": ProbeResultMetadata,
"result": ICMPProbeResult
}
ProbeResultMetadata
ProbeResultUnion
Types
| Union Types |
|---|
Example
ICMPProbeResult
ProbeTypes
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ICMP"
ProviderAddressMetadata
Fields
| Field Name | Description |
|---|---|
address - String!
|
Example
{"address": "xyz789"}
ProviderChannelMetadata
ProviderType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"MAIL"
Quota
RecipientEndpoint
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
providerType - ProviderType!
|
|
providerProfileId - ID!
|
|
config - RecipientEndpointConfig
|
|
doiConfirmed - Boolean!
|
|
doiConfirmedAt - Time
|
Example
{
"id": 4,
"providerType": "MAIL",
"providerProfileId": 4,
"config": ProviderChannelMetadata,
"doiConfirmed": false,
"doiConfirmedAt": "10:15:30Z"
}
RecipientEndpointConfig
Types
| Union Types |
|---|
Example
ProviderChannelMetadata
SchedulingConfiguration
SchedulingConfigurationInput
Service
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
name - String!
|
|
description - String!
|
|
incidents - [Incident!]
|
|
Arguments
|
|
owner - Team!
|
|
state - ServiceState!
|
|
isDeleted - Boolean!
|
|
deletedAt - Time
|
|
Example
{
"id": 123,
"name": "abc123",
"description": "abc123",
"incidents": [Incident],
"owner": Team,
"state": "OPERATIONAL",
"isDeleted": true,
"deletedAt": "10:15:30Z"
}
ServiceAccountActor
Fields
| Field Name | Description |
|---|---|
name - String!
|
Example
{"name": "abc123"}
ServiceState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OPERATIONAL"
StatisticalAlertCorrelator
StatisticalAlertCorrelatorSpec
Statuspage
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
name - String!
|
|
slug - String!
|
|
visibility - StatuspageVisibility!
|
|
customDomain - String!
|
|
domain - String!
|
|
components - [StatuspageComponent!]!
|
|
incidents - [StatuspageIncident!]!
|
|
whitelabelConfig - StatuspageWhitelabelConfigV1
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
Example
{
"id": 123,
"name": "abc123",
"slug": "xyz789",
"visibility": "PUBLIC",
"customDomain": "abc123",
"domain": "xyz789",
"components": [StatuspageComponent],
"incidents": [StatuspageIncident],
"whitelabelConfig": StatuspageWhitelabelConfigV1,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
StatuspageComponent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
position - Int!
|
|
type - StatuspageComponentType!
|
|
description - String!
|
|
component - StatuspageComponentPayload!
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
Example
{
"id": 4,
"position": 123,
"type": "SERVICE",
"description": "abc123",
"component": StatuspageComponentPayloadService,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
StatuspageComponentPayload
Types
| Union Types |
|---|
Example
StatuspageComponentPayloadService
StatuspageComponentPayloadService
Fields
| Field Name | Description |
|---|---|
service - StatuspageServiceComponent
|
Example
{"service": StatuspageServiceComponent}
StatuspageComponentSpec
Fields
| Input Field | Description |
|---|---|
description - String!
|
|
type - StatuspageComponentType!
|
|
serviceSpec - StatuspageServiceComponentSpec
|
Example
{
"description": "abc123",
"type": "SERVICE",
"serviceSpec": StatuspageServiceComponentSpec
}
StatuspageComponentType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"SERVICE"
StatuspageComponentUpdateSpec
Fields
| Input Field | Description |
|---|---|
description - String
|
Example
{"description": "abc123"}
StatuspageIncident
Fields
| Field Name | Description |
|---|---|
publicId - Int!
|
|
type - StatuspageIncidentType!
|
|
title - String!
|
|
summary - String!
|
|
priority - StatuspageIncidentPriority!
|
|
state - StatuspageIncidentState!
|
|
severity - StatuspageIncidentSeverity!
|
|
events - StatuspageIncidentEventList
|
|
affectedComponents - [StatuspageIncidentAffectedComponent!]!
|
|
timings - IncidentTimings!
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
|
statuspage - Statuspage
|
|
Example
{
"publicId": 123,
"type": "INCIDENT",
"title": "abc123",
"summary": "xyz789",
"priority": StatuspageIncidentPriority,
"state": StatuspageIncidentState,
"severity": "MINOR",
"events": StatuspageIncidentEventList,
"affectedComponents": [
StatuspageIncidentAffectedComponent
],
"timings": IncidentTimings,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"statuspage": Statuspage
}
StatuspageIncidentAffectedComponent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
type - StatuspageComponentType!
|
|
description - String!
|
|
component - StatuspageComponentPayload!
|
|
impact - String!
|
Example
{
"id": "4",
"type": "SERVICE",
"description": "xyz789",
"component": StatuspageComponentPayloadService,
"impact": "xyz789"
}
StatuspageIncidentEvent
StatuspageIncidentEventList
Fields
| Field Name | Description |
|---|---|
totalSize - Int!
|
|
nextPageToken - String!
|
|
events - [StatuspageIncidentEvent!]!
|
Example
{
"totalSize": 123,
"nextPageToken": "abc123",
"events": [StatuspageIncidentEvent]
}
StatuspageIncidentPriority
StatuspageIncidentSeverity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MINOR"
StatuspageIncidentState
StatuspageIncidentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INCIDENT"
StatuspageServiceComponent
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
name - String!
|
|
description - String!
|
|
state - StatuspageServiceState!
|
Example
{
"id": 123,
"name": "xyz789",
"description": "xyz789",
"state": "UNKNOWN"
}
StatuspageServiceComponentSpec
Fields
| Input Field | Description |
|---|---|
publicServiceId - Int!
|
Example
{"publicServiceId": 987}
StatuspageServiceState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
StatuspageSubscription
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
manageToken - String!
|
|
endpoints - [RecipientEndpoint!]!
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
Example
{
"id": 4,
"manageToken": "abc123",
"endpoints": [RecipientEndpoint],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
StatuspageVisibility
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PUBLIC"
StatuspageWhitelabelColorsV1
Fields
| Field Name | Description |
|---|---|
siteBackground - String
|
|
sitePrimary - String
|
|
siteCard - String
|
|
siteOperational - String
|
|
siteTextOperational - String
|
|
siteDegraded - String
|
|
siteTextDegraded - String
|
|
siteDown - String
|
|
siteTextDown - String
|
|
siteText - String
|
|
siteTextOnPrimary - String
|
|
siteTextSubtle - String
|
Example
{
"siteBackground": "xyz789",
"sitePrimary": "abc123",
"siteCard": "xyz789",
"siteOperational": "xyz789",
"siteTextOperational": "abc123",
"siteDegraded": "xyz789",
"siteTextDegraded": "xyz789",
"siteDown": "xyz789",
"siteTextDown": "xyz789",
"siteText": "xyz789",
"siteTextOnPrimary": "abc123",
"siteTextSubtle": "xyz789"
}
StatuspageWhitelabelColorsV1Input
Fields
| Input Field | Description |
|---|---|
siteBackground - String
|
|
sitePrimary - String
|
|
siteCard - String
|
|
siteOperational - String
|
|
siteTextOperational - String
|
|
siteDegraded - String
|
|
siteTextDegraded - String
|
|
siteDown - String
|
|
siteTextDown - String
|
|
siteText - String
|
|
siteTextOnPrimary - String
|
|
siteTextSubtle - String
|
Example
{
"siteBackground": "xyz789",
"sitePrimary": "abc123",
"siteCard": "xyz789",
"siteOperational": "xyz789",
"siteTextOperational": "xyz789",
"siteDegraded": "abc123",
"siteTextDegraded": "xyz789",
"siteDown": "xyz789",
"siteTextDown": "xyz789",
"siteText": "abc123",
"siteTextOnPrimary": "xyz789",
"siteTextSubtle": "xyz789"
}
StatuspageWhitelabelConfigV1
Fields
| Field Name | Description |
|---|---|
colors - StatuspageWhitelabelColorsV1!
|
|
logoUrl - String
|
|
showPoweredBy - Boolean!
|
Example
{
"colors": StatuspageWhitelabelColorsV1,
"logoUrl": "xyz789",
"showPoweredBy": true
}
StatuspageWhitelabelConfigV1Input
Fields
| Input Field | Description |
|---|---|
colors - StatuspageWhitelabelColorsV1Input!
|
|
logoUrl - String
|
|
showPoweredBy - Boolean!
|
Example
{
"colors": StatuspageWhitelabelColorsV1Input,
"logoUrl": "abc123",
"showPoweredBy": false
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
SubscriptionDetails
Fields
| Field Name | Description |
|---|---|
currentPlan - SubscriptionPlanDetails!
|
|
changeAt - Time
|
|
nextPlan - SubscriptionPlanDetails
|
|
currentPeriodStart - Time
|
|
currentPeriodEnd - Time
|
|
cancelAt - Time
|
|
upcomingInvoice - PreviewInvoice
|
Example
{
"currentPlan": SubscriptionPlanDetails,
"changeAt": "10:15:30Z",
"nextPlan": SubscriptionPlanDetails,
"currentPeriodStart": "10:15:30Z",
"currentPeriodEnd": "10:15:30Z",
"cancelAt": "10:15:30Z",
"upcomingInvoice": PreviewInvoice
}
SubscriptionPlanDetails
SubscriptionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
Team
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
name - String!
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
|
members - [TeamMember!]
|
|
services - [Service!]
|
Example
{
"id": 987,
"name": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"members": [TeamMember],
"services": [Service]
}
TeamMember
Time
Example
"10:15:30Z"
UnLinkServiceRequest
UnlinkStatuspageRequest
UpdateIncidentPriorityRequest
UpdateIncidentStateRequest
UpdateIncidentSummaryRequest
UpdateIncidentTimingsRequest
Fields
| Input Field | Description |
|---|---|
incidentId - Int!
|
|
impactStarted - UpdateTiming
|
|
impactDetected - UpdateTiming
|
|
impactResolved - UpdateTiming
|
Example
{
"incidentId": 987,
"impactStarted": UpdateTiming,
"impactDetected": UpdateTiming,
"impactResolved": UpdateTiming
}
UpdateIncidentTitleRequest
UpdateOrganizationMemberRoleRequest
UpdateServiceImpactRequest
UpdateServiceSpec
UpdateStatuspageSpec
Fields
| Input Field | Description |
|---|---|
name - String
|
|
customDomain - String
|
|
visibility - StatuspageVisibility
|
|
whitelabelConfig - StatuspageWhitelabelConfigV1Input
|
Example
{
"name": "xyz789",
"customDomain": "xyz789",
"visibility": "PUBLIC",
"whitelabelConfig": StatuspageWhitelabelConfigV1Input
}
UpdateTeamMemberRoleRequest
UpdateTeamRequest
UpdateTiming
Usage
User
Example
{
"id": "xyz789",
"firstname": "xyz789",
"lastname": "abc123",
"avatar": "abc123",
"email": "abc123",
"verified": false,
"memberships": [UserOrganizationMembership]
}
UserMeta
UserOrganizationMembership
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
organizationId - String!
|
|
organization - Organization!
|
|
role - OrganizationMemberRole!
|
Example
{
"id": "xyz789",
"organizationId": "xyz789",
"organization": Organization,
"role": OrganizationMemberRole
}