logo
redocly logoAPI docs by Redocly

Zenduty (1.1.0)

Download OpenAPI specification:Download

E-mail: vishwa@zenduty.com License: Apache 2.0 Terms of Service

Introduction

Zenduty is a cutting edge platform for incident management. With high level automation, Zenduty enables faster and better incident resolution keeping developers first.

Javascript Libraries: https://github.com/Zenduty/zenduty-js

Ruby Libraries: https://github.com/Zenduty/zenduty-ruby

Python Libraries: https://github.com/Zenduty/zenduty-python-sdk

Postman Collection for Zenduty API: https://github.com/Zenduty/zenduty-api-postman.git

Account-level roles and permissions: https://docs.zenduty.com/docs/users#account-level-roles-and-permissions

Team-level roles and permissions: https://docs.zenduty.com/docs/users#team-level-roles-and-permissions

Account Member

This object represents a user of the account. Each account member object has a role, which can be owner, admin, or user. Each account has a single owner, but the admins and users can be multiple.

Invite User

Returns an Account Member object.

Authorizations:
bearerAuth
Request Body schema:
required

Request body parameters to create the Account Member object

team
required
string

A system-generated string that represents the Team object's unique_id

required
object

User object schema

Responses

Request samples

Content type
{
  • "team": "db61f7ed-ba78-4536-9b2d-256b135a731d",
  • "user_detail": {
    }
}

Response samples

Content type
{
  • "unique_id": "e6931b6d-55d7-45e4-9f30-4dbf72bbcf06",
  • "team": "db61f7ed-ba78-4536-9b2d-256b135a731d",
  • "user": {
    },
  • "joining_date": "2022-09-20T14:29:05.997454Z",
  • "role": 2
}

List all Account Member objects

Returns a list of Account Member objects. The Account Member objects are sorted by joining_date, with the most recent Account Member object appearing last.

Authorizations:
bearerAuth

Responses

Response samples

Content type
[
  • {
    },
  • {
    },
  • {
    }
]

Retrieve the Account Member object

Retrieve the specified Account Member object.

Authorizations:
bearerAuth
path Parameters
username
required
string

A system-generated string that represents the User object's username

Responses

Response samples

Content type
{
  • "unique_id": "ab188a19-7f5c-4f6f-b7cd-d1bfa0725dcd",
  • "time_zone": "UTC",
  • "user": {
    },
  • "joining_date": "2022-07-08T10:32:42.191552Z",
  • "role": 2,
  • "is_verified": false
}

Update the Account Member object

Updates the specified Account Member object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
username
required
string

A system-generated string that represents the User object's username

Request Body schema:
required

Request body parameters to update the Account Member object

time_zone
string
Default: "UTC"

A formatted string that represents the Account Member object's time zone. You can check out the time zone list here https://timezonedb.com/time-zones

required
object (User)

User object schema

role
integer
Default: 3

An integer that represents the Account Member object's role. 1 is owner, 2 is admin and 3 is user

Responses

Request samples

Content type
{
  • "user": {
    },
  • "role": 2
}

Response samples

Content type
{
  • "unique_id": "49868e5e-aa68-471b-82e2-10b6238f42f6",
  • "time_zone": "UTC",
  • "user": {
    },
  • "joining_date": "2022-07-08T10:31:56.830785Z",
  • "role": 2,
  • "is_verified": false
}

Delete User

Delete the specified Account Member object

Authorizations:
bearerAuth
Request Body schema:
required

Request body parameters to create the Account Member object

username
required
string

A system-generated string that represents the User object's username

Responses

Request samples

Content type
{
  • "username": "6b2af4db-8b31-4bfb-9742-4"
}

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Account Custom Role

This object represents a custom role of the account. Each custom role object has custom permissions, which the account admin can set from account level permissions and assign this custom role to a particular user.

Create the Account Custom Role object

Create the Account Custom Role object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
Request Body schema:
required

Request body parameters to create the Account Custom Role object

name
string

A string that represents the unique name for Account Custom Role object

description
string

A string that represents the description for Account Custom Role object

permissions
required
Array of strings

An array of account level permissions

Responses

Request samples

Content type
{
  • "name": "Role 1",
  • "description": "Role 1 Description",
  • "permissions": [
    ]
}

Response samples

Content type
{
  • "unique_id": "97208d3e-e45d-409a-b951-4eae928a59b9",
  • "name": "Role 1",
  • "description": "Role 1 Description"
}

List all Account Custom Role objects

Returns a list of Account Custom Role objects.

Authorizations:
bearerAuth

Responses

Response samples

Content type
[
  • {
    },
  • {
    },
  • {
    }
]

Retrieve the Account Custom Role object

Retrieve the specified Account Custom Role object.

Authorizations:
bearerAuth
path Parameters
custom_role_id
required
string

unique_id of the Account Custom Role object

Responses

Response samples

Content type
{
  • "unique_id": "ddf61a4d-6489-4665-bee6-7e21205f9d6f",
  • "name": "Role 1 Updated",
  • "description": "Role 1 Description",
  • "permissions": [
    ]
}

Update the Account Custom Role object

Updates the specified Account Custom Role object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
custom_role_id
required
string

unique_id of the Account Custom Role object

Request Body schema:
required

Request body parameters to update the Account Custom Role object

name
string

A string that represents the unique name for Account Custom Role object

description
string

A string that represents the description for Account Custom Role object

permissions
required
Array of strings

An array of account level permissions

Responses

Request samples

Content type
{
  • "name": "Role Updated",
  • "permissions": [
    ]
}

Response samples

Content type
{
  • "unique_id": "ddf61a4d-6489-4665-bee6-7e21205f9d6f",
  • "name": "Role Updated",
  • "description": "Role 1 Description"
}

Delete the Account Custom Role object

Delete the specified Account Custom Role object permanently.

Authorizations:
bearerAuth
path Parameters
custom_role_id
required
string

unique_id of the Account Custom Role object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

User Custom Role

This object represents a user's custom role. Each user can be assigned to only one custom role.

Create the User Custom Role object

Create the User Custom Role object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
username
required
string

username of the User object

Request Body schema:
required

Request body parameters to create the User Custom Role object

custom_role
required
string

A system-generated string that represents the User Custom Role object's unique_id

Responses

Request samples

Content type
{
  • "custom_role": "ddf61a4d-6489-4665-bee6-7e21205f9d6f"
}

Response samples

Content type
{
  • "user": "6278fd1d-7e7c-486a-80e3-5",
  • "custom_role": "ddf61a4d-6489-4665-bee6-7e21205f9d6f",
  • "custom_role_details": {
    }
}

List all User Custom Role objects

Returns a list of User Custom Role objects.

Authorizations:
bearerAuth
path Parameters
username
required
string

username of the User object

Responses

Response samples

Content type
{
  • "user": "6278fd1d-7e7c-486a-80e3-5",
  • "custom_role": "ddf61a4d-6489-4665-bee6-7e21205f9d6f",
  • "custom_role_details": {
    }
}

Notification Rules

This object represents a user's notification rules. A user can have notification rules for high urgency and low urgency incidents.

Create the User Notification Rules object

Create the User Notification Rules object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
username
required
string

username of the User object

Request Body schema:
required

Request body parameters to create the User Notification Rule object

contact
required
string

A system-generated string that represents the User Contact Method object's unique_id

start_delay
integer

An integer that represents the User Notification Rules object's delay field in minutes.

urgency
integer

An integer that represents the User Notification Rules object's urgency field. 1 is for high urgency incidents and 0 is for low urgency incidents.

Responses

Request samples

Content type
{
  • "start_delay": 0,
  • "contact": "caabda03-5e15-4cf1-b293-fab41b688ac7",
  • "urgency": 1
}

Response samples

Content type
{
  • "creation_date": "2023-03-01T15:28:35.582391Z",
  • "start_delay": 0,
  • "type": "",
  • "unique_id": "3433edb5-f589-4227-baa5-a6646d93e76b",
  • "contact": "caabda03-5e15-4cf1-b293-fab41b688ac7",
  • "urgency": 1
}

List all Users' Notification Rule objects

Returns a list of User Notification Rule objects.

Authorizations:
bearerAuth
path Parameters
username
required
string

username of the User object

Responses

Response samples

Content type
[
  • {
    },
  • {
    },
  • {
    }
]

Retrieve the User Notification Rule object

Retrieve the specified User's Notification Rule object.

Authorizations:
bearerAuth
path Parameters
username
required
string

username of the User object

notification_rule_id
required
string

unique_id of the User Notification Rule object

Responses

Response samples

Content type
{
  • "creation_date": "2023-03-01T15:20:45.565595Z",
  • "start_delay": 5,
  • "type": "",
  • "unique_id": "1d757ec0-39d3-4cd0-9536-7e0bb3e2665c",
  • "contact": "374d3e48-b4bd-438d-8e18-d69ddeadd183",
  • "urgency": 1
}

Delete the User Notification Rules object

Delete the specified User Notification Rules object permanently.

Authorizations:
bearerAuth
path Parameters
username
required
string

username of the User object

notification_rule_id
required
string

unique_id of the User Notification Rule object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Forwarding Rules

This object represents a user's forwarding rules. A user can forward his notifications to the other account members in case an incident occurs.

Create the User Forwarding Rules object

Create the User's Forwarding Rules object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
username
required
string

username of the User object

Request Body schema:
required

Request body parameters to create the User Forwarding Rules object

from_date
required
string <date-time>

A formatted string that represents the User Forwarding Rule object's from_date field

to_date
required
string <date-time>

A formatted string that represents the User Forwarding Rule object's to_date field

time_zone
string

A formatted string that represents the User Forwarding Rule object's time zone. You can check out the time zone list here https://timezonedb.com/time-zones

to_user
required
string

A system-generated string that represents the User object's username

Responses

Request samples

Content type
{
  • "from_date": "2023-03-01T16:37:58.654Z",
  • "to_date": "2023-03-01T16:37:58.654Z",
  • "time_zone": "UTC",
  • "to_user": "7e26fed1-f11c-4e78-afc6-a"
}

Response samples

Content type
{
  • "creation_date": "2023-03-01T16:43:00.031310Z",
  • "unique_id": "8bd02ac2-07fe-4d32-a37f-e1def9673746",
  • "time_zone": "UTC",
  • "from_date": "2023-03-01T16:37:58.654000Z",
  • "to_date": "2023-03-01T16:37:58.654000Z",
  • "to_user": "7e26fed1-f11c-4e78-afc6-a",
  • "created_by": "7e26fed1-f11c-4e78-afc6-a",
  • "user": "4f9f41eb-4252-462e-9e33-6"
}

List all User Forwarding Rule objects

Returns a list of User Forwarding Rule objects.

Authorizations:
bearerAuth
path Parameters
username
required
string

username of the User object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the User Forwarding Rules object

Retrieve the specified User's Forwarding Rules object.

Authorizations:
bearerAuth
path Parameters
username
required
string

username of the User object

forwarding_rule_id
required
string

unique_id of the User Forwarding Rules object

Responses

Response samples

Content type
{
  • "creation_date": "2023-03-01T16:38:22.540374Z",
  • "unique_id": "a6011d7c-3a44-4cab-8580-a410881f4ff9",
  • "time_zone": "UTC",
  • "from_date": "2023-03-01T16:37:58.654000Z",
  • "to_date": "2023-03-01T16:37:58.654000Z",
  • "to_user": "7e26fed1-f11c-4e78-afc6-a",
  • "created_by": "7e26fed1-f11c-4e78-afc6-a",
  • "user": "4f9f41eb-4252-462e-9e33-6"
}

