SIGNL4 API

Tools (103)

Extracted live via the executor SDK.

• alerts.getAlertsAlertId

  Gets an alert by id.

• alerts.getAlertsAlertIdAnnotations

  Get annotations of an alert by id.

• alerts.getAlertsAlertIdAttachments

  Get attachments of an alert by id.

• alerts.getAlertsAlertIdAttachmentsAttachmentId

  Gets a specified attachment of a specified alert.

• alerts.getAlertsAlertIdNotifications

  Get notifications of all users by alert id.

• alerts.getAlertsAlertIdOverview

  Get overview alert by id.

• alerts.getAlertsReport

  Returns information about the occurred alert volume in different time periods as well as information about the response behaviour (amount of confirmed and unhandled alerts) of your team members.

• alerts.postAlerts

  Triggers a new alert for your team. All team members on duty will receive alert notifications.

• alerts.postAlertsAcknowledgeAll

  This method confirms all unhandled alerts your team currently has by a specific user.

• alerts.postAlertsAcknowledgeMultiple

  This method confirms all alerts provided.

• alerts.postAlertsAlertIdAcknowledge

  Acknowledge an alert

• alerts.postAlertsAlertIdAnnotate

  Annotates an alert by given Annotation Info.

• alerts.postAlertsAlertIdClose

  Close an alert

• alerts.postAlertsAlertIdUndoAcknowledge

  This method tries to undo an alert acknowledgement.

• alerts.postAlertsAlertIdUndoClose

  This method tries to undo an alert close.

• alerts.postAlertsCloseAll

  This method closes all acknowledged alerts your team currently has.

• alerts.postAlertsCloseMultiple

  This method closes all alerts provided.

• alerts.postAlertsPaged

  Gets alerts paged

• alerts.postAlertsUndoAcknowledgeMultiple

  This method tries to undo the acknowledgement of multiple alerts via a queue. The operation is handled in the background.

• alerts.postAlertsUndoCloseMultiple

  This method tries to undo multiple alert closes. The operation is handled in the background.

• categories.deleteCategoriesTeamIdCategoryId

  Sample Request:

  DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e

• categories.getCategoriesImages

  Gets the names of all alert category images. You can get the image by going to account.signl4.com/images/alerts/categoryImageName.svg

• categories.getCategoriesTeamId

  Sample Request:

  GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7

• categories.getCategoriesTeamIdCategoryId

  Sample Request:

  GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e

• categories.getCategoriesTeamIdCategoryIdMetrics

  Sample Request:

  GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics

• categories.getCategoriesTeamIdCategoryIdSubscriptions

  Sample Request:

  GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions{}

• categories.getCategoriesTeamIdMetrics

  Sample Request:

  GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics

• categories.postCategoriesTeamId

  Sample Request:

  POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7{    "name": "Water",    "imageName": "water.svg",    "color": "#0000cc",    "keywordMatching": "Any",    "keywords": [        {            "value": "H2O"        },        {            "value": "Water"        }    ]}

• categories.postCategoriesTeamIdCategoryIdSubscriptions

  Sample Request:

  POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions{}

• categories.putCategoriesTeamIdCategoryId

  Sample Request:

  PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e{    "name": "Water-Updated",    "imageName": "water.svg",    "color": "#0000cc",    "keywordMatching": "All",    "keywords": [        {            "value": "H2O"        },        {            "value": "Water"        },        {            "value": "Wet"        }    ]}

• duties.deleteTeamsTeamIdSchedulesDutyId

  Delete a specific duty.

• duties.getTeamsTeamIdDutyReports

  Get Information about downloadable reports

• duties.getTeamsTeamIdDutyReportsFileName

  Download duty report with a specific fileName

• duties.getTeamsTeamIdDutysummary

  Get duty assistant info for a team

• duties.getTeamsTeamIdSchedules

  Returns information about all duties that belong to the team.

• duties.getTeamsTeamIdSchedulesScheduleId

  Returns information of the duty schedule with the specified Id.

• duties.postTeamsTeamIdSchedules

  Create/Update given duty schedule.

• duties.postTeamsTeamIdSchedulesDeleteRange

  Delete duty schedules in range

• duties.postTeamsTeamIdSchedulesMultiple

  Save multiple schedules. It is possible to override existing schedules if you wish

• events.getEventsEventIdOverview

  Get overview event by id.

• events.getEventsEventIdParameters

  Get parameters of an event by id.

• events.postEventsPaged

  Get overview event paged. If there are more results, you also get a continuation token which you can add to the event filter.

• prepaid.getPrepaidBalance

  Get your subscription's current prepaid balance.

• prepaid.getPrepaidSettings

  Get your subscription's current prepaid settings.

• prepaid.getPrepaidTransactions

  Get your subscription's prepaid transactions.

• prepaid.getSubscriptionsSubscriptionIdPrepaidBalance

  Get a subscription's current prepaid balance.

• prepaid.getSubscriptionsSubscriptionIdPrepaidSettings

  Get a subscription's current prepaid settings.

