@managed-api/statuspage-v1-sr-connect

ScriptRunner Connect Managed API for Statuspage

Managed API for Statuspage is an API Client for Statuspage by Adaptavist. You can read more about Managed APIs here.

This is ScriptRunner Connect runtime specific version of the Managed API (with sr-connect suffix). If you want to use Managed API in any other runtime, have a look at the runtime agnostic version.

Supported API calls

• fetch
• Component
  • addPageAccessGroups
  • addPageAccessUsers
  • createComponent
  • deleteComponent
  • getComponent
  • getComponents
  • getUptimeData
  • removePageAccessGroups
  • removePageAccessUsers
  • updateComponent
• Incident
  • createIncident
  • deleteIncident
  • getActiveMaintenances
  • getIncident
  • getIncidents
  • getScheduledIncidents
  • getUnresolvedIncidents
  • getUpcomingIncidents
  • updateIncident
  • Update
    • updateIncidentUpdate
• Page
  • getPage
  • getPages
  • updatePage
• User
  • createUser
  • deleteUser
  • getPermissions
  • getUsers

Constructing Managed API

In ScriptRunner Connect a Managed API is constructed for you, but if you need to construct it manually, here's how you can do it:

import { StatuspageApi } from '@managed-api/statuspage-v1-sr-connect';

export default async function() {
    const api = new StatuspageApi('API_CONNECTION_ID');
}

Contact

Feel free to drop ideas, suggestions or improvements into our Slack community channel.

Changelog

2.0.0

• Breaking change: URL and query string parameters are now URL encoded, meaning if you encoded them explicitly before you have to remove your own encoding, otherwise they will get double encoded.

0.5.0

• Added support for the following Page methods:

• getPage

• getPages

• updatePage

• Added support for the following Incident methods:

• createIncident

• deleteIncident

• getActiveMaintenances

• getIncident

• getIncidents

• getScheduledIncidents

• getUnresolvedIncidents

• getUpcomingIncidents

• updateIncident

• Added support for the following Incident.Update method:

• updateIncidentUpdate

• Added support for the following Component methods:

• addPageAccessGroups

• addPageAccessUsers

• createComponent

• deleteComponent

• getComponent

• getComponents

• getUptimeData

• removePageAccessGroups

• removePageAccessUsers

• updateComponent

• Added support for the following User methods:

• createUser

• deleteUser

• getPermissions

• getUsers

Copyright Adaptavist 2024 (c) All rights reserved