Delete the User Forwarding Rule object

Delete the specified User's Forwarding Rules object permanently.

Authorizations:
bearerAuth
path Parameters
username
required
string

username of the User object

forwarding_rule_id
required
string

unique_id of the User Forwarding Rules object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Contact Methods

This object represents one of the following communication channels(Email, SMS, Phone Call, Slack, Microsoft Team, Google Chat). A user can add multiple contacts methods.

Create the User Contact Methods object

Create the User Contact Methods object by setting the values of all the required parameters passed in the request body. A user can only create email Contact Methods through API.

Authorizations:
bearerAuth
path Parameters
username
required
string

username of the User object

Request Body schema:
required

Request body parameters to create the User Contact Methods object

name
required
string

A string that represents the User Contact Method object's name field

value
required
string

A formatted string that represents the User Contact Method object's value field. value can be Email ID, Phone Number, Slack ID, Microsoft ID, Google Chat ID.

contact_type
required
integer

An integer that represents the User Contact Method object's contact_type field. 1 is for Email, 2 is for SMS, 3 is for Phone Call, 4 is for Slack, 5 is for MS Teams and 6 is for Google Chat

Responses

Request samples

Content type
{
  • "name": "Secondary Email",
  • "value": "anshulrajput229@gmail.com",
  • "contact_type": 1
}

Response samples

Content type
{
  • "name": "Secondary Email",
  • "creation_date": "2023-03-02",
  • "contact_type": 1,
  • "value": "anshulrajput229@gmail.com",
  • "unique_id": "8a862f18-9332-4d08-90ad-06c070803c05"
}

List all User Contact Method objects

Returns a list of User Contact Method objects.

Authorizations:
bearerAuth
path Parameters
username
required
string

username of the User object

Responses

Response samples

Content type
[
  • {
    },
  • {
    },
  • {
    }
]

Retrieve the User Contact Methods object

Retrieve the specified User's Contact Methods object.

Authorizations:
bearerAuth
path Parameters
username
required
string

username of the User object

contact_id
required
string

unique_id of the User Contact Methods object

Responses

Response samples

Content type
{
  • "name": "Primary Email",
  • "creation_date": "2023-02-14",
  • "contact_type": 1,
  • "value": "user@three.com",
  • "unique_id": "374d3e48-b4bd-438d-8e18-d69ddeadd183"
}

Delete the User Contact Methods object

Delete the specified User's Contact Methods object permanently.

Authorizations:
bearerAuth
path Parameters
username
required
string

username of the User object

contact_id
required
string

unique_id of the User Contact Methods object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Teams

This object represents a team of the account. It lets you create different independent operational units in the account. You can check out the team docs here https://docs.zenduty.com/docs/teams.

Create the Team object

Create the Team object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
Request Body schema:
required

Request body parameters to create the Team object

name
required
string

A that represents the Team object's name

Responses

Request samples

Content type
{
  • "name": "Production Team"
}

Response samples

Content type
{
  • "unique_id": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "name": "Production Team",
  • "account": "0713dc12-40b0-46ff-b0f9-c6b126399277",
  • "creation_date": "2022-07-08",
  • "members": [
    ],
  • "owner": "216bba3d-7268-4a8e-89e9-6",
  • "roles": [
    ]
}

List all Team objects

Returns a list of Team objects. The Team objects are sorted by creation_date, with the most recent Team object appearing last.

Authorizations:
bearerAuth

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the Team object

Retrieve the specified Team object.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Responses

Response samples

Content type
{
  • "unique_id": "1f1b4d79-ed32-44fc-926d-f794b975200c",
  • "name": "Operation Team",
  • "account": "0713dc12-40b0-46ff-b0f9-c6b126399277",
  • "creation_date": "2022-07-08",
  • "members": [
    ],
  • "owner": "216bba3d-7268-4a8e-89e9-6",
  • "roles": [
    ]
}

Update the Team object

Updates the specified Team object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Request Body schema:
required

Request body parameters to update the Team object

name
required
string

A that represents the Team object's name

Responses

Request samples

Content type
{
  • "name": "Modified Production Team"
}

Response samples

Content type
{
  • "unique_id": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "name": "Modified Production Team",
  • "account": "0713dc12-40b0-46ff-b0f9-c6b126399277",
  • "creation_date": "2022-07-08",
  • "members": [
    ],
  • "owner": "216bba3d-7268-4a8e-89e9-6",
  • "roles": [
    ]
}

Delete the Team object

Delete the specified Team object permanently.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Team Members

This object represents the users of a team. Each team member has a role which can be a manager or a user. You can checkout the team member docs here https://docs.zenduty.com/docs/users

Add user to Team

Create the Team Member object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Request Body schema:
required

Request body parameters to create the Team Member object

user
required
string

A string that represents the User's username

role
integer
Default: 2

An integer that represents the Team Member object's role. 1 is manager and 2 is user

Responses

Request samples

Content type
{
  • "user": "507dfda0-a1fd-40e5-943a-e"
}

Response samples

Content type
{
  • "unique_id": "828e4a7b-bb12-4ffc-baa5-7681634d4f7f",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "user": "507dfda0-a1fd-40e5-943a-e",
  • "joining_date": "2022-07-08T11:09:38.230395Z",
  • "role": 2
}

List all Team Member objects

Returns a list of Team Member objects. The Team Member objects are sorted by joining_date, with the most recent Team Member object appearing last.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the Team Member object

Retrieve the specified Team Member object.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

member_id
required
string

unique_id of the Team Member object

Responses

Response samples

Content type
{
  • "unique_id": "828e4a7b-bb12-4ffc-baa5-7681634d4f7f",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "user": {
    },
  • "joining_date": "2022-07-08T11:09:38.230395Z",
  • "role": 2
}

Update the Team Member object

Updates the specified Team Member object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

member_id
required
string

unique_id of the Team Member object

Request Body schema:
required

Request body parameters to update the Team Member object

user
required
string

A string that represents the User's username

role
integer
Default: 2

An integer that represents the Team Member object's role. 1 is manager and 2 is user

Responses

Request samples

Content type
{
  • "user": "507dfda0-a1fd-40e5-943a-e",
  • "role": 1
}

Response samples

Content type
{
  • "unique_id": "828e4a7b-bb12-4ffc-baa5-7681634d4f7f",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "user": "507dfda0-a1fd-40e5-943a-e",
  • "joining_date": "2022-07-08T11:09:38.230395Z",
  • "role": 1
}

Delete the Team Member object

Delete the specified Team Member object permanently.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

member_id
required
string

unique_id of the Team Member object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Team Permissions

This object represents the permissions of a team. It lets you access the particular team elements that the team has given permissions to use.

Retrieve Team Permission object

Returns a particular Team Permission object.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Responses

Response samples

Content type
{
  • "unique_id": "5f9a92c2-ddf2-4e71-862c-b4bbe959df24",
  • "account_permissions": [
    ]
}

Update the Team Permission object

Update the Team Permission object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Request Body schema:
required

Request body parameters to update the Team Permission object

account_permissions
required
Array of strings

An array of team level permissions

Responses

Request samples

Content type
{
  • "account_permissions": [
    ]
}

Response samples

Content type
{
  • "unique_id": "5f9a92c2-ddf2-4e71-862c-b4bbe959df24",
  • "account_permissions": [
    ]
}

Schedules

This object represents the schedule of a team. You can checkout the schedule docs here https://docs.zenduty.com/docs/schedules

Create the Schedule object

Create the Schedule object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Request Body schema:
required

Request body parameters to create the Schedule object

name
required
string

A string that represents the Schedule object's name

summary
string

A string that represents the Schedule object's summary

description
string

A string that represents the Schedule object's description

time_zone
string

A formatted string that represents the Schedule object's time zone. You can check out the time zone list here https://timezonedb.com/time-zones

Array of objects (ScheduleLayerPayload)

An array of Schedule Layer objects

Array of objects (ScheduleOverridePayload)

An array of Schedule Overrides objects

Responses

Request samples

Content type
{
  • "name": "Daily Schedule",
  • "summary": "Daily on call schedule for modified production team",
  • "time_zone": "Asia/Kolkata"
}

Response samples

Content type
{
  • "name": "Daily Schedule",
  • "summary": "Daily on call schedule for modified production team",
  • "description": "",
  • "time_zone": "Asia/Kolkata",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "layers": [ ],
  • "overrides": [ ],
  • "unique_id": "dadcec8e-e4d7-4e76-8a24-d8d6c1278d1f"
}

List all Schedule objects

Returns a list of Schedule objects.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the Schedule object

Retrieve the specified Schedule object.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

schedule_id
required
string

unique_id of the Schedule object

Responses

Response samples

Content type
{
  • "name": "Weekly Schedule",
  • "summary": "Weekly on call schedule for modified production team.",
  • "description": "",
  • "time_zone": "Asia/Calcutta",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "layers": [
    ],
  • "overrides": [
    ],
  • "unique_id": "4a3025f3-836f-4d18-8923-7adfe5690d17"
}

Update the Schedule object

Updates the specified Schedule object by setting the values of the parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

schedule_id
required
string

unique_id of the Schedule object

Request Body schema:
required

Schedule update payload

name
required
string

A string that represents the Schedule object's name

summary
string

A string that represents the Schedule object's summary

description
string

A string that represents the Schedule object's description

time_zone
string

A formatted string that represents the Schedule object's time zone. You can check out the time zone list here https://timezonedb.com/time-zones

Array of objects (ScheduleLayerPayload)

An array of Schedule Layer objects

Array of objects (ScheduleOverridePayload)

An array of Schedule Overrides objects

Responses

Request samples

Content type
{
  • "name": "Modified weekly Schedule"
}

Response samples

Content type
{
  • "name": "Modified daily Schedule",
  • "summary": "Daily on call schedule for modified production team",
  • "description": "",
  • "time_zone": "Asia/Kolkata",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "layers": [ ],
  • "overrides": [ ],
  • "unique_id": "dadcec8e-e4d7-4e76-8a24-d8d6c1278d1f"
}

Delete the Schedule object

Delete the specified Schedule object permanently.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

schedule_id
required
string

unique_id of the Schedule object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Schedule Overrides

This object represents the Override of a Schedule. You can checkout the Schedule Override docs here https://docs.zenduty.com/docs/schedules/#schedule-override

Create the Schedule Override object

Create the Schedule Override object by setting the values of all the required parameters passed in the request body. (Note - Rate limits are 1/sec and 20/minute)

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

schedule_id
required
string

unique_id of the Schedule object

Request Body schema:
required

Request body parameters to create the Schedule Overrides object

name
string

A string that represents the Schedule Overrides object's name

user
string

A string that represents the User object's username

start_time
string

A fromatted string that represents the Schedule Overrides object's start_time

end_time
string

A fromatted string that represents the Schedule Overrides object's end_time

Responses

Request samples

Content type
{
  • "name": "Override for Michael",
  • "user": "507dfda0-a1fd-40e5-943a-e",
  • "start_time": "2022-07-09T05:57:14Z",
  • "end_time": "2022-07-10T05:57:14Z"
}

Response samples

Content type
{
  • "name": "Override for Michael",
  • "user": "507dfda0-a1fd-40e5-943a-e",
  • "start_time": "2022-07-09T05:57:14Z",
  • "end_time": "2022-07-10T05:57:14Z",
  • "unique_id": "b4492ce7-7d6e-4ed1-8f41-e7c8bf4f4dfe"
}

List all Schedule overrides objects