• prepaid.getSubscriptionsSubscriptionIdPrepaidTransactions

  Get a subscription's prepaid transactions.

• prepaid.putPrepaidSettings

  Update your subscription's current prepaid settings.

• prepaid.putSubscriptionsSubscriptionIdPrepaidSettings

  Update a subscription's current prepaid settings.

• scripts.deleteScriptsInstancesInstanceId

  Gets the script instance specified by the passed instance id.

• scripts.getScriptsInstances

  Returns all script instances in the subscription.

• scripts.getScriptsInstancesInstanceId

  Gets the script instance specified by the passed instance id.

• scripts.getScriptsInventory

  Returns all available inventory scripts which can be added to a SIGNL4 subscription.

• scripts.getScriptsInventoryParsed

  Returns all inventory scripts.

• scripts.getScriptsInventoryParsedScriptId

  Gets the script specified by the passed script id.

• scripts.postScriptsInstances

  Creates a new script instance of the script specified in the request body.

• scripts.postScriptsInstancesInstanceIdDisable

  Disables a given script instance.

• scripts.postScriptsInstancesInstanceIdEnable

  Enables a script instance.

• scripts.putScriptsInstancesInstanceId

  Updates the specified script instance.

• scripts.putScriptsInstancesInstanceIdData

  Updates the specified script instance.

• subscriptions.getSubscriptions

  Get infos of all available/managed subscriptions.

• subscriptions.getSubscriptionsSubscriptionId

  Get infos of a specific subscription.

• subscriptions.getSubscriptionsSubscriptionIdChannelPrices

  Returns the subscription's channel price information.

• subscriptions.getSubscriptionsSubscriptionIdFeatures

  Returns the features of a specified subscription.

• subscriptions.getSubscriptionsSubscriptionIdUserLicenses

  Gets a subscription's user licenses.

• subscriptions.putSubscriptionsSubscriptionIdProfile

  Updates a subscriptions profile.

• teams.getSubscriptionsSubscriptionIdTeams

  Get infos for all teams of the subscription.

• teams.getTeams

  Get infos of all teams.

• teams.getTeamsTeamId

  Gets infos of a specific team.

• teams.getTeamsTeamIdAlertReports

  Get information about downloadable alert reports

• teams.getTeamsTeamIdAlertReportsFileName

  Returns Alert Report

• teams.getTeamsTeamIdAlertSettings

  Gets alert settings of a specific team.

• teams.getTeamsTeamIdEventSources

  Gets event sources of a specific team.

• teams.getTeamsTeamIdSetupProgress

  Gets setup progress of a specific team.

• teams.postTeamsTeamIdAlertSettings

  Sets alert settings of a specific team.

• teams.putTeamsTeamIdProfile

  Updates team profile of a team

• teamsMemberships.deleteTeamsTeamIdMembershipsUserId

  Removes a user or invitation from a team, and may delete the user if he is not in any team.

• teamsMemberships.getTeamsTeamIdMemberships

  Get all invites of a team.

• teamsMemberships.postTeamsTeamIdMemberships

  Invite users to a team

• teamsMemberships.postTeamsTeamIdMembershipsResendInviteMail

  Sends invite email again if an invite exists

• teamsMemberships.putTeamsTeamIdMembershipsUserId

  Updates the user's team membership. You can move the user to another team within the subscription and/or change the user's role.

• users.getUsers

  Returns a list of user objects with details such as their email address and duty information. Only users who are part of your team will be returned.

• users.getUsersUserId

  Returns a user object with details such as his email address and duty information.

• users.getUsersUserIdDutyStatus

  Returns a object with duty information.

• users.getUsersUserIdImage

  GET /users/{userId}/image

• users.getUsersUserIdSetupProgress

  Gets setup progress of a specific user.

• users.postUsersUserIdCheckPermissions

  Checks if a user has the provided permission.

• users.postUsersUserIdImage

  Uploaded a profile image for a specified user.

• users.postUsersUserIdPunchIn

  The specified user will be punched in to duty.

• users.postUsersUserIdPunchInAsManager

  The specified user will be punched in to duty as a manager.

• users.postUsersUserIdPunchOut

  The specified user will be punched out from duty.

• users.putUsersUserIdChangePassword

  Updates the password of a user

• users.putUsersUserIdProfile

  Updates user profile of an user

• webhooks.deleteWebhooksWebhookId

  Deletes the specified webhook so that it will no longer be notified.

• webhooks.getWebhookById

  Returns information of the webhook specified by the passed id.

• webhooks.getWebhooks

  Returns a collection of defined outbound webhooks in the system.

• webhooks.postWebhooks

  Creates a new outbound webhook that will be notified when certain events occur.

• webhooks.postWebhooksWebhookIdDisable

  Ability to enable a webHook.

• webhooks.postWebhooksWebhookIdEnable

  Ability to disable a webHook.

• webhooks.putWebhooksWebhookId

  Updates the specified webhook.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools