Zenduty Services API
This object represents the services associated with a team. You can checkout the services docs here https://docs.zenduty.com/docs/services
OpenAPI Specification
openapi: 3.0.0
info:
version: 1.1.0
title: Zenduty Account Custom Role Services API
termsOfService: https://zenduty.com
contact:
email: vishwa@zenduty.com
license:
name: Apache 2.0
x-logo:
url: data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOS4wLjAsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9Ii05OC4zIDE3My43IDIwNi4zIDUzLjIiIHN0eWxlPSJlbmFibGUtYmFja2dyb3VuZDpuZXcgLTk4LjMgMTczLjcgMjA2LjMgNTMuMjsiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPHN0eWxlIHR5cGU9InRleHQvY3NzIj4NCgkuc3Qwe2ZpbGw6IzBGMTcyQTt9DQoJLnN0MXtmaWxsOiNGRDlBMDA7fQ0KPC9zdHlsZT4NCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik0tMjksMjEwLjJoNi4zYzIuNywwLDQuOSwyLjIsNC45LDQuOWgtMTguMWMwLTUuMyw0LjEtOS40LDcuOS0xMy4xbDMuOC0zLjdoLTcuMWMtMi41LDAtNC42LTIuMS00LjYtNC42aDE4DQoJYzAsNS4zLTQuMSw5LjQtNy44LDEzLjJMLTI5LDIxMC4yeiIvPg0KPHBhdGggY2xhc3M9InN0MCIgZD0iTTMuNywyMDUuOGgtMTUuNWMwLjEsMS41LDAuNiwyLjcsMS42LDMuNmMwLjksMC45LDIuMSwxLjIsMy41LDEuMmMyLDAsMy40LTAuOSw0LjMtMi41aDUuOA0KCWMtMC42LDItMS44LDMuNi0zLjUsNC45Yy0xLjgsMS4yLTMuOSwyLTYuNCwyYy0yLDAtMy45LTAuNS01LjUtMS40Yy0xLjYtMC45LTIuOS0yLjEtMy44LTMuN2MtMC45LTEuNi0xLjQtMy40LTEuNC01LjcNCgljMC0yLjEsMC41LTQuMSwxLjQtNS43YzAuOS0xLjYsMi4xLTIuOCwzLjgtMy43YzEuNi0wLjksMy40LTEuNCw1LjUtMS40YzIsMCwzLjgsMC40LDUuNCwxLjJjMS42LDAuOSwyLjgsMi4xLDMuNywzLjYNCgljMC45LDEuNiwxLjMsMy4zLDEuMyw1LjRDMy44LDIwNC42LDMuOCwyMDUuMiwzLjcsMjA1Ljh6IE0tMS43LDIwMi4yYzAtMS40LTAuNS0yLjUtMS41LTMuMmMtMS0wLjktMi4xLTEuMi0zLjUtMS4yDQoJYy0xLjQsMC0yLjQsMC40LTMuNCwxLjJjLTAuOSwwLjctMS41LDEuOC0xLjYsMy4zaDEwLjFWMjAyLjJ6Ii8+DQo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNMjcuOSwxOTguNGMwLjktMS42LDItMi45LDMuNS0zLjhjMS41LTAuOSwzLjEtMS40LDQuOS0xLjRjMS40LDAsMi42LDAuMywzLjksMC45YzEuMywwLjYsMi4zLDEuNCwzLDIuNHYtMTYuNw0KCWg1LjR2MzVoLTUuNHYtMy4xYy0wLjYsMS0xLjYsMS45LTIuOCwyLjVjLTEuMywwLjYtMi42LDEtNC4yLDFjLTEuOCwwLTMuNC0wLjUtNC45LTEuNGMtMS41LTAuOS0yLjYtMi4zLTMuNS0zLjkNCgljLTAuOS0xLjYtMS4zLTMuNS0xLjMtNS44QzI2LjYsMjAyLDI3LDIwMCwyNy45LDE5OC40eiBNNDIuNSwyMDAuOWMtMC41LTAuOS0xLjMtMS42LTItMi4xYy0wLjktMC41LTEuOC0wLjgtMi44LTAuOA0KCWMtMSwwLTEuOSwwLjMtMi44LDAuOGMtMC45LDAuNS0xLjUsMS4xLTIsMi4xYy0wLjUsMC45LTAuOCwyLTAuOCwzLjNjMCwxLjMsMC4zLDIuNCwwLjgsMy40YzAuNSwxLDEuMywxLjYsMiwyLjENCgljMC45LDAuNSwxLjgsMC44LDIuOCwwLjhjMSwwLDEuOS0wLjMsMi44LTAuOGMwLjktMC41LDEuNS0xLjMsMi0yLjFjMC41LTAuOSwwLjgtMiwwLjgtMy40UzQzLDIwMS44LDQyLjUsMjAwLjl6Ii8+DQo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNMjUuNCwyMDQuM3YxMC42aC01di0xMC42YzAtMi0wLjUtMy41LTEuNS00LjVjLTEtMS4xLTIuMS0xLjYtMy41LTEuNnMtMi41LDAuNS0zLjUsMS42DQoJYy0wLjksMS0xLjQsMi42LTEuNCw0LjV2MTAuNkg1LjV2LTEwLjZjMC0yLjEsMC41LTQsMS4zLTUuN2MwLjktMS42LDItMi45LDMuNS0zLjhzMy4xLTEuNCw1LTEuNHMzLjUsMC41LDUsMS40DQoJYzEuNSwwLjksMi42LDIuMSwzLjUsMy44QzI0LjksMjAwLjMsMjUuNCwyMDIuMiwyNS40LDIwNC4zeiIvPg0KPHBhdGggY2xhc3M9InN0MCIgZD0iTTUxLjMsMjA0LjF2LTEwLjRoNXYxMC40YzAsMiwwLjUsMy41LDEuNSw0LjVjMSwxLjEsMi4xLDEuNiwzLjUsMS42YzEuNCwwLDIuNS0wLjUsMy41LTEuNg0KCWMwLjktMSwxLjQtMi42LDEuNC00LjV2LTEwLjRoNC45djEwLjRjMCwyLjEtMC41LDQtMS4zLDUuN2MtMC45LDEuNi0yLDIuOS0zLjUsMy44Yy0xLjUsMC45LTMuMSwxLjQtNSwxLjRzLTMuNS0wLjUtNS0xLjQNCgljLTEuNS0wLjktMi42LTIuMS0zLjUtMy44QzUxLjcsMjA4LjEsNTEuMywyMDYuMiw1MS4zLDIwNC4xeiIvPg0KPHBhdGggY2xhc3M9InN0MCIgZD0iTTgwLjcsMTk4djEwLjJjMCwwLjgsMC4xLDEuMywwLjUsMS41YzAuNCwwLjQsMC45LDAuNSwxLjgsMC41aDIuNXY0LjVoLTMuNGMtNC41LDAtNi44LTIuMS02LjgtNi41VjE5OGgtNS4xDQoJdi00LjRoNS4xdi04LjdoNS40djguN2g0LjhsMi42LDQuNEg4MC43eiIvPg0KPHBhdGggY2xhc3M9InN0MCIgZD0iTTEwNy40LDE5My42bC04LjcsMjAuNmwtNSwxMS44aC01LjdsNS4xLTExLjhsLTguNC0yMC42aDZsNS40LDE0LjdsNS41LTE0LjdIMTA3LjR6Ii8+DQo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNLTY2LjksMTg5LjJjLTEuOSwwLTQuNy0yLjEtNC43LTQuOHYtMy42YzAtMi43LDAuOC00LjgsNC43LTQuOGMzLjksMCw0LjcsMi4xLDQuNyw0Ljh2My42DQoJQy02Mi4yLDE4Ny4xLTY1LDE4OS4yLTY2LjksMTg5LjJ6Ii8+DQo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNLTM3LjcsMjIzaC0yMS41bDMuOC0xMS40bDAuNy0xLjhjNC4yLDEuNywxMy4xLDcuMiwxNy43LDExLjZDLTM2LjQsMjIyLjEtMzYuOCwyMjMtMzcuNywyMjN6Ii8+DQo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNLTU3LjMsMTkyLjlsLTE1LjksMTAuNGMtNC4yLTIuNS05LjItNS45LTEyLjItOC44Yy0wLjYtMC42LTAuMi0xLjUsMC43LTEuNUgtNTcuM3oiLz4NCjxwYXRoIGNsYXNzPSJzdDEiIGQ9Ik0tNDguNiwxOTQuM2wtNiwxNS42bC0wLjcsMS44bC0zLjgsMTEuNEgtOTZjLTAuOCwwLTEuMy0wLjktMC44LTEuNWMwLjktMS4yLDEuOC0yLjMsMi43LTMuMw0KCWMyLjEtMi4yLDQuNC00LjEsNi45LTUuOGwwLjEtMC4xYzAuOC0wLjYsMS42LTEuMSwyLjQtMS42bDExLjQtNy40bDE1LjktMTAuNGg3LjdDLTQ4LjgsMTkyLjktNDguNCwxOTMuNi00OC42LDE5NC4zeiIvPg0KPC9zdmc+DQo=
description: "# Introduction\n\nZenduty is a cutting edge platform for incident management. With high level automation, Zenduty enables faster and better incident resolution keeping developers first.\n\n\n Javascript Libraries: https://github.com/Zenduty/zenduty-js\n\n Ruby Libraries: https://github.com/Zenduty/zenduty-ruby\n\n Python Libraries: https://github.com/Zenduty/zenduty-python-sdk\n\n Postman Collection for Zenduty API: https://github.com/Zenduty/zenduty-api-postman.git\n\n Account-level roles and permissions: https://docs.zenduty.com/docs/users#account-level-roles-and-permissions\n\n Team-level roles and permissions: https://docs.zenduty.com/docs/users#team-level-roles-and-permissions\n"
servers:
- url: https://www.zenduty.com
security:
- bearerAuth: []
tags:
- name: Services
description: This object represents the services associated with a team. You can checkout the services docs here https://docs.zenduty.com/docs/services
paths:
/api/account/teams/{}/services/:
parameters:
- name: team_id
in: path
description: unique_id of the Team object
schema:
type: string
required: true
post:
tags:
- Services
summary: Create the Service object
description: Create the Service object by setting the values of all the required parameters passed in the request body.
requestBody:
description: Request body parameters to create the Service object
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ServicePayload'
example:
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
application/xml:
schema:
$ref: '#/components/schemas/ServicePayload'
example:
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
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ServicePostPut'
example:
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
application/xml:
schema:
$ref: '#/components/schemas/ServicePostPut'
example:
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
'400':
description: Bad Request
content:
application/json:
example:
detail: This request can not be processed.
application/xml:
example:
detail: This request can not be processed.
'403':
description: Forbidden
content:
application/json:
example:
detail: You do not have permission to perform this action.
application/xml:
example:
detail: You do not have permission to perform this action.
'404':
description: Not Found
content:
application/json:
example:
detail: Not Found.
application/xml:
example:
detail: Not Found.
get:
tags:
- Services
summary: List all Service objects
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceGet'
example:
- name: Infra Service
creation_date: '2022-07-08T12:31:37.429973Z'
summary: ''
description: This is the description for Infra Service
unique_id: 191f5e2c-515e-4ee0-b501-3a292f8dae2f
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: 1
collation_time: 2
- 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
application/xml:
schema:
$ref: '#/components/schemas/ServiceGet'
example:
- name: Infra Service
creation_date: '2022-07-08T12:31:37.429973Z'
summary: ''
description: This is the description for Infra Service
unique_id: 191f5e2c-515e-4ee0-b501-3a292f8dae2f
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: 1
collation_time: 2
- 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
'400':
description: Bad Request
content:
application/json:
example:
detail: This request can not be processed.
application/xml:
example:
detail: This request can not be processed.
'403':
description: Forbidden
content:
application/json:
example:
detail: You do not have permission to perform this action.
application/xml:
example:
detail: You do not have permission to perform this action.
'404':
description: Not Found
content:
application/json:
example:
detail: Not Found.
application/xml:
example:
detail: Not Found.
/api/account/teams/{team_id}/services/{service_id}/:
parameters:
- name: team_id
in: path
description: unique_id of the Team object
schema:
type: string
required: true
- name: service_id
in: path
description: unique_id of the Service object
schema:
type: string
required: true
get:
tags:
- Services
summary: Retrieve the Service object
description: Retrieve the specified Service object.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceGet'
example:
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
application/xml:
schema:
$ref: '#/components/schemas/ServiceGet'
example:
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
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
'400':
description: Bad Request
content:
application/json:
example:
detail: This request can not be processed.
application/xml:
example:
detail: This request can not be processed.
'403':
description: Forbidden
content:
application/json:
example:
detail: You do not have permission to perform this action.
application/xml:
example:
detail: You do not have permission to perform this action.
'404':
description: Not Found
content:
application/json:
example:
detail: Not Found.
application/xml:
example:
detail: Not Found.
put:
tags:
- Services
summary: Update the Service object
description: 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.
requestBody:
description: Request body parameters to update the Service object
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ServicePayload'
example:
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
application/xml:
schema:
$ref: '#/components/schemas/ServicePayload'
example:
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
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ServicePostPut'
example:
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
application/xml:
schema:
$ref: '#/components/schemas/ServicePostPut'
example:
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
'400':
description: Bad Request
content:
application/json:
example:
detail: This request can not be processed.
application/xml:
example:
detail: This request can not be processed.
'403':
description: Forbidden
content:
application/json:
example:
detail: You do not have permission to perform this action.
application/xml:
example:
detail: You do not have permission to perform this action.
'404':
description: Not Found
content:
application/json:
example:
detail: Not Found.
application/xml:
example:
detail: Not Found.
delete:
tags:
- Services
summary: Delete the Service object
description: Delete the specified Service object permanently.
responses:
'204':
description: Success
'400':
description: Bad Request
content:
application/json:
example:
detail: This request can not be processed.
application/xml:
example:
detail: This request can not be processed.
'403':
description: Forbidden
content:
application/json:
example:
detail: You do not have permission to perform this action.
application/xml:
example:
detail: You do not have permission to perform this action.
'404':
description: Not Found
content:
application/json:
example:
detail: Not Found.
application/xml:
example:
detail: Not Found.
components:
schemas:
ServiceGet:
description: Service object schema for List and Retrieve
type: object
properties:
name:
type: string
description: A string that represents the Service object's name
creation date:
type: string
format: date-time
description: A formatted string that represents the Service object's creation_date
summary:
type: string
description: A string that represents the Service object's summary
description:
type: string
description: A string that represents the Service object's description
unique_id:
type: string
description: A system-generated string that represents the Service object's unique_id
auto_resolve_timeout:
type: integer
default: 0
description: An integer that represents the timeout for automatically resolving an Incident
created_by:
type: string
description: A system-generated string that represents the User object's username
team_priority:
type: string
description: A system-generated string that represents the Priority object's unique_id
task_template:
type: string
description: A system-generated string that represents the Task Template object's unique_id
acknowlegement_timeout:
type: integer
default: 0
description: An integer that represents the timeout for acknowledging an Incident
status:
type: integer
default: 1
description: 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:
type: string
description: A system-generated string that represents the Escalation Policy object's unique_id
team:
type: string
description: A system-generated string that represents the Team object's unique_id
sla:
type: string
description: A system-generated string that represents the SLA object's unique_id
under_maintenance:
type: boolean
default: false
description: A boolean flag that represents whether the service object is under maintenance or not
collation:
type: integer
default: 0
description: An integer that represents the Service object's collation type. 0 is off, 1 is time-based.
collation_time:
type: integer
default: 0
description: 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.
ServicePayload:
type: object
description: Payload schema for the the Service object
required:
- team_priority
- escalation_policy
- sla
properties:
name:
type: string
description: A string that represents the Service object's name
summary:
type: string
description: A string that represents the Service object's summary
description:
type: string
description: A string that represents the Service object's description
auto_resolve_timeout:
type: integer
default: 0
description: An integer that represents the timeout for automatically resolving an Incident
team_priority:
type: string
description: A system-generated string that represents the Priority object's unique_id
task_template:
type: string
description: A system-generated string that represents the Task Template object's unique_id
acknowledgement_timeout_enabled:
type: boolean
default: false
description: 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:
type: integer
default: 600
description: 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:
type: integer
default: 1
description: 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:
type: string
description: A system-generated string that represents the Escalation Policy object's unique_id
sla:
type: string
description: A system-generated string that represents the SLA object's unique_id
under_maintenance:
type: boolean
default: false
description: A boolean flag that represents whether the service object is under maintenance or not
collation:
type: integer
default: 0
description: An integer that represents the Service object's collation type. 0 is off, 1 is time-based.
collation_time:
type: integer
default: 0
description: 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.
ServicePostPut:
description: Service object schema for Create and Update
type: object
properties:
name:
type: string
description: A string that represents the Service object's name
creation date:
type: string
format: date-time
description: A formatted string that represents the Service object's creation_date
summary:
type: string
description: A string that represents the Service object's summary
description:
type: string
description: A string that represents the Service object's description
unique_id:
type: string
description: A system-generated string that represents the Service object's unique_id
auto_resolve_timeout:
type: integer
default: 0
description: An integer that represents the timeout for automatically resolving an Incident
created_by:
type: string
description: A system-generated string that represents the User object's username
team_priority:
type: string
description: A system-generated string that represents the Priority object's unique_id
task_template:
type: string
description: A system-generated string that represents the Task Template object's unique_id
acknowlegement_timeout:
type: integer
default: 0
description: An integer that represents the timeout for acknowledging an Incident
status:
type: integer
default: 1
description: 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:
type: string
description: A system-generated string that represents the Escalation Policy object's unique_id
team:
type: string
description: A system-generated string that represents the Team object's unique_id
sla:
type: string
description: A system-generated string that represents the SLA object's unique_id
collation_time:
type: integer
default: 0
description: 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.
collation:
type: integer
default: 0
description: An integer that represents the Service object's collation type. 0 is off, 1 is time-based.
under_maintenance:
type: boolean
default: false
description: A boolean flag that represents whether the service object is under maintenance or not
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: Token <api_key>