Returns a list of Schedule override objects with overridden users and their respective start and end times. refer to overridden_details object key (Note - Rate limits are 1/sec and 20/minute)

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

schedule_id
required
string

unique_id of the Schedule object

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Escalation Policies

This object represents the escalation policy of a team. You can checkout the escalation policy docs here https://docs.zenduty.com/docs/escalationpolicies

Create the Escalation Policy object

Create the Escalation Policy object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Request Body schema:
required

Request body parameters to create the Escalation Policy object

name
required
string

A string that represents the Escalation Policy object's name

summary
string

A string that represents the Escalation Policy object's summary

description
string

A string that represents the Escalation Policy object's description

required
object (EP_RulePayload)

Escalation Policy Rule Payload object schema

Responses

Request samples

Content type
{
  • "name": "Production Escalation Policy",
  • "rules": [
    ]
}

Response samples

Content type
{
  • "name": "Production Escalation Policy",
  • "summary": "",
  • "description": "",
  • "rules": [
    ],
  • "unique_id": "904cfcad-9fe1-4dc7-b578-ad0f5a2950fd",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "repeat_policy": 0,
  • "move_to_next": true,
  • "global_ep": false
}

List all Escalation Policy objects

Returns a list of Escalation Policy objects.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Responses

Response samples

Content type
[
  • {
    },
  • {
    },
  • {
    }
]

Retrieve the Escalation Policy object

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

escalation_policy_id
required
string

unique_id of the Escalation Policy object

Responses

Response samples

Content type
{
  • "name": "Production Escalation Policy",
  • "summary": "",
  • "description": "",
  • "rules": [
    ],
  • "unique_id": "904cfcad-9fe1-4dc7-b578-ad0f5a2950fd",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "repeat_policy": 0,
  • "move_to_next": true,
  • "global_ep": false
}

Update the Escalation Policy object

Updates the specified Escalation Policy object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

escalation_policy_id
required
string

unique_id of the Escalation Policy object

Request Body schema: application/json
required

Request body parameters to update the Escalation Policy object

name
required
string

A string that represents the Escalation Policy object's name

summary
string

A string that represents the Escalation Policy object's summary

description
string

A string that represents the Escalation Policy object's description

required
object (EP_RulePayload)

Escalation Policy Rule Payload object schema

Responses

Request samples

Content type
application/json
{
  • "name": "Modified Production Escalation Policy",
  • "rules": [
    ]
}

Response samples

Content type
{
  • "name": "Modified Production Escalation Policy",
  • "summary": "",
  • "description": "",
  • "rules": [
    ],
  • "unique_id": "904cfcad-9fe1-4dc7-b578-ad0f5a2950fd",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "repeat_policy": 0,
  • "move_to_next": true,
  • "global_ep": false
}

Delete the Escalation Policy object

Delete the specified Escalation Policy object permanently.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

escalation_policy_id
required
string

unique_id of the Escalation Policy object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Services

This object represents the services associated with a team. You can checkout the services docs here https://docs.zenduty.com/docs/services

Create the Service object

Create the Service object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Request Body schema:
required

Request body parameters to create the Service object

name
string

A string that represents the Service object's name

summary
string

A string that represents the Service object's summary

description
string

A string that represents the Service object's description

auto_resolve_timeout
integer
Default: 0

An integer that represents the timeout for automatically resolving an Incident

team_priority
required
string

A system-generated string that represents the Priority object's unique_id

task_template
string

A system-generated string that represents the Task Template object's unique_id

acknowledgement_timeout_enabled
boolean
Default: false

An boolean flag that represents whether a service has acknowledgement timeout is enabled. If true, the "acknowledgement_timeout" field value needs to be set

acknowledgement_timeout
integer
Default: 600

An integer that represents the acknowledgement timeout value in seconds. If an incident is acknowledged and unresolved within this time window, the incident will be retriggered. This value must be above 600 seconds.

status
integer
Default: 1

An integer that represents the Service object's status 0 is disabled, 1 is active, 2 is a warning, 3 is critical, and 4 is under maintenance

escalation_policy
required
string

A system-generated string that represents the Escalation Policy object's unique_id

sla
required
string

A system-generated string that represents the SLA object's unique_id

under_maintenance
boolean
Default: false

A boolean flag that represents whether the service object is under maintenance or not

collation
integer
Default: 0

An integer that represents the Service object's collation type. 0 is off, 1 is time-based.

collation_time
integer
Default: 0

An integer that represents the Service object's collation_time. When collation is turned on it needs to be greater than 1 minute & less than 1440 minutes.

Responses

Request samples

Content type
{
  • "name": "Production Service",
  • "description": "This is the description for Production Service",
  • "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329",
  • "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032",
  • "status": 1,
  • "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44",
  • "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c"
}

Response samples

Content type
{
  • "name": "Production Service",
  • "creation_date": "2022-07-08T12:38:50.511179Z",
  • "summary": "",
  • "description": "This is the description for Production Service",
  • "unique_id": "3605fdfb-07fb-4a6c-bd05-9e557dc4ec6e",
  • "auto_resolve_timeout": 0,
  • "created_by": "216bba3d-7268-4a8e-89e9-6",
  • "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329",
  • "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032",
  • "acknowledgement_timeout": 0,
  • "acknowledgement_timeout_enabled": false,
  • "status": 1,
  • "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c",
  • "collation_time": 0,
  • "collation": 0,
  • "under_maintenance": false
}

List all Service objects

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the Service object

Retrieve the specified Service object.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

service_id
required
string

unique_id of the Service object

Responses

Response samples

Content type
{
  • "name": "Production Service",
  • "creation_date": "2022-07-08T12:38:50.511179Z",
  • "summary": "",
  • "description": "This is the description for Production Service",
  • "unique_id": "3605fdfb-07fb-4a6c-bd05-9e557dc4ec6e",
  • "auto_resolve_timeout": 0,
  • "created_by": "216bba3d-7268-4a8e-89e9-6",
  • "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329",
  • "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032",
  • "acknowledgement_timeout": 0,
  • "acknowledgement_timeout_enabled": false,
  • "status": 1,
  • "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c",
  • "under_maintenance": false,
  • "collation": 0,
  • "collation_time": 0
}

Update the Service object

Updates the specified Service object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

service_id
required
string

unique_id of the Service object

Request Body schema:
required

Request body parameters to update the Service object

name
string

A string that represents the Service object's name

summary
string

A string that represents the Service object's summary

description
string

A string that represents the Service object's description

auto_resolve_timeout
integer
Default: 0

An integer that represents the timeout for automatically resolving an Incident

team_priority
required
string

A system-generated string that represents the Priority object's unique_id

task_template
string

A system-generated string that represents the Task Template object's unique_id

acknowledgement_timeout_enabled
boolean
Default: false

An boolean flag that represents whether a service has acknowledgement timeout is enabled. If true, the "acknowledgement_timeout" field value needs to be set

acknowledgement_timeout
integer
Default: 600

An integer that represents the acknowledgement timeout value in seconds. If an incident is acknowledged and unresolved within this time window, the incident will be retriggered. This value must be above 600 seconds.

status
integer
Default: 1

An integer that represents the Service object's status 0 is disabled, 1 is active, 2 is a warning, 3 is critical, and 4 is under maintenance

escalation_policy
required
string

A system-generated string that represents the Escalation Policy object's unique_id

sla
required
string

A system-generated string that represents the SLA object's unique_id

under_maintenance
boolean
Default: false

A boolean flag that represents whether the service object is under maintenance or not

collation
integer
Default: 0

An integer that represents the Service object's collation type. 0 is off, 1 is time-based.

collation_time
integer
Default: 0

An integer that represents the Service object's collation_time. When collation is turned on it needs to be greater than 1 minute & less than 1440 minutes.

Responses

Request samples

Content type
{
  • "name": "Modified Production Service",
  • "description": "This is the description for Production Service",
  • "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329",
  • "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032",
  • "status": 1,
  • "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44",
  • "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c"
}

Response samples

Content type
{
  • "name": "Modified Production Service",
  • "creation_date": "2022-07-08T12:38:50.511179Z",
  • "summary": "",
  • "description": "This is the description for Production Service",
  • "unique_id": "3605fdfb-07fb-4a6c-bd05-9e557dc4ec6e",
  • "auto_resolve_timeout": 0,
  • "created_by": "216bba3d-7268-4a8e-89e9-6",
  • "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329",
  • "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032",
  • "acknowledgement_timeout": 0,
  • "status": 1,
  • "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c",
  • "collation_time": 0,
  • "collation": 0,
  • "under_maintenance": false
}

Delete the Service object

Delete the specified Service object permanently.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

service_id
required
string

unique_id of the Service object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Integrations

This object represents the integrations associated with a service. You can checkout the integration docs here https://docs.zenduty.com/docs/integrations

Create the Integration object

Create the Integration object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

service_id
required
string

unique_id of the Service object

Request Body schema:
required

Request body parameters to create the Integration object

name
string

A string that represents the Integration object's name

summary
string

A string that represents the Integration object's summary

application
required
string

A system-generated string that represents the Application object's unique_id. To get application id, vist https://www.zenduty.com/api/account/applications/ and get unique_id of the application.

is_enabled
boolean
Default: true

A boolean flag that represents whether an Integration is enabled or not

create_incidents_for
integer
Default: 1

An integer that represents the type of the Incidents this Integration object will create. 0 is do not create incidents. 1 is critical, 2 is critical and errors, and 3 is critical, errors and warnings.

integration_type
integer
Default: 0

An integer that represents the Integration object's integration_type. 0 is alert and 1 is outbound.

default_urgency
integer
Default: 1

An integer that represents the Integration object's default_urgency. 0 is low and 1 is high.

Responses

Request samples

Content type
{
  • "name": "Infra custom Integration",
  • "summary": "This is the summary for Infra custom Integration",
  • "application": "07c84d47-7e71-49ec-b781-1cc81a78086e"
}

Response samples

Content type
{
  • "name": "Infra custom Integration",
  • "creation_date": "2022-07-08T12:52:22.906327Z",
  • "summary": "This is the summary for Infra custom Integration",
  • "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd",
  • "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f",
  • "application": "07c84d47-7e71-49ec-b781-1cc81a78086e",
  • "application_reference": {
    },
  • "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645",
  • "created_by": "216bba3d-7268-4a8e-89e9-6",
  • "is_enabled": true,
  • "create_incidents_for": 1,
  • "integration_type": 0,
  • "default_urgency": 1,
  • "webhook_url": "https://www.zenduty.com/api/integration/cloudwatch_v2/5f306dae-b327-4ba9-8f3a-ab4cffd57645/"
}

List all Integration objects

Returns a list of Integration objects. The Integration objects are sorted by creation_date, with the most recent Integration object appearing last.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

service_id
required
string

unique_id of the Service object

Responses

Response samples

Content type
[
  • {
    },
  • {
    },
  • {},
  • {
    },
  • {
    }
]

Retrieve the Integration object

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

service_id
required
string

unique_id of the Service object

integration_id
required
string

unique_id of the Integration object

Responses

Response samples

Content type
{
  • "name": "Infra custom Integration",
  • "creation_date": "2022-07-08T12:52:22.906327Z",
  • "summary": "This is the summary for Infra custom Integration",
  • "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd",
  • "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f",
  • "application": "07c84d47-7e71-49ec-b781-1cc81a78086e",
  • "application_reference": {
    },
  • "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645",
  • "created_by": "216bba3d-7268-4a8e-89e9-6",
  • "is_enabled": true,
  • "create_incidents_for": 1,
  • "integration_type": 0,
  • "default_urgency": 1,
  • "webhook_url": "https://www.zenduty.com/api/integration/cloudwatch_v2/5f306dae-b327-4ba9-8f3a-ab4cffd57645/"
}

