Skip to content

rootlyhq/rootly-java

Repository files navigation

rootly

Rootly API v1

  • API version: v1
    • Build date: 2025-05-22T07:13:31.203496-07:00[America/Los_Angeles]
    • Generator version: 7.13.0

How to generate an API Key?

  • Organization dropdown > Organization Settings > API Keys

JSON:API Specification

Rootly is using JSON:API (https://jsonapi.org) specification:

  • JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests.
  • JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability.
  • JSON:API requires use of the JSON:API media type (application/vnd.api+json) for exchanging data.

Authentication and Requests

We use standard HTTP Authentication over HTTPS to authorize your requests.

  curl --request GET \\
--header 'Content-Type: application/vnd.api+json' \\
--header 'Authorization: Bearer YOUR-TOKEN' \\
--url https://api.rootly.com/v1/incidents

Rate limiting

  • There is a default limit of approximately 3000 GET calls per API key every 60 seconds. The limit is calculated over a 60-second sliding window looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your Rootly Customer Success Manager to make any adjustments.
  • There is a default limit of approximately 3000 PUT, POST, PATCH or DELETE calls per API key every 60 seconds. The limit is calculated over a 60-second sliding window looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your Rootly Customer Success Manager to make any adjustments.
  • The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event.
  • Additional headers will be returned giving you information about the limit:
    • RateLimit-Limit - The maximum number of requests that the consumer is permitted to make.
    • RateLimit-Remaining - The number of requests remaining in the current rate limit window.
    • RateLimit-Reset - The time at which the current rate limit window resets in UTC epoch seconds.

Pagination

  • Pagination is supported for all endpoints that return a collection of items.
  • Pagination is controlled by the page query parameter

Example

  curl --request GET \\
--header 'Content-Type: application/vnd.api+json' \\
--header 'Authorization: Bearer YOUR-TOKEN' \\
--url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>org.openapitools</groupId>
  <artifactId>rootly</artifactId>
  <version>v1</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'rootly' jar has been published to maven central.
    mavenLocal()       // Needed if the 'rootly' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "org.openapitools:rootly:v1"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/rootly-v1.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.rootly.client.ApiClient;
import com.rootly.client.ApiException;
import com.rootly.client.Configuration;
import com.rootly.client.auth.*;
import com.rootly.client.model.*;
import com.rootly.client.api.AlertEventsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.rootly.com");
    
    // Configure HTTP bearer authorization: bearer_auth
    HttpBearerAuth bearer_auth = (HttpBearerAuth) defaultClient.getAuthentication("bearer_auth");
    bearer_auth.setBearerToken("BEARER TOKEN");

    AlertEventsApi apiInstance = new AlertEventsApi(defaultClient);
    String alertId = "alertId_example"; // String | 
    NewAlertEvent newAlertEvent = new NewAlertEvent(); // NewAlertEvent | 
    try {
      AlertEventResponse result = apiInstance.createAlertEvent(alertId, newAlertEvent);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AlertEventsApi#createAlertEvent");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://api.rootly.com

Class Method HTTP request Description
AlertEventsApi createAlertEvent POST /v1/alerts/{alert_id}/events Create alert event
AlertEventsApi deleteAlertEvent DELETE /v1/alert_events/{id} Delete alert event
AlertEventsApi getAlertEvent GET /v1/alert_events/{id} Retrieve alert event
AlertEventsApi listAlertEvents GET /v1/alerts/{alert_id}/events List alert events
AlertEventsApi updateAlertEvent PATCH /v1/alert_events/{id} Update alert event
AlertGroupsApi createAlertGroup POST /v1/alert_groups Creates an alert group
AlertGroupsApi deleteAlertGroup DELETE /v1/alert_groups/{id} Delete an alert group
AlertGroupsApi getAlertGroup GET /v1/alert_groups/{id} Retrieves an alert group
AlertGroupsApi listAlertGroups GET /v1/alert_groups List alert groups
AlertGroupsApi updateAlertGroup PATCH /v1/alert_groups/{id} Update an alert group
AlertRoutingRulesApi createAlertRoutingRule POST /v1/alert_routing_rules Creates an alert routing rule
AlertRoutingRulesApi deleteAlertRoutingRule DELETE /v1/alert_routing_rules/{id} Delete an alert routing rule
AlertRoutingRulesApi getAlertRoutingRule GET /v1/alert_routing_rules/{id} Retrieves an alert routing rule
AlertRoutingRulesApi listAlertRoutingRules GET /v1/alert_routing_rules List alert routing rules
AlertRoutingRulesApi updateAlertRoutingRule PUT /v1/alert_routing_rules/{id} Update an alert routing rule
AlertSourcesApi createAlertSource POST /v1/alert_sources Creates an alert source
AlertSourcesApi deleteAlertSource DELETE /v1/alert_sources/{id} Delete an alert source
AlertSourcesApi getAlertSource GET /v1/alert_sources/{id} Retrieves an alert source
AlertSourcesApi listAlertSources GET /v1/alert_sources List alert sources
AlertSourcesApi updateAlertSource PUT /v1/alert_sources/{id} Update an alert source
AlertUrgenciesApi createAlertUrgency POST /v1/alert_urgencies Creates an alert urgency
AlertUrgenciesApi deleteAlertUrgency DELETE /v1/alert_urgencies/{id} Delete an alert urgency
AlertUrgenciesApi getAlertUrgency GET /v1/alert_urgencies/{id} Retrieves an alert urgency
AlertUrgenciesApi listAlertUrgencies GET /v1/alert_urgencies List alert urgencies
AlertUrgenciesApi updateAlertUrgency PUT /v1/alert_urgencies/{id} Update an alert urgency
AlertsApi acknowledgeAlert POST /v1/alerts/{id}/acknowledge Acknowledges an alert
AlertsApi attachAlert POST /v1/incidents/{incident_id}/alerts Attach alerts to an incident
AlertsApi createAlert POST /v1/alerts Creates an alert
AlertsApi getAlert GET /v1/alerts/{id} Retrieves an alert
AlertsApi listAlerts GET /v1/alerts List alerts
AlertsApi listIncidentAlerts GET /v1/incidents/{incident_id}/alerts List Incident alerts
AlertsApi resolveAlert POST /v1/alerts/{id}/resolve Resolves an alert
AlertsApi updateAlert PATCH /v1/alerts/{id} Update alert
AuditsApi listAudits GET /v1/audits List audits
AuthorizationsApi createAuthorization POST /v1/authorizations Creates an authorization
AuthorizationsApi deleteAuthorization DELETE /v1/authorizations/{id} Delete an authorization
AuthorizationsApi getAuthorization GET /v1/authorizations/{id} Retrieves an authorization
AuthorizationsApi listAuthorizations GET /v1/authorizations List authorizations
AuthorizationsApi updateAuthorization PUT /v1/authorizations/{id} Update an authorization
CatalogEntitiesApi createCatalogEntity POST /v1/catalogs/{catalog_id}/entities Creates a Catalog Entity
CatalogEntitiesApi deleteCatalogEntity DELETE /v1/catalog_entities/{id} Delete a Catalog Entity
CatalogEntitiesApi getCatalogEntity GET /v1/catalog_entities/{id} Retrieves a Catalog Entity
CatalogEntitiesApi listCatalogEntities GET /v1/catalogs/{catalog_id}/entities List Catalog Entities
CatalogEntitiesApi updateCatalogEntity PUT /v1/catalog_entities/{id} Update a Catalog Entity
CatalogEntityPropertiesApi createCatalogEntityProperty POST /v1/catalog_entities/{catalog_entity_id}/properties Creates a Catalog Entity Property
CatalogEntityPropertiesApi deleteCatalogEntityProperty DELETE /v1/catalog_entity_properties/{id} Delete a Catalog Entity Property
CatalogEntityPropertiesApi getCatalogEntityProperty GET /v1/catalog_entity_properties/{id} Retrieves a Catalog Entity Property
CatalogEntityPropertiesApi listCatalogEntityProperties GET /v1/catalog_entities/{catalog_entity_id}/properties List catalog properties
CatalogEntityPropertiesApi updateCatalogEntityProperty PUT /v1/catalog_entity_properties/{id} Update a Catalog Entity Property
CatalogFieldsApi createCatalogField POST /v1/catalogs/{catalog_id}/fields Creates a Catalog Field
CatalogFieldsApi deleteCatalogField DELETE /v1/catalog_fields/{id} Delete a catalog_field
CatalogFieldsApi getCatalogField GET /v1/catalog_fields/{id} Retrieves a Catalog Field
CatalogFieldsApi listCatalogFields GET /v1/catalogs/{catalog_id}/fields List Catalog Fields
CatalogFieldsApi updateCatalogField PUT /v1/catalog_fields/{id} Update a catalog_field
CatalogsApi createCatalog POST /v1/catalogs Creates a catalog
CatalogsApi deleteCatalog DELETE /v1/catalogs/{id} Delete a catalog
CatalogsApi getCatalog GET /v1/catalogs/{id} Retrieves a catalog
CatalogsApi listCatalogs GET /v1/catalogs List catalogs
CatalogsApi updateCatalog PUT /v1/catalogs/{id} Update a catalog
CausesApi createCause POST /v1/causes Creates a cause
CausesApi deleteCause DELETE /v1/causes/{id} Delete a cause
CausesApi getCause GET /v1/causes/{id} Retrieves a cause
CausesApi listCauses GET /v1/causes List causes
CausesApi updateCause PUT /v1/causes/{id} Update a cause
CustomFormsApi createCustomForm POST /v1/custom_forms Creates a custom form
CustomFormsApi deleteCustomForm DELETE /v1/custom_forms/{id} Delete a custom form
CustomFormsApi getCustomForm GET /v1/custom_forms/{id} Retrieves a custom form
CustomFormsApi listCustomForms GET /v1/custom_forms List custom forms
CustomFormsApi updateCustomForm PUT /v1/custom_forms/{id} Update a custom form
DashboardPanelsApi createDashboardPanel POST /v1/dashboards/{dashboard_id}/panels Creates a dashboard panel
DashboardPanelsApi deleteDashboardPanel DELETE /v1/dashboard_panels/{id} Delete a dashboard panel
DashboardPanelsApi duplicateDashboardPanel POST /v1/dashboard_panels/{id}/duplicate Duplicates a dashboard panel
DashboardPanelsApi getDashboardPanel GET /v1/dashboard_panels/{id} Retrieves a dashboard panel
DashboardPanelsApi listDashboardPanels GET /v1/dashboards/{dashboard_id}/panels List dashboard panels
DashboardPanelsApi updateDashboardPanel PUT /v1/dashboard_panels/{id} Update a dashboard panel
DashboardsApi createDashboard POST /v1/dashboards Creates a dashboard
DashboardsApi deleteDashboard DELETE /v1/dashboards/{id} Delete a dashboard
DashboardsApi duplicateDashboard POST /v1/dashboards/{id}/duplicate Duplicates a dashboard
DashboardsApi getDashboard GET /v1/dashboards/{id} Retrieves a dashboard
DashboardsApi listDashboards GET /v1/dashboards List dashboards
DashboardsApi setDefaultDashboard POST /v1/dashboards/{id}/set_default Sets dashboard to user default
DashboardsApi updateDashboard PUT /v1/dashboards/{id} Update a dashboard
DeprecatedCustomFieldOptionsApi createCustomFieldOption POST /v1/custom_fields/{custom_field_id}/options [DEPRECATED] Creates a custom field option
DeprecatedCustomFieldOptionsApi deleteCustomFieldOption DELETE /v1/custom_field_options/{id} [DEPRECATED] Delete a custom field option
DeprecatedCustomFieldOptionsApi getCustomFieldOption GET /v1/custom_field_options/{id} [DEPRECATED] Retrieves a custom field option
DeprecatedCustomFieldOptionsApi listCustomFieldOptions GET /v1/custom_fields/{custom_field_id}/options [DEPRECATED] List custom field options
DeprecatedCustomFieldOptionsApi updateCustomFieldOption PUT /v1/custom_field_options/{id} [DEPRECATED] Update a custom field option
DeprecatedCustomFieldsApi createCustomField POST /v1/custom_fields [DEPRECATED] Creates a Custom Field
DeprecatedCustomFieldsApi deleteCustomField DELETE /v1/custom_fields/{id} [DEPRECATED] Delete a Custom Field
DeprecatedCustomFieldsApi getCustomField GET /v1/custom_fields/{id} [DEPRECATED] Retrieves a Custom Field
DeprecatedCustomFieldsApi listCustomFields GET /v1/custom_fields [DEPRECATED] List Custom Fields
DeprecatedCustomFieldsApi updateCustomField PUT /v1/custom_fields/{id} [DEPRECATED] Update a Custom Field
DeprecatedIncidentCustomFieldSelectionsApi createIncidentCustomFieldSelection POST /v1/incidents/{incident_id}/custom_field_selections [DEPRECATED] Creates an incident custom field selection
DeprecatedIncidentCustomFieldSelectionsApi deleteIncidentCustomFieldSelection DELETE /v1/incident_custom_field_selections/{id} [DEPRECATED] Delete an incident custom field selection
DeprecatedIncidentCustomFieldSelectionsApi getIncidentCustomFieldSelection GET /v1/incident_custom_field_selections/{id} [DEPRECATED] Retrieves an incident custom field selection
DeprecatedIncidentCustomFieldSelectionsApi listIncidentCustomFieldSelections GET /v1/incidents/{incident_id}/custom_field_selections [DEPRECATED] List incident custom field selections
DeprecatedIncidentCustomFieldSelectionsApi updateIncidentCustomFieldSelection PUT /v1/incident_custom_field_selections/{id} [DEPRECATED] Update an incident custom field selection
DeprecatedWorkflowCustomFieldSelectionsApi createWorkflowCustomFieldSelection POST /v1/workflows/{workflow_id}/custom_field_selections [DEPRECATED] Creates a workflow custom field selection
DeprecatedWorkflowCustomFieldSelectionsApi deleteWorkflowCustomFieldSelection DELETE /v1/workflow_custom_field_selections/{id} [DEPRECATED] Delete a workflow custom field selection
DeprecatedWorkflowCustomFieldSelectionsApi getWorkflowCustomFieldSelection GET /v1/workflow_custom_field_selections/{id} [DEPRECATED] Retrieves a workflow custom field selection
DeprecatedWorkflowCustomFieldSelectionsApi listWorkflowCustomFieldSelections GET /v1/workflows/{workflow_id}/custom_field_selections [DEPRECATED] List workflow custom field selections
DeprecatedWorkflowCustomFieldSelectionsApi updateWorkflowCustomFieldSelection PUT /v1/workflow_custom_field_selections/{id} [DEPRECATED] Update a workflow custom field selection
EnvironmentsApi createEnvironment POST /v1/environments Creates an environment
EnvironmentsApi deleteEnvironment DELETE /v1/environments/{id} Delete an environment
EnvironmentsApi getEnvironment GET /v1/environments/{id} Retrieves an environment
EnvironmentsApi listEnvironments GET /v1/environments List environments
EnvironmentsApi updateEnvironment PUT /v1/environments/{id} Update an environment
EscalationLevelsApi deleteEscalationLevel DELETE /v1/escalation_levels/{id} Delete an escalation level
EscalationLevelsApi getEscalationLevel GET /v1/escalation_levels/{id} Retrieves an escalation level
EscalationLevelsApi updateEscalationLevel PUT /v1/escalation_levels/{id} Update an escalation level
EscalationLevelsPathApi createEscalationLevelPaths POST /v1/escalation_paths/{escalation_policy_path_id}/escalation_levels Creates an escalation level for an Escalation Path
EscalationLevelsPathApi listEscalationLevelsPaths GET /v1/escalation_paths/{escalation_policy_path_id}/escalation_levels List escalation levels for an Escalation Path
EscalationLevelsPoliciesApi createEscalationLevel POST /v1/escalation_policies/{escalation_policy_id}/escalation_levels Creates an escalation level for an Escalation Policy
EscalationLevelsPoliciesApi listEscalationLevels GET /v1/escalation_policies/{escalation_policy_id}/escalation_levels List escalation levels for an Escalation Policy
EscalationPathsApi createEscalationPath POST /v1/escalation_policies/{escalation_policy_id}/escalation_paths Creates an escalation path
EscalationPathsApi deleteEscalationPath DELETE /v1/escalation_paths/{id} Delete an escalation path
EscalationPathsApi getEscalationPath GET /v1/escalation_paths/{id} Retrieves an escalation path
EscalationPathsApi listEscalationPaths GET /v1/escalation_policies/{escalation_policy_id}/escalation_paths List escalation paths
EscalationPathsApi updateEscalationPath PUT /v1/escalation_paths/{id} Update an escalation path
EscalationPoliciesApi createEscalationPolicy POST /v1/escalation_policies Creates an escalation policy
EscalationPoliciesApi deleteEscalationPolicy DELETE /v1/escalation_policies/{id} Delete an escalation policy
EscalationPoliciesApi getEscalationPolicy GET /v1/escalation_policies/{id} Retrieves an escalation policy
EscalationPoliciesApi listEscalationPolicies GET /v1/escalation_policies List escalation policies
EscalationPoliciesApi updateEscalationPolicy PUT /v1/escalation_policies/{id} Update an escalation policy
FormFieldOptionsApi createFormFieldOption POST /v1/form_fields/{form_field_id}/options Creates FormField Options
FormFieldOptionsApi deleteFormFieldOption DELETE /v1/form_field_options/{id} Delete FormField Options
FormFieldOptionsApi getFormFieldOption GET /v1/form_field_options/{id} Retrieves FormField Options
FormFieldOptionsApi listFormFieldOptions GET /v1/form_fields/{form_field_id}/options List FormField Options
FormFieldOptionsApi updateFormFieldOption PUT /v1/form_field_options/{id} Update FormField Options
FormFieldPlacementConditionsApi createFormFieldPlacementCondition POST /v1/form_field_placements/{form_field_placement_id}/conditions Creates a Form Set Condition
FormFieldPlacementConditionsApi deleteFormFieldPlacementCondition DELETE /v1/form_field_placement_conditions/{id} Delete a Form Set Condition
FormFieldPlacementConditionsApi getFormFieldPlacementCondition GET /v1/form_field_placement_conditions/{id} Retrieves a Form Set Condition
FormFieldPlacementConditionsApi listFormFieldPlacementConditions GET /v1/form_field_placements/{form_field_placement_id}/conditions List Form Set Conditions
FormFieldPlacementConditionsApi updateFormFieldPlacementCondition PUT /v1/form_field_placement_conditions/{id} Update a Form Set Condition
FormFieldPlacementsApi createFormFieldPlacement POST /v1/form_fields/{form_field_id}/placements Creates a Form Field Placement
FormFieldPlacementsApi deleteFormFieldPlacement DELETE /v1/form_field_placements/{id} Delete a Form Field Placement
FormFieldPlacementsApi getFormFieldPlacement GET /v1/form_field_placements/{id} Retrieves a Form Field Placement
FormFieldPlacementsApi listFormFieldPlacements GET /v1/form_fields/{form_field_id}/placements List Form Field Placements
FormFieldPlacementsApi updateFormFieldPlacement PUT /v1/form_field_placements/{id} Update a Form Field Placement
FormFieldPositionsApi createFormFieldPosition POST /v1/form_fields/{form_field_id}/positions Creates FormField Positions
FormFieldPositionsApi deleteFormFieldPosition DELETE /v1/form_field_positions/{id} Delete a FormFieldPosition
FormFieldPositionsApi getFormFieldPosition GET /v1/form_field_positions/{id} Retrieves a FormFieldPosition
FormFieldPositionsApi listFormFieldPositions GET /v1/form_fields/{form_field_id}/positions List FormField Position
FormFieldPositionsApi updateFormFieldPosition PUT /v1/form_field_positions/{id} Update a FormFieldPosition
FormFieldsApi createFormField POST /v1/form_fields Creates a Form Field
FormFieldsApi deleteFormField DELETE /v1/form_fields/{id} Delete a Form Field
FormFieldsApi getFormField GET /v1/form_fields/{id} Retrieves a Form Field
FormFieldsApi listFormFields GET /v1/form_fields List Form Fields
FormFieldsApi updateFormField PUT /v1/form_fields/{id} Update a Form Field
FormSetConditionsApi createFormSetCondition POST /v1/form_sets/{form_set_id}/conditions Creates a Form Set Condition
FormSetConditionsApi deleteFormSetCondition DELETE /v1/form_set_conditions/{id} Delete a Form Set Condition
FormSetConditionsApi getFormSetCondition GET /v1/form_set_conditions/{id} Retrieves a Form Set Condition
FormSetConditionsApi listFormSetConditions GET /v1/form_sets/{form_set_id}/conditions List Form Set Conditions
FormSetConditionsApi updateFormSetCondition PUT /v1/form_set_conditions/{id} Update a Form Set Condition
FormSetsApi createFormSet POST /v1/form_sets Creates a Form Set
FormSetsApi deleteFormSet DELETE /v1/form_sets/{id} Delete a Form Set
FormSetsApi getFormSet GET /v1/form_sets/{id} Retrieves a Form Set
FormSetsApi listFormSets GET /v1/form_sets List Form Sets
FormSetsApi updateFormSet PUT /v1/form_sets/{id} Update a Form Set
FunctionalitiesApi createFunctionality POST /v1/functionalities Creates a functionality
FunctionalitiesApi deleteFunctionality DELETE /v1/functionalities/{id} Delete a functionality
FunctionalitiesApi getFunctionality GET /v1/functionalities/{id} Retrieves a functionality
FunctionalitiesApi getFunctionalityIncidentsChart GET /v1/functionalities/{id}/incidents_chart Get functionality incidents chart
FunctionalitiesApi getFunctionalityUptimeChart GET /v1/functionalities/{id}/uptime_chart Get functionality uptime chart
FunctionalitiesApi listFunctionalities GET /v1/functionalities List functionalities
FunctionalitiesApi updateFunctionality PUT /v1/functionalities/{id} Update a functionality
HeartbeatsApi createHeartbeat POST /v1/heartbeats Creates a heartbeat
HeartbeatsApi deleteHeartbeat DELETE /v1/heartbeats/{id} Delete a heartbeat
HeartbeatsApi getHeartbeat GET /v1/heartbeats/{id} Retrieves a heartbeat
HeartbeatsApi listHeartbeats GET /v1/heartbeats List heartbeats
HeartbeatsApi pingHeartbeat POST /v1/heartbeats/{heartbeat_id}/ping Ping a heartbeat
HeartbeatsApi updateHeartbeat PUT /v1/heartbeats/{id} Update a heartbeat
IncidentActionItemsApi createIncidentActionItem POST /v1/incidents/{incident_id}/action_items Creates an incident action item
IncidentActionItemsApi deleteIncidentActionItem DELETE /v1/action_items/{id} Delete an incident action item
IncidentActionItemsApi getIncidentActionItems GET /v1/action_items/{id} Retrieves an incident action item
IncidentActionItemsApi listAllIncidentActionItems GET /v1/action_items List all action items for an organization
IncidentActionItemsApi listIncidentActionItems GET /v1/incidents/{incident_id}/action_items List incident action items
IncidentActionItemsApi updateIncidentActionItem PUT /v1/action_items/{id} Update an incident action item
IncidentEventFunctionalitiesApi createIncidentEventFunctionality POST /v1/events/{incident_event_id}/functionalities Creates an incident event functionality
IncidentEventFunctionalitiesApi deleteIncidentEventFunctionality DELETE /v1/incident_event_functionalities/{id} Delete an incident event functionality
IncidentEventFunctionalitiesApi getIncidentEventFunctionalities GET /v1/incident_event_functionalities/{id} Retrieves an incident event functionality
IncidentEventFunctionalitiesApi listIncidentEventFunctionalities GET /v1/events/{incident_event_id}/functionalities List incident event functionalities
IncidentEventFunctionalitiesApi updateIncidentEventFunctionality PUT /v1/incident_event_functionalities/{id} Update an incident event
IncidentEventServicesApi createIncidentEventService POST /v1/events/{incident_event_id}/services Creates an incident event service
IncidentEventServicesApi deleteIncidentEventService DELETE /v1/incident_event_services/{id} Delete an incident event functionalitu
IncidentEventServicesApi getIncidentEventServices GET /v1/incident_event_services/{id} Retrieves an incident event service
IncidentEventServicesApi listIncidentEventServices GET /v1/events/{incident_event_id}/services List incident event services
IncidentEventServicesApi updateIncidentEventService PUT /v1/incident_event_services/{id} Update an incident event
IncidentEventsApi createIncidentEvent POST /v1/incidents/{incident_id}/events Creates an incident event
IncidentEventsApi deleteIncidentEvent DELETE /v1/events/{id} Delete an incident event
IncidentEventsApi getIncidentEvents GET /v1/events/{id} Retrieves an incident event
IncidentEventsApi listIncidentEvents GET /v1/incidents/{incident_id}/events List incident events
IncidentEventsApi updateIncidentEvent PUT /v1/events/{id} Update an incident event
IncidentFeedbacksApi createIncidentFeedback POST /v1/incidents/{incident_id}/feedbacks Creates an incident feedback
IncidentFeedbacksApi getIncidentFeedbacks GET /v1/feedbacks/{id} Retrieves an incident feedback
IncidentFeedbacksApi listIncidentFeedbacks GET /v1/incidents/{incident_id}/feedbacks List incident feedbacks
IncidentFeedbacksApi updateIncidentFeedback PUT /v1/feedbacks/{id} Update an incident feedback
IncidentFormFieldSelectionsApi createIncidentFormFieldSelection POST /v1/incidents/{incident_id}/form_field_selections Creates an incident form field selection
IncidentFormFieldSelectionsApi deleteIncidentFormFieldSelection DELETE /v1/incident_form_field_selections/{id} Delete an incident form field selection
IncidentFormFieldSelectionsApi getIncidentFormFieldSelection GET /v1/incident_form_field_selections/{id} Retrieves an incident form field selection
IncidentFormFieldSelectionsApi listIncidentFormFieldSelections GET /v1/incidents/{incident_id}/form_field_selections List incident form field selections
IncidentFormFieldSelectionsApi updateIncidentFormFieldSelection PUT /v1/incident_form_field_selections/{id} Update an incident form field selection
IncidentPermissionSetBooleansApi createIncidentPermissionSetBoolean POST /v1/incident_permission_sets/{incident_permission_set_id}/booleans Creates an incident_permission_set_boolean
IncidentPermissionSetBooleansApi deleteIncidentPermissionSetBoolean DELETE /v1/incident_permission_set_booleans/{id} Delete an incident_permission_set_boolean
IncidentPermissionSetBooleansApi getIncidentPermissionSetBoolean GET /v1/incident_permission_set_booleans/{id} Retrieves an incident_permission_set_boolean
IncidentPermissionSetBooleansApi listIncidentPermissionSetBooleans GET /v1/incident_permission_sets/{incident_permission_set_id}/booleans List incident_permission_set_booleans
IncidentPermissionSetBooleansApi updateIncidentPermissionSetBoolean PUT /v1/incident_permission_set_booleans/{id} Update an incident_permission_set_boolean
IncidentPermissionSetResourcesApi createIncidentPermissionSetResource POST /v1/incident_permission_sets/{incident_permission_set_id}/resources Creates an incident_permission_set_resource
IncidentPermissionSetResourcesApi deleteIncidentPermissionSetResource DELETE /v1/incident_permission_set_resources/{id} Delete an incident_permission_set_resource
IncidentPermissionSetResourcesApi getIncidentPermissionSetResource GET /v1/incident_permission_set_resources/{id} Retrieves an incident_permission_set_resource
IncidentPermissionSetResourcesApi listIncidentPermissionSetResources GET /v1/incident_permission_sets/{incident_permission_set_id}/resources List incident_permission_set_resources
IncidentPermissionSetResourcesApi updateIncidentPermissionSetResource PUT /v1/incident_permission_set_resources/{id} Update an incident_permission_set_resource
IncidentPermissionSetsApi createIncidentPermissionSet POST /v1/incident_permission_sets Creates an incident_permission_set
IncidentPermissionSetsApi deleteIncidentPermissionSet DELETE /v1/incident_permission_sets/{id} Delete an incident_permission_set
IncidentPermissionSetsApi getIncidentPermissionSet GET /v1/incident_permission_sets/{id} Retrieves an incident_permission_set
IncidentPermissionSetsApi listIncidentPermissionSets GET /v1/incident_permission_sets List incident_permission_sets
IncidentPermissionSetsApi updateIncidentPermissionSet PUT /v1/incident_permission_sets/{id} Update an incident_permission_set
IncidentRetrospectiveStepsApi getIncidentRetrospectiveStep GET /v1/incident_retrospective_steps/{id} Retrieves an incident retrospective step
IncidentRetrospectiveStepsApi updateIncidentRetrospectiveStep PUT /v1/incident_retrospective_steps/{id} Update an incident retrospective step
IncidentRetrospectivesApi listIncidentPostMortems GET /v1/post_mortems List incident retrospectives
IncidentRetrospectivesApi listIncidentPostmortem GET /v1/post_mortems/{id} Retrieves an incident retrospective
IncidentRetrospectivesApi updateIncidentPostmortem PUT /v1/post_mortems/{id} Update an incident retrospective
IncidentRoleTasksApi createIncidentRoleTask POST /v1/incident_roles/{incident_role_id}/incident_role_tasks Creates an incident role task
IncidentRoleTasksApi deleteIncidentRoleTask DELETE /v1/incident_role_tasks/{id} Delete an incident role task
IncidentRoleTasksApi getIncidentRoleTask GET /v1/incident_role_tasks/{id} Retrieves an incident role task
IncidentRoleTasksApi listIncidentRoleTasks GET /v1/incident_roles/{incident_role_id}/incident_role_tasks List incident role tasks
IncidentRoleTasksApi updateIncidentRoleTask PUT /v1/incident_role_tasks/{id} Update an incident role task
IncidentRolesApi createIncidentRole POST /v1/incident_roles Creates an incident role
IncidentRolesApi deleteIncidentRole DELETE /v1/incident_roles/{id} Delete an incident role
IncidentRolesApi getIncidentRole GET /v1/incident_roles/{id} Retrieves an incident role
IncidentRolesApi listIncidentRoles GET /v1/incident_roles List incident roles
IncidentRolesApi updateIncidentRole PUT /v1/incident_roles/{id} Update an incident role
IncidentStatusPageEventsApi createIncidentStatusPage POST /v1/incidents/{incident_id}/status-page-events Creates an incident status page event
IncidentStatusPageEventsApi deleteIncidentStatusPage DELETE /v1/status-page-events/{id} Delete an incident status page event
IncidentStatusPageEventsApi getIncidentStatusPages GET /v1/status-page-events/{id} Retrieves an incident status page event
IncidentStatusPageEventsApi listIncidentStatusPages GET /v1/incidents/{incident_id}/status-page-events List incident status page events
IncidentStatusPageEventsApi updateIncidentStatusPage PUT /v1/status-page-events/{id} Update an incident status page event
IncidentSubStatusesApi createIncidentSubStatus POST /v1/incidents/{incident_id}/sub_statuses Creates a sub-status assignment
IncidentSubStatusesApi deleteIncidentSubStatus DELETE /v1/incident_sub_statuses/{id} Delete an incident_sub_status
IncidentSubStatusesApi getIncidentSubStatus GET /v1/incident_sub_statuses/{id} Retrieves incident_sub_status
IncidentSubStatusesApi listIncidentSubStatuses GET /v1/incidents/{incident_id}/sub_statuses List incident_sub_statuses
IncidentSubStatusesApi updateIncidentSubStatus PUT /v1/incident_sub_statuses/{id} Update incident_sub_status
IncidentTypesApi createIncidentType POST /v1/incident_types Creates an incident type
IncidentTypesApi deleteIncidentType DELETE /v1/incident_types/{id} Delete an incident type
IncidentTypesApi getIncidentType GET /v1/incident_types/{id} Retrieves an incident type
IncidentTypesApi listIncidentTypes GET /v1/incident_types List incident types
IncidentTypesApi updateIncidentType PUT /v1/incident_types/{id} Update an incident type
IncidentsApi addSubscribersToIncident POST /v1/incidents/{id}/add_subscribers Add subscribers to incident
IncidentsApi assignUserToIncident POST /v1/incidents/{id}/assign_role_to_user Assign user to incident
IncidentsApi cancelIncident PUT /v1/incidents/{id}/cancel Cancel an incident
IncidentsApi createIncident POST /v1/incidents Creates an incident
IncidentsApi deleteIncident DELETE /v1/incidents/{id} Delete an incident
IncidentsApi getIncident GET /v1/incidents/{id} Retrieves an incident
IncidentsApi listIncidents GET /v1/incidents List incidents
IncidentsApi markAsDuplicateIncident PUT /v1/incidents/{id}/duplicate Mark an incident as a duplicate
IncidentsApi mitigateIncident PUT /v1/incidents/{id}/mitigate Mitigate an incident
IncidentsApi removeAssignedUserFromIncident DELETE /v1/incidents/{id}/unassign_role_from_user Remove assigned user from incident
IncidentsApi removeSubscribersToIncident DELETE /v1/incidents/{id}/remove_subscribers Remove subscribers from incident
IncidentsApi resolveIncident PUT /v1/incidents/{id}/resolve Resolve an incident
IncidentsApi restartIncident PUT /v1/incidents/{id}/restart Restart an incident
IncidentsApi triageIncident PUT /v1/incidents/{id}/in_triage Triage an incident
IncidentsApi updateIncident PUT /v1/incidents/{id} Update an incident
IpRangesApi getIpRanges GET /v1/ip_ranges Retrieves IP ranges
LiveCallRoutersApi createLiveCallRouter POST /v1/live_call_routers Creates a Live Call Router
LiveCallRoutersApi deleteLiveCallRouter DELETE /v1/live_call_routers/{id} Delete a Live Call Router
LiveCallRoutersApi generatePhoneNumberLiveCallRouter GET /v1/live_call_routers/generate_phone_number Generates a phone number for Live Call Router
LiveCallRoutersApi getLiveCallRouter GET /v1/live_call_routers/{id} Retrieves a Live Call Router
LiveCallRoutersApi listLiveCallRouters GET /v1/live_call_routers List Live Call Routers
LiveCallRoutersApi updateLiveCallRouter PUT /v1/live_call_routers/{id} Update a Live Call Router
OnCallRolesApi createOnCallRole POST /v1/on_call_roles Creates an On-Call Role
OnCallRolesApi deleteOnCallRole DELETE /v1/on_call_roles/{id} Delete an On-Call Role
OnCallRolesApi getOnCallRole GET /v1/on_call_roles/{id} Retrieves an On-Call Role
OnCallRolesApi listOnCallRoles GET /v1/on_call_roles List On-Call Roles
OnCallRolesApi updateOnCallRole PUT /v1/on_call_roles/{id} Update an On-Call Role
OnCallShadowsApi createOnCallShadow POST /v1/schedules/{schedule_id}/on_call_shadows creates an shadow configuration
OnCallShadowsApi getOnCallShadow GET /v1/on_call_shadows/{id} Retrieves an On Call Shadow configuration by ID
OnCallShadowsApi listOnCallShadows GET /v1/schedules/{schedule_id}/on_call_shadows List On Call Shadows for Shift
OnCallShadowsApi updateOnCallShadow PUT /v1/on_call_shadows/{id} Update an On Call Shadow configuration
OverrideShiftsApi createOverrideShift POST /v1/schedules/{schedule_id}/override_shifts creates an override shift
OverrideShiftsApi deleteOnCallShadow DELETE /v1/on_call_shadows/{id} Delete an on call shadow configuration
OverrideShiftsApi deleteOverrideShift DELETE /v1/override_shifts/{id} Delete an override shift
OverrideShiftsApi getOverrideShift GET /v1/override_shifts/{id} Retrieves an override shift
OverrideShiftsApi listOverrideShifts GET /v1/schedules/{schedule_id}/override_shifts List override shifts
OverrideShiftsApi updateOverrideShift PUT /v1/override_shifts/{id} Update an override shift
PlaybookTasksApi createPlaybookTask POST /v1/playbooks/{playbook_id}/playbook_tasks Creates a playbook task
PlaybookTasksApi deletePlaybookTask DELETE /v1/playbook_tasks/{id} Delete a playbook task
PlaybookTasksApi getPlaybookTask GET /v1/playbook_tasks/{id} Retrieves a playbook task
PlaybookTasksApi listPlaybookTasks GET /v1/playbooks/{playbook_id}/playbook_tasks List playbook tasks
PlaybookTasksApi updatePlaybookTask PUT /v1/playbook_tasks/{id} Update a playbook task
PlaybooksApi createPlaybook POST /v1/playbooks Creates a playbook
PlaybooksApi deletePlaybook DELETE /v1/playbooks/{id} Delete a playbook
PlaybooksApi getPlaybook GET /v1/playbooks/{id} Retrieves a playbook
PlaybooksApi listPlaybooks GET /v1/playbooks List playbooks
PlaybooksApi updatePlaybook PUT /v1/playbooks/{id} Update a playbook
PulsesApi createPulse POST /v1/pulses Creates a pulse
PulsesApi getPulse GET /v1/pulses/{id} Retrieves a pulse
PulsesApi listPulses GET /v1/pulses List pulses
PulsesApi updatePulse PUT /v1/pulses/{id} Update a pulse
RetrospectiveConfigurationsApi getRetrospectiveConfiguration GET /v1/retrospective_configurations/{id} Retrieves a Retrospective Configuration
RetrospectiveConfigurationsApi listRetrospectiveConfigurations GET /v1/retrospective_configurations List retrospective configurations
RetrospectiveConfigurationsApi updateRetrospectiveConfiguration PUT /v1/retrospective_configurations/{id} Update a retrospective configuration
RetrospectiveProcessGroupStepsApi createRetrospectiveProcessGroupStep POST /v1/retrospective_process_groups/{retrospective_process_group_id}/steps Creates a retrospective process group step
RetrospectiveProcessGroupStepsApi deleteRetrospectiveProcessGroupStep DELETE /v1/retrospective_process_group_steps/{id} Delete a RetrospectiveProcessGroup Step
RetrospectiveProcessGroupStepsApi getRetrospectiveProcessGroupStep GET /v1/retrospective_process_group_steps/{id} Retrieves a RetrospectiveProcessGroup Step
RetrospectiveProcessGroupStepsApi listRetrospectiveProcessGroupSteps GET /v1/retrospective_process_groups/{retrospective_process_group_id}/steps List RetrospectiveProcessGroup Steps
RetrospectiveProcessGroupStepsApi updateRetrospectiveProcessGroupStep PUT /v1/retrospective_process_group_steps/{id} Update RetrospectiveProcessGroup Step
RetrospectiveProcessGroupsApi createRetrospectiveProcessGroup POST /v1/retrospective_processes/{retrospective_process_id}/groups Creates a retrospective process group
RetrospectiveProcessGroupsApi deleteRetrospectiveProcessGroup DELETE /v1/retrospective_process_groups/{id} Delete a Retrospective Process Group
RetrospectiveProcessGroupsApi getRetrospectiveProcessGroup GET /v1/retrospective_process_groups/{id} Retrieves a Retrospective Process Group
RetrospectiveProcessGroupsApi listRetrospectiveProcessGroups GET /v1/retrospective_processes/{retrospective_process_id}/groups List Retrospective Process Groups
RetrospectiveProcessGroupsApi updateRetrospectiveProcessGroup PUT /v1/retrospective_process_groups/{id} Update a Retrospective Process Group
RetrospectiveProcessesApi createRetrospectiveProcess POST /v1/retrospective_processes Creates a retrospective process
RetrospectiveProcessesApi deleteRetrospectiveProcess DELETE /v1/retrospective_processes/{id} Delete a retrospective process
RetrospectiveProcessesApi getRetrospectiveProcess GET /v1/retrospective_processes/{id} Retrieves a retrospective process
RetrospectiveProcessesApi listRetrospectiveProcesses GET /v1/retrospective_processes List retrospective processes
RetrospectiveProcessesApi updateRetrospectiveProcess PUT /v1/retrospective_processes/{id} Update a retrospective process
RetrospectiveStepsApi createRetrospectiveStep POST /v1/retrospective_processes/{retrospective_process_id}/retrospective_steps Creates a retrospective step
RetrospectiveStepsApi deleteRetrospectiveStep DELETE /v1/retrospective_steps/{id} Delete a retrospective step
RetrospectiveStepsApi getRetrospectiveStep GET /v1/retrospective_steps/{id} Retrieves a retrospective step
RetrospectiveStepsApi listRetrospectiveSteps GET /v1/retrospective_processes/{retrospective_process_id}/retrospective_steps List retrospective steps
RetrospectiveStepsApi updateRetrospectiveStep PUT /v1/retrospective_steps/{id} Update a retrospective step
RetrospectiveTemplatesApi createPostmortemTemplate POST /v1/post_mortem_templates Creates a retrospective template
RetrospectiveTemplatesApi deletePostmortemTemplate DELETE /v1/post_mortem_templates/{id} Delete a Retrospective Template
RetrospectiveTemplatesApi getPostmortemTemplate GET /v1/post_mortem_templates/{id} Retrieves a Retrospective Template
RetrospectiveTemplatesApi listPostmortemTemplates GET /v1/post_mortem_templates List Retrospective Templates
RetrospectiveTemplatesApi updatePostmortemTemplate PUT /v1/post_mortem_templates/{id} Update a Retrospective Template
RolesApi createRole POST /v1/roles Creates a role
RolesApi deleteRole DELETE /v1/roles/{id} Delete a role
RolesApi getRole GET /v1/roles/{id} Retrieves a role
RolesApi listRoles GET /v1/roles List roles
RolesApi updateRole PUT /v1/roles/{id} Update a role
ScheduleRotationActiveDaysApi createScheduleRotationActiveDay POST /v1/schedule_rotations/{schedule_rotation_id}/schedule_rotation_active_days Creates a schedule rotation active day
ScheduleRotationActiveDaysApi deleteScheduleRotationActiveDay DELETE /v1/schedule_rotation_active_days/{id} Delete a schedule rotation active day
ScheduleRotationActiveDaysApi getScheduleRotationActiveDay GET /v1/schedule_rotation_active_days/{id} Retrieves a schedule rotation active day
ScheduleRotationActiveDaysApi listScheduleRotationActiveDays GET /v1/schedule_rotations/{schedule_rotation_id}/schedule_rotation_active_days List schedule rotation active days
ScheduleRotationActiveDaysApi updateScheduleRotationActiveDay PUT /v1/schedule_rotation_active_days/{id} Update a schedule rotation active day
ScheduleRotationUsersApi createScheduleRotationUser POST /v1/schedule_rotations/{schedule_rotation_id}/schedule_rotation_users Creates a schedule rotation user
ScheduleRotationUsersApi deleteScheduleRotationUser DELETE /v1/schedule_rotation_users/{id} Delete a schedule rotation user
ScheduleRotationUsersApi getScheduleRotationUser GET /v1/schedule_rotation_users/{id} Retrieves a schedule rotation user
ScheduleRotationUsersApi listScheduleRotationUsers GET /v1/schedule_rotations/{schedule_rotation_id}/schedule_rotation_users List schedule rotation users
ScheduleRotationUsersApi updateScheduleRotationUser PUT /v1/schedule_rotation_users/{id} Update schedule rotation user
ScheduleRotationsApi createScheduleRotation POST /v1/schedules/{schedule_id}/schedule_rotations Creates a schedule rotation
ScheduleRotationsApi deleteScheduleRotation DELETE /v1/schedule_rotations/{id} Delete a schedule rotation
ScheduleRotationsApi getScheduleRotation GET /v1/schedule_rotations/{id} Retrieves a schedule rotation
ScheduleRotationsApi listScheduleRotations GET /v1/schedules/{schedule_id}/schedule_rotations List schedule rotations
ScheduleRotationsApi updateScheduleRotation PUT /v1/schedule_rotations/{id} Update a schedule rotation
SchedulesApi createSchedule POST /v1/schedules Creates a schedule
SchedulesApi deleteSchedule DELETE /v1/schedules/{id} Delete a schedule
SchedulesApi getSchedule GET /v1/schedules/{id} Retrieves a schedule
SchedulesApi listSchedules GET /v1/schedules List schedules
SchedulesApi updateSchedule PUT /v1/schedules/{id} Update a schedule
SecretsApi createSecret POST /v1/secrets Creates a secret
SecretsApi deleteSecret DELETE /v1/secrets/{id} Delete a secret
SecretsApi getSecret GET /v1/secrets/{id} Retrieves a secret
SecretsApi listSecrets GET /v1/secrets List secrets
SecretsApi updateSecret PUT /v1/secrets/{id} Update a secret
ServicesApi createService POST /v1/services Creates a service
ServicesApi deleteService DELETE /v1/services/{id} Delete a service
ServicesApi getService GET /v1/services/{id} Retrieves a service
ServicesApi getServiceIncidentsChart GET /v1/services/{id}/incidents_chart Get service incidents chart
ServicesApi getServiceUptimeChart GET /v1/services/{id}/uptime_chart Get service uptime chart
ServicesApi listServices GET /v1/services List services
ServicesApi updateService PUT /v1/services/{id} Update a service
SeveritiesApi createSeverity POST /v1/severities Creates a severity
SeveritiesApi deleteSeverity DELETE /v1/severities/{id} Delete a severity
SeveritiesApi getSeverity GET /v1/severities/{id} Retrieves a severity
SeveritiesApi listSeverities GET /v1/severities List severities
SeveritiesApi updateSeverity PUT /v1/severities/{id} Update a severity
ShiftsApi getScheduleShifts GET /v1/schedules/{id}/shifts Retrieves a schedule shifts
ShiftsApi listShifts GET /v1/shifts List shifts
StatusPageTemplatesApi createStatusPageTemplate POST /v1/status-pages/{status_page_id}/templates Creates a status page template
StatusPageTemplatesApi deleteStatusPageTemplate DELETE /v1/templates/{id} Delete a incident event
StatusPageTemplatesApi getStatusPageTemplate GET /v1/templates/{id} Retrieves a status page template
StatusPageTemplatesApi listStatusPageTemplates GET /v1/status-pages/{status_page_id}/templates List status page templates
StatusPageTemplatesApi updateStatusPageTemplate PUT /v1/templates/{id} Update status page template
StatusPagesApi createStatusPage POST /v1/status-pages Creates a status page
StatusPagesApi deleteStatusPage DELETE /v1/status-pages/{id} Delete a status page
StatusPagesApi getStatusPage GET /v1/status-pages/{id} Retrieves a status page
StatusPagesApi listStatusPages GET /v1/status-pages List status pages
StatusPagesApi updateStatusPage PUT /v1/status-pages/{id} Update a status page
SubStatusesApi createSubStatus POST /v1/sub_statuses Creates a Sub-Status
SubStatusesApi deleteSubStatus DELETE /v1/sub_statuses/{id} Delete a Sub-Status
SubStatusesApi getSubStatus GET /v1/sub_statuses/{id} Retrieves a Sub-Status
SubStatusesApi listSubStatuses GET /v1/sub_statuses List Sub-Statuses
SubStatusesApi updateSubStatus PUT /v1/sub_statuses/{id} Update a Sub-Status
TeamsApi createTeam POST /v1/teams Creates a team
TeamsApi deleteTeam DELETE /v1/teams/{id} Delete a team
TeamsApi getTeam GET /v1/teams/{id} Retrieves a team
TeamsApi getTeamIncidentsChart GET /v1/teams/{id}/incidents_chart Get team incidents chart
TeamsApi listTeams GET /v1/teams List teams
TeamsApi updateTeam PUT /v1/teams/{id} Update a team
UserNotificationRulesApi createUserNotificationRule POST /v1/users/{user_id}/notification_rules Creates an user notification rule
UserNotificationRulesApi deleteUserNotificationRule DELETE /v1/notification_rules/{id} Delete an user notification rule
UserNotificationRulesApi getUserNotificationRule GET /v1/notification_rules/{id} Retrieves an user notification rule
UserNotificationRulesApi listUserNotificationRules GET /v1/users/{user_id}/notification_rules List user notification rules
UserNotificationRulesApi updateUserNotificationRule PUT /v1/notification_rules/{id} Update an user notification rule
UsersApi deleteUser DELETE /v1/users/{id} Delete an user
UsersApi getCurrentUser GET /v1/users/me Get current user
UsersApi getUser GET /v1/users/{id} Retrieves an user
UsersApi listUsers GET /v1/users List users
UsersApi updateUser PUT /v1/users/{id} Update a user
WebhooksDeliveriesApi deliverWebhooksDelivery POST /v1/webhooks/deliveries/{id}/deliver Retries a webhook delivery
WebhooksDeliveriesApi getWebhooksDelivery GET /v1/webhooks/deliveries/{id} Retrieves a webhook delivery
WebhooksDeliveriesApi listWebhooksDeliveries GET /v1/webhooks/endpoints/{endpoint_id}/deliveries List webhook deliveries
WebhooksEndpointsApi createWebhooksEndpoint POST /v1/webhooks/endpoints Creates a webhook endpoint
WebhooksEndpointsApi deleteWebhooksEndpoint DELETE /v1/webhooks/endpoints/{id} Delete a webhook endpoint
WebhooksEndpointsApi getWebhooksEndpoint GET /v1/webhooks/endpoints/{id} Retrieves a webhook endpoint
WebhooksEndpointsApi listWebhooksEndpoints GET /v1/webhooks/endpoints List webhook endpoints
WebhooksEndpointsApi updateWebhooksEndpoint PUT /v1/webhooks/endpoints/{id} Update a webhook endpoint
WorkflowFormFieldConditionsApi createWorkflowFormFieldCondition POST /v1/workflows/{workflow_id}/form_field_conditions Creates a workflow form field condition
WorkflowFormFieldConditionsApi deleteWorkflowFormFieldCondition DELETE /v1/workflow_form_field_conditions/{id} Delete a workflow_form field condition
WorkflowFormFieldConditionsApi getWorkflowFormFieldCondition GET /v1/workflow_form_field_conditions/{id} Retrieves a workflow form field condition
WorkflowFormFieldConditionsApi listWorkflowFormFieldConditions GET /v1/workflows/{workflow_id}/form_field_conditions List workflow form field conditions
WorkflowFormFieldConditionsApi updateWorkflowFormFieldCondition PUT /v1/workflow_form_field_conditions/{id} Update a workflow form field condition
WorkflowGroupsApi createWorkflowGroup POST /v1/workflow_groups Creates a workflow group
WorkflowGroupsApi deleteWorkflowGroup DELETE /v1/workflow_groups/{id} Delete a workflow_group
WorkflowGroupsApi getWorkflowGroup GET /v1/workflow_groups/{id} Retrieves a workflow group
WorkflowGroupsApi listWorkflowGroups GET /v1/workflow_groups List workflow groups
WorkflowGroupsApi updateWorkflowGroup PUT /v1/workflow_groups/{id} Update a workflow group
WorkflowRunsApi createWorkflowRun POST /v1/workflows/{workflow_id}/workflow_runs Creates a workflow run
WorkflowRunsApi listWorkflowRuns GET /v1/workflows/{workflow_id}/workflow_runs List workflow runs
WorkflowTasksApi createWorkflowTask POST /v1/workflows/{workflow_id}/workflow_tasks Creates a workflow task
WorkflowTasksApi deleteWorkflowTask DELETE /v1/workflow_tasks/{id} Delete a workflow task
WorkflowTasksApi getWorkflowTask GET /v1/workflow_tasks/{id} Retrieves a workflow task
WorkflowTasksApi listWorkflowTasks GET /v1/workflows/{workflow_id}/workflow_tasks List workflow tasks
WorkflowTasksApi updateWorkflowTask PUT /v1/workflow_tasks/{id} Update a workflow task
WorkflowsApi createWorkflow POST /v1/workflows Creates a workflow
WorkflowsApi deleteWorkflow DELETE /v1/workflows/{id} Delete a workflow
WorkflowsApi getWorkflow GET /v1/workflows/{id} Retrieves a workflow
WorkflowsApi listWorkflows GET /v1/workflows List workflows
WorkflowsApi updateWorkflow PUT /v1/workflows/{id} Update a workflow

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

bearer_auth

  • Type: HTTP Bearer Token authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages