Home

Instatus (version v1.*.*)

Instatus Connector

create_component#

create an instatus page component

Parameters

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "grouped" : "boolean",
  "name" : "string",
  "description" : "string",
  "showUptime" : "boolean",
  "status" : "string. Possible values: OPERATIONAL | UNDERMAINTENANCE | DEGRADEDPERFORMANCE | PARTIALOUTAGE | MINOROUTAGE | MAJOROUTAGE",
  "order" : "integer"
}

create_datapoint#

add datapoint to a metric

Parameters

metric_id (required)#

metric id

Type: string

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "value" : "string",
  "timestamp" : "string"
}

create_datapoints#

Add multiple datapoints to a metric

Parameters

metric_id (required)#

metric id

Type: string

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "data" : [ {
    "value" : "string",
    "timestamp" : "string"
  } ]
}

create_incident#

Add an incident

Parameters

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "components" : { },
  "name" : "string",
  "statuses" : [ {
    "id" : "string",
    "status" : "string. Possible values: OPERATIONAL | UNDERMAINTENANCE | DEGRADEDPERFORMANCE | PARTIALOUTAGE | MINOROUTAGE | MAJOROUTAGE"
  } ],
  "started" : "string",
  "message" : "string",
  "notify" : "boolean",
  "status" : "string. Possible values: INVESTIGATING | IDENTIFIED | MONITORING | RESOLVED"
}

create_incident_update#

Add an Inident Update

Parameters

incident_id (required)#

incident_id

Type: string

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "components" : "string",
  "statuses" : [ {
    "id" : "string",
    "status" : "string. Possible values: OPERATIONAL | UNDERMAINTENANCE | DEGRADEDPERFORMANCE | PARTIALOUTAGE | MINOROUTAGE | MAJOROUTAGE"
  } ],
  "started" : "string",
  "message" : "string",
  "notify" : "boolean",
  "status" : "string. Possible values: INVESTIGATING | IDENTIFIED | MONITORING | RESOLVED"
}

create_maintenance#

add an maintenance

Parameters

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "components" : [ "string" ],
  "name" : "string",
  "start" : "string",
  "statuses" : [ {
    "id" : "string",
    "status" : "string. Possible values: OPERATIONAL | UNDERMAINTENANCE | DEGRADEDPERFORMANCE | PARTIALOUTAGE | MINOROUTAGE | MAJOROUTAGE"
  } ],
  "end" : "string",
  "message" : "string",
  "notify" : "boolean",
  "status" : "string. Possible values: NOTSTARTEDYET | INPROGRESS | COMPLETED"
}

create_maintenance_update#

add an maintenance update

Parameters

maintenance_id (required)#

maintenance id

Type: string

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "components" : [ "string" ],
  "statuses" : [ {
    "id" : "string",
    "status" : "string. Possible values: OPERATIONAL | UNDERMAINTENANCE | DEGRADEDPERFORMANCE | PARTIALOUTAGE | MINOROUTAGE | MAJOROUTAGE"
  } ],
  "started" : "string",
  "end" : "string",
  "message" : "string",
  "notify" : "boolean",
  "status" : "string. Possible values: NOTSTARTEDYET | INPROGRESS | COMPLETED"
}

create_metric#

add a metric

Parameters

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "name" : "string",
  "subdomain" : "string",
  "suffix" : "string"
}

create_page#

Create a status page

Parameters

$body#

Type: object

{
  "twilioSid" : "string",
  "twilioSender" : "string",
  "components" : [ "string" ],
  "brandColor" : "string",
  "dateFormat" : "string",
  "htmlInMeta" : "string",
  "language" : "string",
  "subscribeBySms" : "boolean",
  "launchDate" : "string",
  "twilioToken" : "string",
  "faviconUrl" : "string",
  "nexmoKey" : "string",
  "websiteUrl" : "string",
  "smsService" : "string",
  "htmlBelowFooter" : "string",
  "esendexPassword" : "string",
  "downColor" : "string",
  "htmlBelowHeader" : "string",
  "email" : "string",
  "cssGlobal" : "string",
  "disruptedColor" : "string",
  "useLargeHeader" : "boolean",
  "dateFormatShort" : "string",
  "okColor" : "string",
  "unknownColor" : "string",
  "noticeColor" : "string",
  "degradedColor" : "string",
  "htmlAboveHeader" : "string",
  "logoUrl" : "string",
  "htmlAboveFooter" : "string",
  "nexmoSender" : "string",
  "googleAnalytics" : "string",
  "nexmoSecret" : "string",
  "esendexUsername" : "string",
  "esendexAccountRef" : "string",
  "timeFormat" : "string",
  "name" : "string",
  "subdomain" : "string",
  "htmlBelowSummary" : "string"
}