Update the Integration object

Updates the specified Integration object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

service_id
required
string

unique_id of the Service object

integration_id
required
string

unique_id of the Integration object

Request Body schema: application/json
required

Request body parameters to update the Integration object

name
string

A string that represents the Integration object's name

summary
string

A string that represents the Integration object's summary

application
required
string

A system-generated string that represents the Application object's unique_id. To get application id, vist https://www.zenduty.com/api/account/applications/ and get unique_id of the application.

is_enabled
boolean
Default: true

A boolean flag that represents whether an Integration is enabled or not

create_incidents_for
integer
Default: 1

An integer that represents the type of the Incidents this Integration object will create. 0 is do not create incidents. 1 is critical, 2 is critical and errors, and 3 is critical, errors and warnings.

integration_type
integer
Default: 0

An integer that represents the Integration object's integration_type. 0 is alert and 1 is outbound.

default_urgency
integer
Default: 1

An integer that represents the Integration object's default_urgency. 0 is low and 1 is high.

Responses

Request samples

Content type
application/json
{
  • "name": "Modified Infra custom Integration",
  • "application": "07c84d47-7e71-49ec-b781-1cc81a78086e"
}

Response samples

Content type
{
  • "name": "Modified Infra custom Integration",
  • "creation_date": "2022-07-08T12:52:22.906327Z",
  • "summary": "This is the summary for Infra custom Integration",
  • "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd",
  • "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f",
  • "application": "07c84d47-7e71-49ec-b781-1cc81a78086e",
  • "application_reference": {
    },
  • "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645",
  • "created_by": "216bba3d-7268-4a8e-89e9-6",
  • "is_enabled": true,
  • "create_incidents_for": 1,
  • "integration_type": 0,
  • "default_urgency": 1,
  • "webhook_url": "https://www.zenduty.com/api/integration/cloudwatch_v2/5f306dae-b327-4ba9-8f3a-ab4cffd57645/"
}

Delete the Integration object

Delete the specified Integration object permanently

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

service_id
required
string

unique_id of the Service object

integration_id
required
string

unique_id of the Integration object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Regenerate the Integration key

Regenerates the integration key.

Authorizations:
bearerAuth
Request Body schema: application/json
required

The integration's unique ID

integration_unique_id
string

A string that represents the relevant Integration's unique ID

Responses

Request samples

Content type
application/json
{
  • "integration_unique_id": "84753076-129d-4706-a957-a7c751ca7ab1"
}

Response samples

Content type
{
  • "name": "AWS GuardDuty",
  • "creation_date": "2024-07-01T10:16:32.036085Z",
  • "summary": "AWS GuardDuty Integration",
  • "unique_id": "84753076-129d-4706-a957-a7c751ca7ab1",
  • "service": "34da0237-9825-454a-9297-3a23a4b78795",
  • "application": "bb399bc6-9098-4afd-91d7-3cec4d8282eb",
  • "application_reference": {},
  • "integration_key": "c89e320f-a975-47e4-8437-1169e91eeed7",
  • "created_by": "39569d4b-6540-4b64-a086-6",
  • "is_enabled": true,
  • "create_incidents_for": 1,
  • "integration_type": 0,
  • "default_urgency": 1,
  • "webhook_url": "https://www.zenduty.com/api/integration/guardduty/c89e320f-a975-47e4-8437-1169e91eeed7/"
}

Incidents

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

List all Incident objects(filtered)

Returns a list of filtered Incident objects. The Incident objects are sorted by creation_date, with the most recent Incident object appearing last. for pagination please use 'next' and 'previous' links in the response.

Authorizations:
bearerAuth
query Parameters
page
integer

pagination page number. example - page=1

Request Body schema:
required

Request body parameters to filter the Incident objects

all_teams
integer
Default: 1

This query parameter can be 0 or 1. To filter incidents based on all teams use 1 and to filter incidents based on the teams the requesting user belongs to, use 0. example - all_teams=1

escalation_policy_ids
Array of strings

A list of escalation policy unique ids

from_date
string
Default: []

Represents from_date and filters incidents whose creation_date is greater than the specified from_date. example - from_date="2023-02-01"

postmortem_filter
integer
Default: -1

An integer that represents weather the postmortem is attached to the incident or not

priority_ids
Array of strings

A list of Team Priority unique ids

priority_name
string

Name of the Team priroty object

service_ids
Array of strings

A list of Service unique ids

sla_ids
Array of strings

A list of Team SLA unique ids

status
integer
Default: 1

Status of the Incident object. For open incidents(triggered and acknowledged) use -1, for all incidents(triggered, acknowledged and resolved) use 0, for triggered incidents use 1, for acknowledged incidents use 2 and for resolved incidents use 3. example - status=1

tag_ids
Array of strings

A list of Team Tag unique ids

team_ids
Array of strings

A list of Team unique ids

to_date
string
Default: []

Represents to_date and filters incidents whose creation_date is lesser than the specified to_date. example - to_date="2023-02-01"

user_ids
Array of strings

A list of User usernames

Responses

Request samples

Content type
{
  • "status": 1,
  • "team_ids": [
    ],
  • "all_teams": 1,
  • "service_ids": [
    ],
  • "user_ids": [
    ],
  • "priority_name": "",
  • "priority_ids": [
    ],
  • "tag_ids": [
    ],
  • "sla_ids": [
    ],
  • "from_date": [ ],
  • "to_date": [ ],
  • "postmortem_filter": -1,
  • "escalation_policy_ids": [
    ]
}

Response samples

Content type
{
  • "next": "https://www.zenduty.com/api/incidents/filter/?page=4&page_size=10",
  • "previous": "https://www.zenduty.com/api/incidents/filter/?page=2&page_size=10",
  • "results": [
    ]
}

Create the Incident object

Create the Incident object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
Request Body schema:
required

Request body parameters to create the Incident object

summary
string

A string that represents the Incident object's summary

status
integer
Default: 1

An integer that represents the Incident object's status. 1 is triggered, 2 is acknowledged and 3 is resolved

title
required
string

A string that represents the Incident object's title

service
required
string

A system-generated string that represents the Service object's unique_id

assigned_to
string

A system-generated string that represents the User object's username

escalation_policy
string

A system-generated string that represents the Escalation Policy object's unique_id

sla
string

A system-generated string that represents the SLA object's unique_id

team_priority
string

A system-generated string that represents the Priority object's unique_id

Responses

Request samples

Content type
{
  • "title": "Production Incident",
  • "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f"
}

Response samples

Content type
{
  • "summary": "",
  • "incident_number": 3,
  • "creation_date": "2022-07-08T13:21:25.846623Z",
  • "status": 1,
  • "unique_id": "uJVWfdAeoPDm3pk2gG2URn",
  • "service_object": {
    },
  • "title": "Production Incident",
  • "incident_key": "Q5NmEbsgc4ZjLknsw97VZJ",
  • "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f",
  • "urgency": 1,
  • "merged_with": null,
  • "assigned_to": null,
  • "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44",
  • "escalation_policy_object": {
    },
  • "assigned_to_name": "",
  • "resolved_date": null,
  • "acknowledged_date": null,
  • "context_window_start": null,
  • "context_window_end": null,
  • "tags": [ ],
  • "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c",
  • "sla_object": {
    },
  • "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329",
  • "team_priority_object": {
    }
}

Update the Incident object

Updates the specified Incident object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
unique_id
required
string

A system-generated string that represents the Incident object's unique ID

Request Body schema:
optional

Request body parameters to update the Incident object

summary
string

A string that represents the Incident object's summary

status
integer
Default: 1

An integer that represents the Incident object's status. 1 is triggered, 2 is acknowledged and 3 is resolved

title
required
string

A string that represents the Incident object's title

service
required
string

A system-generated string that represents the Service object's unique_id

assigned_to
string

A system-generated string that represents the User object's username

escalation_policy
string

A system-generated string that represents the Escalation Policy object's unique_id

sla
string

A system-generated string that represents the SLA object's unique_id

team_priority
string

A system-generated string that represents the Priority object's unique_id

Responses

Request samples

Content type
{
  • "status": 2
}

Response samples

Content type
{
  • "summary": "",
  • "incident_number": 3,
  • "creation_date": "2022-07-08T13:21:25.846623Z",
  • "status": 2,
  • "unique_id": "uJVWfdAeoPDm3pk2gG2URn",
  • "service_object": {
    },
  • "title": "Modified Production Incident",
  • "incident_key": "Q5NmEbsgc4ZjLknsw97VZJ",
  • "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f",
  • "urgency": 1,
  • "merged_with": null,
  • "assigned_to": "507dfda0-a1fd-40e5-943a-e",
  • "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44",
  • "escalation_policy_object": {
    },
  • "assigned_to_name": "Mary Jane",
  • "resolved_date": null,
  • "acknowledged_date": null,
  • "context_window_start": null,
  • "context_window_end": null,
  • "tags": [ ],
  • "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c",
  • "sla_object": {
    },
  • "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329",
  • "team_priority_object": {
    }
}

Incidents (Deprecated)

These endpoints are deprecated and will no longer receive maintenance. Please use the new endpoints, which utilize the Incident ID.

Retrieve the Incident object Deprecated

Retrieves the specified Incident object.

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

incident_number of the Incident object

Responses

Response samples

Content type
{
  • "summary": "",
  • "incident_number": 3,
  • "creation_date": "2022-07-08T13:21:25.846623Z",
  • "status": 1,
  • "unique_id": "uJVWfdAeoPDm3pk2gG2URn",
  • "service_object": {
    },
  • "title": "Production Incident",
  • "incident_key": "Q5NmEbsgc4ZjLknsw97VZJ",
  • "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f",
  • "urgency": 1,
  • "merged_with": null,
  • "assigned_to": "507dfda0-a1fd-40e5-943a-e",
  • "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44",
  • "escalation_policy_object": {
    },
  • "assigned_to_name": "Mary Jane",
  • "resolved_date": null,
  • "acknowledged_date": null,
  • "context_window_start": null,
  • "context_window_end": null,
  • "tags": [ ],
  • "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c",
  • "sla_object": {
    },
  • "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329",
  • "team_priority_object": {
    }
}

Update the Incident object Deprecated

Updates the specified Incident object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

incident_number of the Incident object

Request Body schema:
required

Request body parameters to update the Incident object

summary
string

A string that represents the Incident object's summary

status
integer
Default: 1

An integer that represents the Incident object's status. 1 is triggered, 2 is acknowledged and 3 is resolved

title
required
string

A string that represents the Incident object's title

service
required
string

A system-generated string that represents the Service object's unique_id

assigned_to
string

A system-generated string that represents the User object's username

escalation_policy
string

A system-generated string that represents the Escalation Policy object's unique_id

sla
string

A system-generated string that represents the SLA object's unique_id

team_priority
string

A system-generated string that represents the Priority object's unique_id

Responses

Request samples

Content type
{
  • "title": "Modified Production Incident",
  • "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f"
}

Response samples

