Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zenduty Incidents API

This object represents the incidents of the account. You can checkout the incident docs here https://docs.zenduty.com/docs/incidents

Zenduty Incidents API is one of 34 APIs that Zenduty publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Incidents. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 1.1.0.

Requests are made against a single base URL, https://www.zenduty.com.

4 operations 4 paths 8 schemas 1 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.1.0
Base URL
https://www.zenduty.com/api
Authentication
HTTP Bearer
License
Apache 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Zenduty Incidents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Token ) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Incidents 4

This object represents the incidents of the account. You can checkout the incident docs here https://docs.zenduty.com/docs/incidents

POST
/api/incidents/filter/
List all Incident objects(filtered)
1 param body → 200400403404
POST
/api/incidents/
Create the Incident object
body → 201400403404
PATCH
/api/incidents/{unique_id}/
Update the Incident object
1 param body → 200400403404
GET
/api/incidents/{incident_number}/
Retrieve the Incident object
1 param → 200400403404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Incident (24 properties), IncidentFilterObject (19 properties), ServicePostPut (17 properties), IncidentFilterPayload (13 properties). Each schema is shown below with its type and property counts.

IncidentFilter
object
Incident filter object schema
4 properties
IncidentFilterPostmortemObject
object
Postmortem object schema
2 properties
IncidentFilterObject
object
Incident object schema
19 properties
IncidentFilterPayload
object
Payload schema for the Incident object
13 properties
IncidentPayload
object
Payload schema for the Incident object
8 properties 2 required
Incident
object
Incident object schema
24 properties
IncidentUpdatePayload
object
Payload schema for updating an Incident object. At least one parameter must be provided in the request body.
8 properties
ServicePostPut
object
Service object schema for Create and Update
17 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zenduty-incidents-api-openapi.yml Raw ↑

Other APIs Zenduty publishes across the network.

Zenduty REST API
Zenduty Events API
Zenduty Account Custom Role API
Zenduty Account Member API
Zenduty Alert Rules API
Zenduty Analytics API
Zenduty Contact Methods API
Zenduty Escalation Policies API
Zenduty Events API
Zenduty Forwarding Rules API
Zenduty Global Router API
Zenduty Global Router Rules API