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 Incident Roles API

This object represents the incident roles of an incident. You can checkout the incident role docs here https://docs.zenduty.com/docs/incidentroles

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

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

This API exposes 5 operations across 2 paths, and defines 3 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.

5 operations 2 paths 3 schemas 1 DELETE2 GET1 POST1 PUT

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 Incident Roles API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Token ) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

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

Incident Roles 5

This object represents the incident roles of an incident. You can checkout the incident role docs here https://docs.zenduty.com/docs/incidentroles

POST
/api/account/teams/{}/roles/
Create the Incident Role object
1 param body → 201400403404
GET
/api/account/teams/{}/roles/
List all Incident Role objects
1 param → 200400403404
GET
/api/account/teams/{team_id}/roles/{incident_role_id}/
Retrieve the Incident Role object
2 params → 200400403404
PUT
/api/account/teams/{team_id}/roles/{incident_role_id}/
Update the Incident Role object
2 params body → 200400403404
DELETE
/api/account/teams/{team_id}/roles/{incident_role_id}/
Delete the Incident Role object
2 params → 204400403404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are IncidentRoleGet (6 properties), IncidentRolePostPut (5 properties), IRPayload (3 properties). Each schema is shown below with its type and property counts.

IncidentRolePostPut
object
Incident Role object schema
5 properties
IRPayload
object
Payload schema for the Incident Role object
3 properties 1 required
IncidentRoleGet
object
Incident Role object schema
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zenduty-incident-roles-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