Content type
{
  • "summary": "",
  • "incident_number": 3,
  • "creation_date": "2022-07-08T13:21:25.846623Z",
  • "status": 1,
  • "unique_id": "uJVWfdAeoPDm3pk2gG2URn",
  • "service_object": {
    },
  • "title": "Modified Production Incident",
  • "incident_key": "Q5NmEbsgc4ZjLknsw97VZJ",
  • "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f",
  • "urgency": 1,
  • "merged_with": null,
  • "assigned_to": "507dfda0-a1fd-40e5-943a-e",
  • "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44",
  • "escalation_policy_object": {
    },
  • "assigned_to_name": "Mary Jane",
  • "resolved_date": null,
  • "acknowledged_date": null,
  • "context_window_start": null,
  • "context_window_end": null,
  • "tags": [ ],
  • "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c",
  • "sla_object": {
    },
  • "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329",
  • "team_priority_object": {
    }
}

Incident Roles

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

Create the Incident Role object

Create the Incident Role object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Request Body schema:
required

Request body parameters to create the Incident Role object

title
required
string

An arbitary string that represents the Incident Role object's title

description
string

An arbitary string that represents the Incident Role object's description

rank
integer
Default: 1

An integer that represents the Incident Role object's rank

Responses

Request samples

Content type
{
  • "title": "Infra Incident Role",
  • "rank": 1
}

Response samples

Content type
{
  • "unique_id": "33994f75-c917-46c4-a367-e05ad7f893a9",
  • "title": "Infra Incident Role",
  • "description": "",
  • "creation_date": "2022-07-08T13:37:07.405199Z",
  • "rank": 1
}

List all Incident Role objects

Returns a list of Incident Role objects. The Incident Role objects are sorted by creation_date, with the most recent Incident Role object appearing last.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the Incident Role object

Retrieve the specified Incident Role object.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

incident_role_id
required
string

unique_id of the Incident Role object

Responses

Response samples

Content type
{
  • "unique_id": "33994f75-c917-46c4-a367-e05ad7f893a9",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "title": "Infra Incident Role",
  • "description": "",
  • "creation_date": "2022-07-08T13:37:07.405199Z",
  • "rank": 1
}

Update the Incident Role object

Updates the specified Incident Role object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

incident_role_id
required
string

unique_id of the Incident Role object

Request Body schema:
required

Request body parameters to update the Incident Role object

title
required
string

An arbitary string that represents the Incident Role object's title

description
string

An arbitary string that represents the Incident Role object's description

rank
integer
Default: 1

An integer that represents the Incident Role object's rank

Responses

Request samples

Content type
{
  • "title": "Modified Infra Incident Role"
}

Response samples

Content type
{
  • "unique_id": "33994f75-c917-46c4-a367-e05ad7f893a9",
  • "title": "Modified Infra Incident Role",
  • "description": "",
  • "creation_date": "2022-07-08T13:37:07.405199Z",
  • "rank": 1
}

Delete the Incident Role object

Delete the specified Incident Role object permanently.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

incident_role_id
required
string

unique_id of the Incident Role object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Incident Notes

This object represents the incident notes of an incident.

Create the Incident Note object

Create the Incident Note object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

incident_number of the Incident object

Request Body schema:
required

Request body parameters to create the Incident Note object

note
string

A string that represents the Incident Note object's note data

Responses

Request samples

Content type
{
  • "note": "This is new Infra Incident Note data"
}

Response samples

Content type
{
  • "unique_id": "KCfA6tgiQTQrQVYuLVx2AK",
  • "incident": 1,
  • "user": "216bba3d-7268-4a8e-89e9-6",
  • "note": "This is new Infra Incident Note data",
  • "user_name": "Anshul Rajput",
  • "creation_date": "2022-07-08T13:50:37.581269Z"
}

List all Incident Note objects

Returns a list of Incident Note objects. The Incident Note objects are sorted by creation_date, with the most recent Incident Note object appearing last.

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

incident_number of the Incident object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the Incident Note object

Retrieve the specified Incident Note object.

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

incident_number of the Incident object

note_unique_id
required
string

unique_id of the Incident Note object

Responses

Response samples

Content type
{
  • "unique_id": "KCfA6tgiQTQrQVYuLVx2AK",
  • "incident": 1,
  • "user": "216bba3d-7268-4a8e-89e9-6",
  • "note": "This is new Infra Incident Note data",
  • "user_name": "Anshul Rajput",
  • "creation_date": "2022-07-08T13:50:37.581269Z"
}

Update the Incident Note object

Updates the specified Incident Note object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

incident_number of the Incident object

note_unique_id
required
string

unique_id of the Incident Note object

Request Body schema:
required

Incident Note update payload

note
string

A string that represents the Incident Note object's note data

Responses

Request samples

Content type
{
  • "note": "This is modified Infra Incident Note data"
}

Response samples

Content type
{
  • "unique_id": "KCfA6tgiQTQrQVYuLVx2AK",
  • "incident": 1,
  • "user": "216bba3d-7268-4a8e-89e9-6",
  • "note": "This is modified Infra Incident Note data",
  • "user_name": "Anshul Rajput",
  • "creation_date": "2022-07-08T13:50:37.581269Z"
}

Delete the Incident Note object

Delete the specified Incident Note object permanently.

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

incident_number of the Incident object

note_unique_id
required
string

unique_id of the Incident Note object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Incident Tags

This object represents the incident tags of an incident.

Create the Incident Tag object

Create the Incident Tag object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

incident_number of the Incident object

Request Body schema:
required

Request body parameters to create the Incident Tag object

team_tag
string

A system-generated string that represents the Team Tag object's unique_id

Responses

Request samples

Content type
{
  • "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4"
}

Response samples

Content type
{
  • "unique_id": "6dba6488-d330-4cbc-bd1b-5a6d912464f8",
  • "incident": 27,
  • "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4",
  • "name": "Team 1 Tag 1",
  • "color": "magenta",
  • "tag_id": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4",
  • "creation_date": "2022-12-22T08:33:22.130596Z"
}

List all Incident Tag objects

Returns a list of Incident Tag objects. The Incident Tag objects are sorted by creation_date, with the most recent Incident Note object appearing last.

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

incident_number of the Incident object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the Incident Tag object

Retrieve the specified Incident Tag object.

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

incident_number of the Incident object

tag_unique_id
required
string

unique_id of the Incident Tag object

Responses

Response samples

Content type
{
  • "unique_id": "6dba6488-d330-4cbc-bd1b-5a6d912464f8",
  • "incident": 27,
  • "creation_date": "2022-12-22T08:33:22.130596Z",
  • "name": "Team 1 Tag 1",
  • "color": "magenta",
  • "tag_id": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4",
  • "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4"
}

Delete the Incident Tag object

Delete the specified Incident Tag object permanently.

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

incident_number of the Incident object

tag_unique_id
required
string

unique_id of the Incident Tag object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Incident Responders

This object represents the incident responders of an incident.

List all Incident Responders objects

Returns a list of Incident Responders objects.

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

Incident nmuber of the Incident object

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add an Incident Responder

Add an Incident Responder to the incident

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

Incident nmuber of the Incident object

Request Body schema:
required

Payload to add an Incident Responder

user
string

Unique identifier of the User object

Responses

Request samples

Content type
{
  • "user": "85b563c8-18d0-4668-9462-9"
}

Response samples

Content type
{
  • "unique_id": "k8Ds9iL768XMdGbdSWjthA",
  • "incident": 4,
  • "user": "85b563c8-18d0-4668-9462-9",
  • "subject": null,
  • "message": null,
  • "user_name": "Vishwa Kirshnakumar",
  • "creation_date": "2024-05-20T09:06:09.580Z"
}

Retrieve an Incident Responder

Retrieve details of an Incident Responder

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

Incident nmuber of the Incident object

unique_id
required
string

unique_id of the Incident Responder Object

Responses

Response samples

Content type
{
  • "unique_id": "k8Ds9iL768XMdGbdSWjthA",
  • "incident": 4,
  • "user": "85b563c8-18d0-4668-9462-9",
  • "subject": null,
  • "message": null,
  • "user_name": "Vishwa Kirshnakumar",
  • "creation_date": "2024-05-20T09:06:09.580Z"
}

Delete an Incident Responder

Delete an Incident Responder from the incident

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

Incident nmuber of the Incident object

unique_id
required
string

unique_id of the Incident Responder Object

Responses

Events

This object represents the events of an integration.

Create the Event object Deprecated

Create the Event object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
integration_key
required
string

integration_key of the Integration object

Request Body schema:
required

Request body parameters to create the Event object

message
required
string

A string that represents the Event object's message

summary
string

A string that represents the Event object's summary

alert_type
required
string
Default: "info"

A pre-defined string that represents the Event object's alert_type. Choices - critical, acknowledged, resolved, error, warning, info.

entity_id
string

A unique id for the alert. If not provided, the Zenduty API will create one.

payload
object

A JSON payload containing additional information about the alert.

urls
Array of strings

An array containing JSON schema of urls related to alerts.

Responses

Request samples

Content type
{
  • "alert_type": "info",
  • "message": "This is info alert",
  • "summary": "This is the incident summary",
  • "entity_id": 12345,
  • "payload": {
    },
  • "urls": []
}

Response samples

Content type
{
  • "integration_object": {
    },
  • "summary": "This is the incident summary",
  • "incident": null,
  • "creation_date": "2023-04-05T12:40:35.405170Z",
  • "message": "This is info alert",
  • "integration": "828361de-681f-4f00-9420-07a185a83e46",
  • "suppressed": false,
  • "entity_id": "12345",
  • "payload": { },
  • "alert_type": "0",
  • "unique_id": "hD5dKNDyFDVADEYdrLViM7",
  • "images": [ ],
  • "urls": [],
  • "notes": [ ],
  • "incident_created": false
}

Create the Event object

Create the Event object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
account_id
required
string

5 character long account identifier

integration_key
required
string

integration_key of the Integration object

Request Body schema:
required

Request body parameters to create the Event object

message
required
string

A string that represents the Event object's message

summary
string

A string that represents the Event object's summary

alert_type
required
string
Default: "info"

A pre-defined string that represents the Event object's alert_type. Choices - critical, acknowledged, resolved, error, warning, info.

entity_id
string

A unique id for the alert. If not provided, the Zenduty API will create one.

payload
object

A JSON payload containing additional information about the alert.

urls
Array of strings

An array containing JSON schema of urls related to alerts.

sla
string

A unique id for the SLA object. If not provided or provided invalid unique_id, the Zenduty will ignore the provided value.

escalation_policy
string

A unique id for the alert. If not provided or provided invalid unique_id, the Zenduty will ignore the provided value.

priority
string

A unique id for the alert. If not provided or provided invalid unique_id, the Zenduty will ignore the provided value.

tags
Array of strings

An array containing unique_id for the tag objects.

object (Stakeholder)

Incident stakeholder object schema

object (StakeholderMessage)

Stakeholder message object schema

Responses

Request samples

Content type
{
  • "alert_type": "info",
  • "message": "This is info alert",
  • "summary": "This is the incident summary",
  • "entity_id": 12345,
  • "payload": {
    },
  • "urls": [],
  • "sla": "cfb927ec-8316-4464-8770-deca07f75b49",
  • "escalation_policy": "272841e2-2cbf-40a8-9a9a-64227fd3d722",
  • "priority": "b535c8c0-7c75-4911-a9c6-27a3be2f2da9",
  • "stakeholders": {
    },
  • "tags": [
    ],
  • "stakeholder_comms": {
    }
}

Response samples

Content type
{
  • "message": "success",
  • "trace_id": "2f7c427c-3dd4-4bfc-84c5-74a1fb936df7"
}

Get the status of an Alert

Get the Alert object for specific trace id.

Authorizations:
bearerAuth
path Parameters
trace_id
required
string