create_subscriber#

add a subscriber

Parameters

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "all" : "boolean",
  "autoConfirm" : "boolean",
  "email" : "string"
}

create_team_member#

add a team member

Parameters

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "email" : "string"
}

delete_component#

delete an instatus page component

Parameters

component_id (required)#

component_id

Type: string

page_id (required)#

page id

Type: string

delete_datapoints#

delete datapoints to a metric

Parameters

metric_id (required)#

metric id

Type: string

page_id (required)#

page id

Type: string

delete_incident#

Delete an incident

Parameters

incident_id (required)#

incident_id

Type: string

page_id (required)#

page id

Type: string

delete_incident_update#

Delete an incident update

Parameters

incident_id (required)#

incident_id

Type: string

incident_update_id (required)#

incident_udpate_id

Type: string

page_id (required)#

page id

Type: string

delete_maintenance#

delete maintenance

Parameters

maintenance_id (required)#

maintenance id

Type: string

page_id (required)#

page id

Type: string

delete_maintenance_update#

delete maintenance update

Parameters

maintenance_id (required)#

maintenance id

Type: string

maintenance_update_id (required)#

maintenance update id

Type: string

page_id (required)#

page id

Type: string

delete_metric#

delete a metric

Parameters

metric_id (required)#

metric id

Type: string

page_id (required)#

page id

Type: string

delete_page#

Delete a status page

Parameters

page_id (required)#

page id

Type: string

delete_subscriber#

delete a subscriber

Parameters

page_id (required)#

page id

Type: string

subscriber_id (required)#

subscriber id

Type: string

delete_team_member#

delete a team member

Parameters

member_id (required)#

member id

Type: string

page_id (required)#

page id

Type: string

get_component#

instatus page component

Parameters

component_id (required)#

component_id

Type: string

page_id (required)#

page id

Type: string

get_incident#

Get an incident

Parameters

incident_id (required)#

incident_id

Type: string

page_id (required)#

page id

Type: string

get_incident_update#

Get an incident update

Parameters

incident_id (required)#

incident_id

Type: string

incident_update_id (required)#

incident_udpate_id

Type: string

page_id (required)#

page id

Type: string

get_maintenance_update#

Get a maintenance update

Parameters

maintenance_id (required)#

maintenance id

Type: string

maintenance_update_id (required)#

maintenance update id

Type: string

page_id (required)#

page id

Type: string

get_metric#

Get a metrics

Parameters

metric_id (required)#

metric id

Type: string

page_id (required)#

page id

Type: string

get_page_maintenance#

Get a page maintenance

Parameters

maintenance_id (required)#

maintenance id

Type: string

page_id (required)#

page id

Type: string

get_user#

Get your user profile

This operation has no parameters

list_components#

Get all your status page components

Parameters

page_id (required)#

page id

Type: string

list_incidents#

Get all page incidents

Parameters

page_id (required)#

page id

Type: string

list_metrics#

Get all metrics

Parameters

page_id (required)#

page id

Type: string

list_page_maintenances#

List all page maintenances

Parameters

page_id (required)#

page id

Type: string

list_pages#

Get your status pages

This operation has no parameters

list_subscribers#

Get subscribers

Parameters

page_id (required)#

page id

Type: string

list_team_members#

Get team members

Parameters

page_id (required)#

page id

Type: string

update_component#

update instatus page component

Parameters

component_id (required)#

component_id

Type: string

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "grouped" : "boolean",
  "name" : "string",
  "description" : "string",
  "showUptime" : "boolean",
  "status" : "string. Possible values: OPERATIONAL | UNDERMAINTENANCE | DEGRADEDPERFORMANCE | PARTIALOUTAGE | MINOROUTAGE | MAJOROUTAGE",
  "order" : "integer"
}

update_incident#

Update an incident

Parameters

incident_id (required)#

incident_id

Type: string

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "components" : { },
  "name" : "string",
  "statuses" : [ {
    "id" : "string",
    "status" : "string. Possible values: OPERATIONAL | UNDERMAINTENANCE | DEGRADEDPERFORMANCE | PARTIALOUTAGE | MINOROUTAGE | MAJOROUTAGE"
  } ],
  "started" : "string",
  "message" : "string",
  "notify" : "boolean",
  "status" : "string. Possible values: INVESTIGATING | IDENTIFIED | MONITORING | RESOLVED"
}

update_incident_update#

Update an incident update

Parameters

incident_id (required)#

incident_id

Type: string

incident_update_id (required)#

incident_udpate_id

Type: string

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "components" : "string",
  "statuses" : [ {
    "id" : "string",
    "status" : "string. Possible values: OPERATIONAL | UNDERMAINTENANCE | DEGRADEDPERFORMANCE | PARTIALOUTAGE | MINOROUTAGE | MAJOROUTAGE"
  } ],
  "started" : "string",
  "message" : "string",
  "notify" : "boolean",
  "status" : "string. Possible values: INVESTIGATING | IDENTIFIED | MONITORING | RESOLVED"
}

update_maintenance#

update maintenance

Parameters

maintenance_id (required)#

maintenance id

Type: string

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "components" : [ "string" ],
  "name" : "string",
  "start" : "string",
  "statuses" : [ {
    "id" : "string",
    "status" : "string. Possible values: OPERATIONAL | UNDERMAINTENANCE | DEGRADEDPERFORMANCE | PARTIALOUTAGE | MINOROUTAGE | MAJOROUTAGE"
  } ],
  "end" : "string",
  "message" : "string",
  "notify" : "boolean",
  "status" : "string. Possible values: NOTSTARTEDYET | INPROGRESS | COMPLETED"
}

update_maintenance_update#

update maintenance update

Parameters

maintenance_id (required)#

maintenance id

Type: string

maintenance_update_id (required)#

maintenance update id

Type: string

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "components" : [ "string" ],
  "statuses" : [ {
    "id" : "string",
    "status" : "string. Possible values: OPERATIONAL | UNDERMAINTENANCE | DEGRADEDPERFORMANCE | PARTIALOUTAGE | MINOROUTAGE | MAJOROUTAGE"
  } ],
  "started" : "string",
  "end" : "string",
  "message" : "string",
  "notify" : "boolean",
  "status" : "string. Possible values: NOTSTARTEDYET | INPROGRESS | COMPLETED"
}

update_metric#

update a metric

Parameters

metric_id (required)#

metric id

Type: string

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "name" : "string",
  "subdomain" : "string",
  "suffix" : "string"
}

update_page#

Update a status page

Parameters

page_id (required)#

page id

Type: string

$body#

Type: object

{
  "twilioSid" : "string",
  "twilioSender" : "string",
  "components" : [ "string" ],
  "brandColor" : "string",
  "dateFormat" : "string",
  "htmlInMeta" : "string",
  "language" : "string",
  "subscribeBySms" : "boolean",
  "launchDate" : "string",
  "twilioToken" : "string",
  "faviconUrl" : "string",
  "nexmoKey" : "string",
  "websiteUrl" : "string",
  "smsService" : "string",
  "htmlBelowFooter" : "string",
  "esendexPassword" : "string",
  "downColor" : "string",
  "htmlBelowHeader" : "string",
  "email" : "string",
  "cssGlobal" : "string",
  "disruptedColor" : "string",
  "useLargeHeader" : "boolean",
  "dateFormatShort" : "string",
  "okColor" : "string",
  "unknownColor" : "string",
  "noticeColor" : "string",
  "degradedColor" : "string",
  "htmlAboveHeader" : "string",
  "logoUrl" : "string",
  "htmlAboveFooter" : "string",
  "nexmoSender" : "string",
  "googleAnalytics" : "string",
  "nexmoSecret" : "string",
  "esendexUsername" : "string",
  "esendexAccountRef" : "string",
  "timeFormat" : "string",
  "name" : "string",
  "subdomain" : "string",
  "htmlBelowSummary" : "string"
}