{"@context": "https://schema.org", "@type": "WebAPI", "name": "SIGNL4 API API", "description": "Use our API for systems integration or to build your own use cases. Sample scenarios include but are not limited to:2-way integration: Triggering of Signls and updates in the third party systems when alert state changes occurRetrieving alarms for logging purposesCalendar integrations: Creation and m", "provider": {"@type": "Organization", "name": "signl4.com"}, "documentation": "https://connect.signl4.com/api/docs/v1/swagger.json"}
Use our API for systems integration or to build your own use cases. Sample scenarios include but are not limited to:2-way integration: Triggering of Signls and updates in the third party systems when alert state changes occurRetrieving alarms for logging purposesCalendar integrations: Creation and m
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://connect.signl4.com/api
auth: o a u t h 2
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Use our API for systems integration or to build your own use cases. Sample scenarios include but are not limited to:2-way integration: Triggering of Signls and updates in the third party systems when alert state changes occurRetrieving alarms for logging purposesCalendar integrations: Creation and management of on-call dutiesPunch users in and out based on external calendarsetc.AUTHENTICATIONUsing
| method | path | what the vendor says it does |
|---|---|---|
POST | /alerts | Trigger Alert Triggers a new alert for your team. All team members on duty will receive alert notifications. A |
POST | /alerts/acknowledgeAll | Confirms all visible alerts This method confirms all unhandled alerts your team currently has by a specific us |
POST | /alerts/acknowledgeMultiple | Acknowlegde multiple alerts This method confirms all alerts provided. Alerts |
POST | /alerts/closeAll | Close all acknowledged alerts. This method closes all acknowledged alerts your team currently has. Alerts |
POST | /alerts/closeMultiple | Close multiple alerts This method closes all alerts provided. Alerts |
POST | /alerts/paged | Gets alerts paged Alerts |
GET | /alerts/report | Get Alert Report Returns information about the occurred alert volume in different time periods as well as info |
POST | /alerts/undoAcknowledgeMultiple | Queue undo of multiple acknowledgments. This method tries to undo the acknowledgement of multiple alerts via a |
POST | /alerts/undoCloseMultiple | Withdraw closure of multiple alerts This method tries to undo multiple alert closes. The operation is handled |
GET | /alerts/{alertId} | Get Alert Gets an alert by id. Alerts |
POST | /alerts/{alertId}/acknowledge | Acknowledge an alert Alerts |
POST | /alerts/{alertId}/annotate | Annotate Alert Annotates an alert by given Annotation Info. Alerts |
GET | /alerts/{alertId}/annotations | Get annotations of an alert Get annotations of an alert by id. Alerts |
GET | /alerts/{alertId}/attachments | Get attachments of an alert Get attachments of an alert by id. Alerts |
GET | /alerts/{alertId}/attachments/{attachmentId} | Gets a specified attachment of a specified alert. Alerts |
POST | /alerts/{alertId}/close | Close an alert Alerts |
GET | /alerts/{alertId}/notifications | Get alert notifications Get notifications of all users by alert id. Alerts |
GET | /alerts/{alertId}/overview | Get an overview alert. Get overview alert by id. Alerts |
POST | /alerts/{alertId}/undoAcknowledge | Undo the acknowledgement of an alert. This method tries to undo an alert acknowledgement. Alerts |
POST | /alerts/{alertId}/undoClose | Undo the closure of an alert. This method tries to undo an alert close. Alerts |
GET | /categories/images | Gets the names of all alert category images. You can get the image by going to account.signl4.com/images/aler |
GET | /categories/{teamId} | Get all categories Sample Request: GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7 Cat |
POST | /categories/{teamId} | Create a new category Sample Request: POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7 |
GET | /categories/{teamId}/metrics | Get metrics for all categories Sample Request: GET /categories/cbb70402-1359-477f-ac92-0171 |
GET | /categories/{teamId}/{categoryId} | Get a specific category Sample Request: GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff |
PUT | /categories/{teamId}/{categoryId} | Update an existing category Sample Request: PUT /categories/cbb70402-1359-477f-ac92-0171cf2 |
DELETE | /categories/{teamId}/{categoryId} | Delete an existing category Sample Request: DELETE /categories/cbb70402-1359-477f-ac92-0171 |
GET | /categories/{teamId}/{categoryId}/metrics | Get metrics for a specific category Sample Request: GET /categories/cbb70402-1359-477f-ac92 |
GET | /categories/{teamId}/{categoryId}/subscriptions | Get category subscriptions Sample Request: GET /categories/cbb70402-1359-477f-ac92-0171cf2b |
POST | /categories/{teamId}/{categoryId}/subscriptions | Set category subscriptions Sample Request: POST /categories/cbb70402-1359-477f-ac92-0171cf2 |
POST | /events/paged | Get overview event paged. Get overview event paged. If there are more results, you also get a continuation tok |
GET | /events/{eventId}/overview | Get overview event Get overview event by id. Events |
GET | /events/{eventId}/parameters | Get event parameters Get parameters of an event by id. Events |
GET | /prepaid/balance | Get your subscription's current prepaid balance. Prepaid |
GET | /prepaid/settings | Get your subscription's current prepaid settings. Prepaid |
PUT | /prepaid/settings | Update your subscription's current prepaid settings. Prepaid |
GET | /prepaid/transactions | Get your subscription's prepaid transactions. Prepaid |
GET | /scripts/instances | Returns all script instances of the SIGNL4 team Returns all script instances in the subscription. Scripts |
POST | /scripts/instances | Creates a new script instance in the in the SIGNL4 team. Creates a new script instance of the script specified |
GET | /scripts/instances/{instanceId} | Returns all information about a given script instance which includes its runtime status. Gets the script insta |
and 60 more operation(s) in this specification, all searchable.
specification origin: https://connect.signl4.com/api/docs/v1/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.