trace id of the alert object

Responses

Response samples

Content type
{
  • "status": "completed",
  • "alert": "JVPDBpGdpBQgRKdTGz2Qir",
  • "integration": {
    },
  • "incident": {
    },
  • "suppressed": false,
  • "is_incident_created": false
}

Incident Alerts

This object represents the incident alerts of an incident.

List all Incident Alert objects

Returns a list of Incident Alert objects. The Incident Alert objects are sorted by creation_date, with the most recent Incident Alert object appearing last.

Authorizations:
bearerAuth
path Parameters
incident_number
required
string

incident_number of the Incident object

Responses

Response samples

Content type
[
  • {
    }
]

Tags

This object represents the tags of an incident. You can checkout the tag docs here https://docs.zenduty.com/docs/incidenttags

Create the Tag object

Create the Tag object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Request Body schema:
required

Request body parameters to create the Tag object

name
string

A string that represents the Tag object's name

color
string

A string that represents the Tag object's color

Responses

Request samples

Content type
{
  • "name": "New Infra Tag",
  • "color": "red"
}

Response samples

Content type
{
  • "unique_id": "fbdd8538-8651-4684-bb5e-7cc4b0c7528d",
  • "name": "New Infra Tag",
  • "creation_date": "2022-07-08T14:11:20.697785Z",
  • "color": "red",
  • "team": 3674
}

List all Tag objects

Returns a list of Tag objects. The Tag objects are sorted by creation_date, with the most recent Tag object appearing last.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the Tag object

Retrieve the specified Tag object.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

tag_id
required
string

unique_id of the Tag object

Responses

Response samples

Content type
{
  • "unique_id": "fbdd8538-8651-4684-bb5e-7cc4b0c7528d",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "name": "New Infra Tag",
  • "creation_date": "2022-07-08T14:11:20.697785Z",
  • "color": "red"
}

Update the Tag object

Updates the specified Tag object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

tag_id
required
string

unique_id of the Tag object

Request Body schema:
required

Request body parameters to update the Tag object

name
string

A string that represents the Tag object's name

color
string

A string that represents the Tag object's color

Responses

Request samples

Content type
{
  • "name": "Modified Infra Tag",
  • "color": "orange"
}

Response samples

Content type
{
  • "unique_id": "fbdd8538-8651-4684-bb5e-7cc4b0c7528d",
  • "name": "Modified Infra Tag",
  • "creation_date": "2022-07-08T14:11:20.697785Z",
  • "color": "orange",
  • "team": 3674
}

Delete the Tag object

Delete the specified Tag object permanently.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

tag_id
required
string

unique_id of the Tag object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Task Templates

This object represents the task templates of the team. You can checkout the task template docs here https://docs.zenduty.com/docs/tasktemplates

Create the Task Template object

Create the Template object object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Request Body schema:
required

Request body parameters to create the Task Template object

name
required
string

A string that represents the Task Template object's name

summary
string

A string that represents the Task Template object's summary

due_immediately
integer
Default: 0

An integer that represents whether the Task Template object is due immediately or not. 0 is false and 1 is true.

Responses

Request samples

Content type
{
  • "name": "New Infra Task Template",
  • "summary": "This is the summary for New Infra Task Template"
}

Response samples

Content type
{
  • "unique_id": "94d836f1-4fda-4124-a339-ba7975a15559",
  • "name": "New Infra Task Template",
  • "creation_date": "2022-07-08T14:22:08.597518Z",
  • "summary": "This is the summary for New Infra Task Template",
  • "due_immediately": 0
}

List all Task Template objects

Returns a list of Task Templat objects. The Task Templat objects are sorted by creation_date, with the most recent Task Templat object appearing last.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the Task Template object

Retrieve the specified Task Template object.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

task_template_id
required
string

unique_id of the Task Template object

Responses

Response samples

Content type
{
  • "unique_id": "94d836f1-4fda-4124-a339-ba7975a15559",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "name": "New Infra Task Template",
  • "creation_date": "2022-07-08T14:22:08.597518Z",
  • "summary": "This is the summary for New Infra Task Template",
  • "due_immediately": 0
}

Update the Task Template object

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

task_template_id
required
string

unique_id of the Task Template object

Request Body schema:
required

Request body parameters to update the Task Template object

name
required
string

A string that represents the Task Template object's name

summary
string

A string that represents the Task Template object's summary

due_immediately
integer
Default: 0

An integer that represents whether the Task Template object is due immediately or not. 0 is false and 1 is true.

Responses

Request samples

Content type
{
  • "name": "Modified Infra Task Template",
  • "summary": "This is the summary for Modified Infra Task Template"
}

Response samples

Content type
{
  • "unique_id": "94d836f1-4fda-4124-a339-ba7975a15559",
  • "name": "Modified Infra Task Template",
  • "creation_date": "2022-07-08T14:22:08.597518Z",
  • "summary": "This is the summary for Modified Infra Task Template",
  • "due_immediately": 0
}

Delete the Task Template object

Delete the specified Task Template object permanently.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

task_template_id
required
string

unique_id of the Task Template object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Priorities

This object represents the priority of an incident. You can checkout the priority docs here https://docs.zenduty.com/docs/incidentpriority

Create the Priority object

Create the Priority object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Request Body schema:
required

Request body parameters to create the Priority object

name
string

A string that represents the Priority object's name

description
string

A string that represents the Priority object's description

color
string

A string that represents the Priority object's color

Responses

Request samples

Content type
{
  • "name": "New Infra Priority"
}

Response samples

Content type
{
  • "unique_id": "88519afe-3409-4f96-b9de-4464908f6e88",
  • "name": "New Infra Priority",
  • "description": "",
  • "creation_date": "2022-07-08T14:33:05.609863Z",
  • "color": "",
  • "team": 3674
}

List all Priority objects

Returns a list of Priority objects. The Priority objects are sorted by creation_date, with the most recent Priority object appearing last.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the Priority object

Retrieve the specified Priority object.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

priority_id
required
string

unique_id of the Priority object

Responses

Response samples

Content type
{
  • "unique_id": "88519afe-3409-4f96-b9de-4464908f6e88",
  • "team": "61010821-08aa-4098-94f8-f88f1990b54a",
  • "description": "",
  • "name": "New Infra Priority",
  • "creation_date": "2022-07-08T14:33:05.609863Z",
  • "color": ""
}

Update the Priority object

Updates the specified Priority object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

priority_id
required
string

unique_id of the Priority object

Request Body schema:
required

Request body parameters to update the Priority object

name
string

A string that represents the Priority object's name

description
string

A string that represents the Priority object's description

color
string

A string that represents the Priority object's color

Responses

Request samples

Content type
{
  • "name": "Modified Infra Priority"
}

Response samples

Content type
{
  • "unique_id": "88519afe-3409-4f96-b9de-4464908f6e88",
  • "name": "Modified Infra Priority",
  • "description": "",
  • "creation_date": "2022-07-08T14:33:05.609863Z",
  • "color": "",
  • "team": 3674
}

Delete the Priority object

Delete the specified Priority object permanently.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

priority_id
required
string

unique_id of the Priority object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

SLA

This object represents the SLA of an incident. You can checkout the SLA docs here https://docs.zenduty.com/docs/incidentsla

Create the SLA object

Create the SLA object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Request Body schema:
required

Request body parameters to create the SLA object

name
string

An arbitary string that represents the SLA object's name

required
Array of objects (SLA_Escalation)

An array of SLA Escalation objects

is_active
boolean
Default: true

A boolean flag that represents whether the SLA object is active or not

acknowledge_time
integer

An integer that represents the SLA object's acknowledge_time

resolve_time
integer

An integer that represents the SLA object's resolve_time

Responses

Request samples

Content type
{
  • "name": "New Infra SLA",
  • "escalations": [ ]
}

Response samples

Content type
{
  • "escalations": [ ],
  • "unique_id": "010bc17d-f688-403d-b762-f039fb6f5ad9",
  • "name": "New Infra SLA",
  • "description": "",
  • "is_active": true,
  • "conditions": "{}",
  • "acknowledge_time": null,
  • "resolve_time": null,
  • "team": 3674
}

List all SLA objects

Returns a list of SLA objects.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the SLA object

Retrieve the specified SLA object.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

sla_id
required
string

unique_id of the SLA object

Responses

Response samples

Content type
{
  • "escalations": [ ],
  • "unique_id": "010bc17d-f688-403d-b762-f039fb6f5ad9",
  • "name": "New Infra SLA",
  • "description": "",
  • "is_active": true,
  • "conditions": "{}",
  • "acknowledge_time": null,
  • "resolve_time": null,
  • "team": 3674
}

Update the SLA object

Updates the specified SLA object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

sla_id
required
string

unique_id of the SLA object

Request Body schema:
required

Request body parameters to update the SLA object

name
string

An arbitary string that represents the SLA object's name

required
Array of objects (SLA_Escalation)

An array of SLA Escalation objects

is_active
boolean
Default: true

A boolean flag that represents whether the SLA object is active or not

acknowledge_time
integer

An integer that represents the SLA object's acknowledge_time

resolve_time
integer

An integer that represents the SLA object's resolve_time

Responses

Request samples

Content type
{
  • "name": "Modified Infra SLA",
  • "escalations": [ ]
}

Response samples

Content type
{
  • "escalations": [ ],
  • "unique_id": "010bc17d-f688-403d-b762-f039fb6f5ad9",
  • "name": "Modified Infra SLA",
  • "description": "",
  • "is_active": true,
  • "conditions": "{}",
  • "acknowledge_time": null,
  • "resolve_time": null,
  • "team": 3674
}

Delete the SLA object

Delete the specified SLA object permanently.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

sla_id
required
string

unique_id of the SLA object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Team Maintenance Mode

This object represents the maintenance mode of a team. You can checkout the team maintenance mode docs here https://docs.zenduty.com/docs/maintenancewindows

Create the Team Maintenance Mode object

Create the Team Maintenance Mode object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Request Body schema:
required

Request body parameters to create the Team Maintenance Mode object

start_time
required
string <date-time>

A formatted string that represents the Team Maintenance Mode object's start_time

end_time
required
string <date-time>

A formatted string that represents the Team Maintenance Mode object's end_time

repeat_interval
integer
Default: 0

An integer that represents the Team Maintenance Mode object's repeat_interval

required
Array of objects

Array of Service objects

name
string

A string that represents the Team Maintenance Mode object's name

time_zone
string
Default: "UTC"

A formatted string that represents the Team Maintenance Mode object's time_zone. You can check out the time zone list here https://timezonedb.com/time-zones

repeat_until
string <date-time>

A formatted string that represents the Team Maintenance Mode object's repeat_until

Responses

Request samples

Content type
{
  • "name": "New Infra Team Maintenance",
  • "services": [
    ],
  • "start_time": "2022-07-08T18:06:00Z",
  • "end_time": "2022-07-15T18:06:00Z"
}

Response samples

Content type
{
  • "unique_id": "162055d5-9646-43df-95cb-2ac511bf34ef",
  • "start_time": "2022-07-08T18:06:00Z",
  • "end_time": "2022-07-15T18:06:00Z",
  • "repeat_interval": 0,
  • "services": [
    ],
  • "creation_date": "2022-07-08T14:55:46.681634Z",
  • "name": "New Infra Team Maintenance",
  • "time_zone": "UTC",
  • "repeat_until": null
}

List all Team Maintenance Mode objects

Returns a list of Team Maintenance Mode objects. The Team Maintenance Mode objects are sorted by creation_date, with the most recent Team Maintenance Mode object appearing last.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the Team Maintenance Mode object

Retrieve the specified Team Maintenance Mode object.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

maintenance_id
required
string

unique_id of the Team Maintenance Mode object

Responses

Response samples

Content type
{
  • "unique_id": "162055d5-9646-43df-95cb-2ac511bf34ef",
  • "start_time": "2022-07-08T18:06:00Z",
  • "end_time": "2022-07-15T18:06:00Z",
  • "repeat_interval": 0,
  • "services": [
    ],
  • "creation_date": "2022-07-08T14:55:46.681634Z",
  • "name": "New Infra Team Maintenance",
  • "time_zone": "UTC",
  • "repeat_until": null
}

Update Team Maintenance Mode object

Updates the specified Team Maintenance Mode object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

maintenance_id
required
string

unique_id of the Team Maintenance Mode object

Request Body schema: application/json
required

Request body parameters to update the Team Maintenance Mode object

start_time
required
string <date-time>

A formatted string that represents the Team Maintenance Mode object's start_time

end_time
required
string <date-time>

A formatted string that represents the Team Maintenance Mode object's end_time

repeat_interval
integer
Default: 0

An integer that represents the Team Maintenance Mode object's repeat_interval

required
Array of objects

Array of Service objects

name
string

A string that represents the Team Maintenance Mode object's name

time_zone
string
Default: "UTC"

A formatted string that represents the Team Maintenance Mode object's time_zone. You can check out the time zone list here https://timezonedb.com/time-zones

repeat_until
string <date-time>

A formatted string that represents the Team Maintenance Mode object's repeat_until

Responses

Request samples

Content type
application/json
{
  • "name": "Modified Infra Team Maintenance",
  • "services": [
    ],
  • "start_time": "2022-07-08T18:06:00Z",
  • "end_time": "2022-07-15T18:06:00Z"
}

Response samples

Content type
{
  • "unique_id": "162055d5-9646-43df-95cb-2ac511bf34ef",
  • "start_time": "2022-07-08T18:06:00Z",
  • "end_time": "2022-07-15T18:06:00Z",
  • "repeat_interval": null,
  • "services": [
    ],
  • "creation_date": "2022-07-08T14:55:46.681634Z",
  • "name": "Modified Infra Team Maintenance",
  • "time_zone": null,
  • "repeat_until": null
}

Delete the Team Maintenance Mode object

Delete the specified Team Maintenance Mode object permanently.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

maintenance_id
required
string

unique_id of the Team Maintenance Mode object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Postmortem

This object represents the postmortem of an incident. You can checkout the postmortem docs here https://docs.zenduty.com/docs/incidentpostmortem

Create the Postmortem object

Create the Postmortem object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Request Body schema:
required

Request body parameters to create the Postmortem object

author
required
string

A system-generated string that represents the User object's username

status
string

A string that represents the Postmortem object's status

postmortem_data
string

A string that represents the Postmortem object's postmortem_data

required
Array of objects

An array of Postmortem Incident objects

title
string

A string that represents the Postmortem object's title

download_status
integer
Default: 0

An integer that represents the Postmortem object's download_status. 1 is uninitiated, 2 is initiated, 3 is finished and 4 is error

Responses

Request samples

Content type
{
  • "author": "85b563c8-18d0-4668-9462-9",
  • "incidents": [
    ],
  • "title": "New Infra Postmortem"
}

Response samples

Content type
{
  • "unique_id": "f6778c71-eba2-49da-b226-ca27172d7303",
  • "author": "85b563c8-18d0-4668-9462-9",
  • "status": "",
  • "incidents": [
    ],
  • "author_name": "Vishwa Krishnakumar",
  • "title": "New Infra Postmortem",
  • "postmortem_data": "",
  • "download_status": 0
}

List all Postmortem objects

Returns a list of Postmortem objects.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the Postmortem object

Retrieve the specified Postmortem object.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

postmortem_id
required
string

unique_id of the Postmortem object

Responses

Response samples

Content type
{
  • "unique_id": "f6778c71-eba2-49da-b226-ca27172d7303",
  • "author": "85b563c8-18d0-4668-9462-9",
  • "status": "",
  • "postmortem_data": "",
  • "incidents": [
    ],
  • "author_name": "Vishwa Krishnakumar",
  • "title": "New Infra Postmortem",
  • "download_status": 0,
  • "amazon_link": "https://zenduty-dev-report.s3.amazonaws.com/",
  • "creation_date": "2022-07-08T15:08:01.521494Z"
}

Update the Postmortem data

Updates the specified Postmortem object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

postmortem_id
required
string

unique_id of the Postmortem object

Request Body schema:
required

Request body parameters to update the Postmortem object

author
required
string

A system-generated string that represents the User object's username

status
string

A string that represents the Postmortem object's status

postmortem_data
string

A string that represents the Postmortem object's postmortem_data

required
Array of objects

An array of Postmortem Incident objects

title
string

A string that represents the Postmortem object's title

download_status
integer
Default: 0

An integer that represents the Postmortem object's download_status. 1 is uninitiated, 2 is initiated, 3 is finished and 4 is error

Responses

Request samples

Content type
{
  • "author": "85b563c8-18d0-4668-9462-9",
  • "incidents": [
    ],
  • "title": "Modified Infra Postmortem"
}

Response samples

Content type
{
  • "unique_id": "f6778c71-eba2-49da-b226-ca27172d7303",
  • "author": "85b563c8-18d0-4668-9462-9",
  • "status": null,
  • "incidents": [
    ],
  • "author_name": "Vishwa Krishnakumar",
  • "title": "Modified Infra Postmortem",
  • "postmortem_data": null,
  • "download_status": 0
}

Delete the Postmortem data

Delete the specified Postmortem object permanently.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

postmortem_id
required
string

unique_id of the Postmortem object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

OnCall

This object represents the user who is oncall.

List all Escalation Policy OnCall object's in a Team V1

Returns all OnCall Users of a Team Escalation Policies.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

Unique ID of a Team

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

List all Escalation Policy OnCall object's in a Team V2

Returns all OnCall Users of a Team Escalation Policies.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

Unique ID of a Team

Responses

Response samples

Content type
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Retrieve Escalation Policy OnCall object in an Escalation Policy

Returns all OnCall Users of an Escalation Policy.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

Unique ID of a Team

ep_id
required
string

Unique ID of an Escalation Policy

Responses

Response samples

Content type
[
  • {
    }
]

Retrieve Escalation Policy OnCall object in a Service

Returns all OnCall Users of a Service Escalation Policy.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

Unique ID of a Team

service_id
required
string

Unique ID of a Service

Responses

Response samples

Content type
[
  • {
    }
]

Global Router

This object represents the Global Router of the Account. You can checkout the global alert routing docs here https://docs.zenduty.com/docs/globalalertrouting

Create the Global Router object

Create the Global Router object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
Request Body schema:
required

Request body parameters to create the Global Router object

name
string

A string that represents the Global Router object's name

description
string

A string that represents the Global Router object's description

Responses

Request samples

Content type
{
  • "name": "Infra Global Router",
  • "description": "This is Infra Global Router for this account"
}

Response samples

Content type
{
  • "unique_id": "b0c1867f-dfd2-4cb3-a298-0b9f322fe716",
  • "name": "Infra Global Router",
  • "description": "This is Infra Global Router for this account",
  • "account": "61fb2d9e-088b-471f-a6d7-872c03cf483d",
  • "is_enabled": true,
  • "integration_key": "cb1de2f2-bb17-4a6c-8a80-03739ca0a911"
}

List all Global Router objects

Returns a list of Global Router objects.

Authorizations:
bearerAuth

Responses

Response samples

Content type
[
  • {
    },
  • {
    },
  • {
    }
]

Retrieve the Global Router object

Retrieve the specified Global Router object.

Authorizations:
bearerAuth
path Parameters
router_id
required
string

unique_id of the Global Router object

Responses

Response samples

Content type
{
  • "unique_id": "b0c1867f-dfd2-4cb3-a298-0b9f322fe716",
  • "name": "Infra Global Router",
  • "description": "This is Infra Global Router for this account",
  • "account": "61fb2d9e-088b-471f-a6d7-872c03cf483d",
  • "is_enabled": true,
  • "integration_key": "cb1de2f2-bb17-4a6c-8a80-03739ca0a911"
}

Update the Global Router data

Updates the specified Global Router object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
router_id
required
string

unique_id of the Global Router object

Request Body schema:
required

Request body parameters to update the Global Router object

name
string

A string that represents the Global Router object's name

description
string

A string that represents the Global Router object's description

Responses

Request samples

Content type
{
  • "name": "Infra Global Router Updated",
  • "description": "This is Infra Global Router Updated for this account"
}

Response samples

Content type
{
  • "unique_id": "b0c1867f-dfd2-4cb3-a298-0b9f322fe716",
  • "name": "Infra Global Router Updated",
  • "description": "This is Infra Global Router Updated for this account",
  • "account": "61fb2d9e-088b-471f-a6d7-872c03cf483d",
  • "is_enabled": true,
  • "integration_key": "cb1de2f2-bb17-4a6c-8a80-03739ca0a911"
}

Delete the Global Router data

Delete the specified Global Router object permanently.

Authorizations:
bearerAuth
path Parameters
router_id
required
string

unique_id of the Global Router object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Global Router Rules

The Rules of the Global Router in an Account are represented by this object. Visit this link to view the documentation for the global alert routing rules https://docs.zenduty.com/docs/globalalertrouting

Create the Global Router Rule object

Create the Global Router Rule object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
router_id
required
string

unique_id of the Global Router object

Request Body schema:
required

Request body parameters to create the Global Router Rule object

name
string

A string that represents the Global Router Rule object's name

rule_json
string

A string that represents the rule json of Global Router Rule object

Array of objects (GlobalRouterRuleActionPayload)

An array of Global Router Rule Action objects

Responses

Request samples

Content type
{
  • "name": "Rule for Grafana Integration",
  • "actions": [
    ],
  • "rule_json": "{\"type\":\"group\",\"id\":\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"children1\":{\"898aa9ba-0123-4456-b89a-b16a429f5d94\":{\"type\":\"rule\",\"id\":\"898aa9ba-0123-4456-b89a-b16a429f5d94\",\"properties\":{\"field\":\"alert.payload\",\"operator\":\"payloadsearch\",\"value\":[\"$.commonLabels.alertname\",\"grafana\"],\"valueSrc\":[\"value\",\"value\"],\"operatorOptions\":{\"ploperator\":\"equal\"},\"valueType\":[\"text\",\"text\"]},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"898aa9ba-0123-4456-b89a-b16a429f5d94\"]}},\"properties\":{\"conjunction\":\"AND\",\"not\":false},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\"]}"
}

Response samples

Content type
{
  • "unique_id": "4c9924cc-d051-4e58-978b-d673a7de540a",
  • "name": "Rule for Grafana Integration",
  • "position": 7,
  • "rule_json": "{\"type\":\"group\",\"id\":\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"children1\":{\"898aa9ba-0123-4456-b89a-b16a429f5d94\":{\"type\":\"rule\",\"id\":\"898aa9ba-0123-4456-b89a-b16a429f5d94\",\"properties\":{\"field\":\"alert.payload\",\"operator\":\"payloadsearch\",\"value\":[\"$.commonLabels.alertname\",\"grafana\"],\"valueSrc\":[\"value\",\"value\"],\"operatorOptions\":{\"ploperator\":\"equal\"},\"valueType\":[\"text\",\"text\"]},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"898aa9ba-0123-4456-b89a-b16a429f5d94\"]}},\"properties\":{\"conjunction\":\"AND\",\"not\":false},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\"]}",
  • "actions": [
    ],
  • "router": "e9be034e-6076-4953-a315-9a3666ffe774"
}

List all Global Router Rule objects

Returns a list of Global Router Rule objects.

Authorizations:
bearerAuth
path Parameters
router_id
required
string

unique_id of the Global Router object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Update the Global Router Rule object

Updates the position of the Global Router Rule object by setting the position and rule unique id passed in the request body

Authorizations:
bearerAuth
path Parameters
router_id
required
string

unique_id of the Global Router object

Request Body schema:
required

Request body parameters to update the position of Global Router Rule object

rule
string

A system generated string that represents the unique id of the Global Router Rule object

position
integer

An integer that represents that position of the Global Router Rule object

Responses

Request samples

Content type
{
  • "rule": "12edd6c5-2217-4b53-b635-83083f420dd8",
  • "position": 1
}

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the Global Router Rule object

Retrieve the specified Global Router Rule object.

Authorizations:
bearerAuth
path Parameters
router_id
required
string

unique_id of the Global Router object

ruleset_id
required
string

unique_id of the Global Router Rule object

Responses

Response samples

Content type
{
  • "unique_id": "4c9924cc-d051-4e58-978b-d673a7de540a",
  • "name": "Rule for Grafana Integration",
  • "position": 2,
  • "rule_json": "{\"type\":\"group\",\"id\":\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"children1\":{\"898aa9ba-0123-4456-b89a-b16a429f5d94\":{\"type\":\"rule\",\"id\":\"898aa9ba-0123-4456-b89a-b16a429f5d94\",\"properties\":{\"field\":\"alert.payload\",\"operator\":\"payloadsearch\",\"value\":[\"$.commonLabels.alertname\",\"grafana\"],\"valueSrc\":[\"value\",\"value\"],\"operatorOptions\":{\"ploperator\":\"equal\"},\"valueType\":[\"text\",\"text\"]},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"898aa9ba-0123-4456-b89a-b16a429f5d94\"]}},\"properties\":{\"conjunction\":\"AND\",\"not\":false},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\"]}",
  • "actions": [
    ],
  • "router": "e9be034e-6076-4953-a315-9a3666ffe774"
}

Update the Global Router Rule data

Updates the specified Global Router Rule object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
router_id
required
string

unique_id of the Global Router object

ruleset_id
required
string

unique_id of the Global Router Rule object

Request Body schema:
required

Request body parameters to update the Global Router Rule object

name
string

A string that represents the Global Router Rule object's name

rule_json
string

A string that represents the rule json of Global Router Rule object

Array of objects (GlobalRouterRuleActionPayload)

An array of Global Router Rule Action objects

Responses

Request samples

Content type
{
  • "name": "Rule for Grafana Integration Updated",
  • "rule_json": "{\"type\":\"group\",\"id\":\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"children1\":{\"898aa9ba-0123-4456-b89a-b16a429f5d94\":{\"type\":\"rule\",\"id\":\"898aa9ba-0123-4456-b89a-b16a429f5d94\",\"properties\":{\"field\":\"alert.payload\",\"operator\":\"payloadsearch\",\"value\":[\"$.commonLabels.alertname\",\"grafana\"],\"valueSrc\":[\"value\",\"value\"],\"operatorOptions\":{\"ploperator\":\"equal\"},\"valueType\":[\"text\",\"text\"]},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"898aa9ba-0123-4456-b89a-b16a429f5d94\"]}},\"properties\":{\"conjunction\":\"AND\",\"not\":false},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\"]}",
  • "actions": [
    ]
}

Response samples

Content type
{
  • "unique_id": "4c9924cc-d051-4e58-978b-d673a7de540a",
  • "name": "Rule for Grafana Integration Updated",
  • "position": 2,
  • "rule_json": "{\"type\":\"group\",\"id\":\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"children1\":{\"898aa9ba-0123-4456-b89a-b16a429f5d94\":{\"type\":\"rule\",\"id\":\"898aa9ba-0123-4456-b89a-b16a429f5d94\",\"properties\":{\"field\":\"alert.payload\",\"operator\":\"payloadsearch\",\"value\":[\"$.commonLabels.alertname\",\"grafana\"],\"valueSrc\":[\"value\",\"value\"],\"operatorOptions\":{\"ploperator\":\"equal\"},\"valueType\":[\"text\",\"text\"]},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"898aa9ba-0123-4456-b89a-b16a429f5d94\"]}},\"properties\":{\"conjunction\":\"AND\",\"not\":false},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\"]}",
  • "actions": [
    ],
  • "router": "e9be034e-6076-4953-a315-9a3666ffe774"
}

Delete the Global Router Rule data

Delete the specified Global Router Rule object permanently.

Authorizations:
bearerAuth
path Parameters
router_id
required
string

unique_id of the Global Router object

ruleset_id
required
string

unique_id of the Global Router Rule object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}

Alert Rules

Alert Rules in Zenduty are advanced conditions for incoming alerts. They dictate how Zenduty handles alerts and their incidents upon receipt, altering behavior and routing based on predefined rules and actions set by the user within Zenduty Integrations.Visit this link to view the documentation for the alert rules https://www.zenduty.com/docs/alertrules/

Create the Alert Rule object

Create the Alert Rule object by setting the values of all the required parameters passed in the request body.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

service_id
required
string

unique_id of the Service object

integration_id
required
string

unique_id of the Integration object

Request Body schema:
required

Request body parameters to create the Alert Rule object

description
string

A string that represents the Alert Transformer object's description

Array of objects (AlertTransformerActionPayload)

An array of Alert Transformer Action objects

rule_json
string

A string that represents the all the conditions of the alert rule

Responses

Request samples

Content type
{
  • "actions": [
    ],
  • "description": "Add links to alert summary",
  • "rule_json": "{\"type\":\"group\",\"id\":\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"children1\":{\"898aa9ba-0123-4456-b89a-b16a429f5d94\":{\"type\":\"rule\",\"id\":\"898aa9ba-0123-4456-b89a-b16a429f5d94\",\"properties\":{\"field\":\"alert.message\",\"operator\":\"is_not_empty\",\"value\":[],\"valueSrc\":[],\"operatorOptions\":null,\"valueType\":[]},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"898aa9ba-0123-4456-b89a-b16a429f5d94\"]}},\"properties\":{\"conjunction\":\"AND\",\"not\":false},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\"]}"
}

Response samples

Content type
{
  • "rule_type": 0,
  • "unique_id": "8de24581-eade-4b50-a7f0-ac20594fde98",
  • "description": "Add links to alert summary",
  • "stop": false,
  • "position": 1,
  • "conditions": [ ],
  • "actions": [
    ],
  • "rule_json": "{\"type\":\"group\",\"id\":\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"children1\":{\"898aa9ba-0123-4456-b89a-b16a429f5d94\":{\"type\":\"rule\",\"id\":\"898aa9ba-0123-4456-b89a-b16a429f5d94\",\"properties\":{\"field\":\"alert.message\",\"operator\":\"is_not_empty\",\"value\":[],\"valueSrc\":[],\"operatorOptions\":null,\"valueType\":[]},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"898aa9ba-0123-4456-b89a-b16a429f5d94\"]}},\"properties\":{\"conjunction\":\"AND\",\"not\":false},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\"]}"
}

List all Alert Rules objects

Returns a list of Alert Rules objects.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

service_id
required
string

unique_id of the Service object

integration_id
required
string

unique_id of the Integration object

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Retrieve the Alert Rule object

Retrieve the specified Alert Rule object.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

service_id
required
string

unique_id of the Service object

integration_id
required
string

unique_id of the Integration object

transformers_id
required
string

unique_id of the Alert Rule object

Responses

Response samples

Content type
{
  • "rule_type": 0,
  • "unique_id": "8de24581-eade-4b50-a7f0-ac20594fde98",
  • "description": "Add links to alert summary",
  • "stop": false,
  • "position": 1,
  • "conditions": [ ],
  • "actions": [
    ],
  • "rule_json": "{\"type\":\"group\",\"id\":\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"children1\":{\"898aa9ba-0123-4456-b89a-b16a429f5d94\":{\"type\":\"rule\",\"id\":\"898aa9ba-0123-4456-b89a-b16a429f5d94\",\"properties\":{\"field\":\"alert.message\",\"operator\":\"is_not_empty\",\"value\":[],\"valueSrc\":[],\"operatorOptions\":null,\"valueType\":[]},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"898aa9ba-0123-4456-b89a-b16a429f5d94\"]}},\"properties\":{\"conjunction\":\"AND\",\"not\":false},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\"]}"
}

Update the Alert Rule data

Updates the specified Alert Rule object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

service_id
required
string

unique_id of the Service object

integration_id
required
string

unique_id of the Integration object

transformers_id
required
string

unique_id of the Alert Rule object

Request Body schema:
required

Request body parameters to update the Alert Rule object

description
string

A string that represents the Alert Transformer object's description

Array of objects (AlertTransformerActionPayload)

An array of Alert Transformer Action objects

rule_json
string

A string that represents the all the conditions of the alert rule

Responses

Request samples

Content type
{
  • "rule_type": 0,
  • "unique_id": "8de24581-eade-4b50-a7f0-ac20594fde98",
  • "description": "Add links to alert summary updated",
  • "stop": false,
  • "position": 1,
  • "conditions": [ ],
  • "actions": [
    ],
  • "rule_json": "{\"type\":\"group\",\"id\":\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"children1\":{\"898aa9ba-0123-4456-b89a-b16a429f5d94\":{\"type\":\"rule\",\"id\":\"898aa9ba-0123-4456-b89a-b16a429f5d94\",\"properties\":{\"field\":\"alert.message\",\"operator\":\"is_not_empty\",\"value\":[],\"valueSrc\":[],\"operatorOptions\":null,\"valueType\":[]},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"898aa9ba-0123-4456-b89a-b16a429f5d94\"]}},\"properties\":{\"conjunction\":\"AND\",\"not\":false},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\"]}"
}

Response samples

Content type
{
  • "rule_type": 0,
  • "unique_id": "8de24581-eade-4b50-a7f0-ac20594fde98",
  • "description": "Add links to alert summary updated",
  • "stop": false,
  • "position": 1,
  • "conditions": [ ],
  • "actions": [
    ],
  • "rule_json": "{\"type\":\"group\",\"id\":\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"children1\":{\"898aa9ba-0123-4456-b89a-b16a429f5d94\":{\"type\":\"rule\",\"id\":\"898aa9ba-0123-4456-b89a-b16a429f5d94\",\"properties\":{\"field\":\"alert.message\",\"operator\":\"is_not_empty\",\"value\":[],\"valueSrc\":[],\"operatorOptions\":null,\"valueType\":[]},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\",\"898aa9ba-0123-4456-b89a-b16a429f5d94\"]}},\"properties\":{\"conjunction\":\"AND\",\"not\":false},\"path\":[\"9a99988a-0123-4456-b89a-b1607f326fd8\"]}"
}

Delete the Alert Rule object

Delete the specified Alert Rule object permanently.

Authorizations:
bearerAuth
path Parameters
team_id
required
string

unique_id of the Team object

service_id
required
string

unique_id of the Service object

integration_id
required
string

unique_id of the Integration object

transformers_id
required
string

unique_id of the Alert Rule object

Responses

Response samples

Content type
{
  • "detail": "This request can not be processed."
}