Qodex.ai
Qodex.ai
Introduction
Squadcast
OAuth
Access Token
Incidents-Postmortems
Get Postmortem By IncidentCreate PostmortemUpdate Postmortem By IncidentDelete Postmortem By IncidentGet All Postmortems
Incidents-Runbooks
Attach Runbooks
Incidents-Notes
Update NoteDelete NoteCreate NotesGet All Notes
Incidents-Communication Card
Archive Slack ChannelDelete Communication CardCreate Slack Channel in Communication CardUpdate Communication CardCreate Communication CardGet All Communication Card
Incidents-Tags
Append TagUpdate Tag
Incidents-Auto Pause Transient Alerts (APTA)
Mark as Not TransientMark as Transient
Incidents-Snooze Notifications
Snooze Incident NotificationsUnsnooze Incident Notifications
Incidents-Additional Responders
Remove Additional RespondersGet Additional RespondersAdd Additional Responders
Incidents
Bulk Incidents Priority UpdateReassign IncidentIncident Export AsyncAcknowledge IncidentGet Incident EventsGet Incidents Status By RequestIDsMark Incident SLO False PositiveGet Incident by IDIncident Priority UpdateResolve IncidentBulk Acknowledge IncidentsBulk Resolve IncidentsIncident Export
New Schedules-On-call Events (REST API)
Who Is on-callOn Call Hours Per User
Legacy Schedules-Oncall Events
Update On-call EventCreate On-call EventGet All On-call EventsGet On-call Event By IDDelete On-call Event
Legacy Schedules
Get schedules by teamGet Who Is On-CallGet schedules by IDCreate SchedulesDelete ScheduleGet Schedule GapsUpdate Schedule
Services-Tagging Rules
Get Tagging RulesCreate or Update Tagging Rules
Services-Maintenance Mode
Get Maintenance ModeCreate or Update Maintenance Mode
Services-Dependencies
Create or Update Dependencies
Services-Routing Rules
Get Routing RulesCreate or Update Routing Rules
Services-Deduplication Rules
Create or Update Deduplication RulesGet Deduplication Rules
Services-Suppression Rules
Create or Update Suppression RulesGet suppression rules
Services-Extensions
slack
Services-Overlay-Dedup Key Overlay-Opt-in
Opt-in for Key Based Deduplication for a serviceGet Opt-in for Key Based Deduplication for a service
Services-Overlay-Dedup Key Overlay
Delete Dedup Key OverlayGet Dedup Key Overlay for Alert SourceUpdate Dedup Key OverlayGet All Dedup Key Overlay by ServiceRender Dedup Key template
Services-Overlay-Custom Content Templates
Get Custom Content Template OverlayCreate or Update Notification Template OverlayDelete Notification Template OverlayGet All Custom Content Template Overlay by ServiceRender Custom Content Overlay
Services-Overlay
Get Overlay for Alert SourceGet All Overlays for Service
Services
Get Service By teamDelayed Notification ConfigDelete ServiceGet Services By NameCreate ServiceIntelligent Alert Grouping (IAG)Update ServiceAuto Pause Transient Alerts (APTA)Get Service By ID
Squads
Get Squad By teamCreate SquadDelete SquadGet Squad By IDUpdate Squad
Squads(v4)-Members
Update Squad MemberRemove Squad Member
Squads(v4)
Get Squad By IDUpdate SquadUpdate Squad NameGet All SquadsCreate Squad
Users-Api Token
Get All TokensCreate TokenRemove Token
Users
Update Organization Level PermissionsGet All UsersGet User RolesRemove User From OrgDelete UserGet User By IDAdd User
Teams-Roles
Update Team RoleRemove Team RoleCreate Team RoleGet All Team Roles
Teams-Members
Remove Team MemberGet All Team MembersAdd Team MemberAdd Bulk Team MemberUpdate Team Member
Teams
Update TeamGet Team By IDCreate TeamRemove TeamGet All Teams
Escalation Policies
Get Escalation Policy By teamGet Escalation Policy By IDCreate Escalation PoliciesUpdate Escalation PolicyRemove Escalation Policy
Extensions-Webhooks
Create WebhookGet Webhook By IDUpdate WebhookGet All WebhooksDelete Webhook
Extensions-MSTeams
Get MSTeams ConfigCreate MSTeams Configuration
Runbooks
Get All Runbooks By TeamCreate RunbookUpdate RunbookGet Runbook By IDRemove Runbook
SLOs
Mark SLO AffectedMark SLO False PositiveGet All SLOsRemove SLOCreate SLOGet SLO By ID
Webforms
Remove WebformCreate WebformGet Webform By IDGet All Webforms
Analytics
Get Org level analyticsGet Team level analytics
Export
Get Export Details
Status Pages-Issues
Update IssueGet Issue By IDList IssuesCreate IssueList Status Page Issue StatesDelete Issue By ID
Status Pages-Maintenances
Create MaintenanceGet Maintenance By IDList MaintenancesUpdate Maintenance By IDDelete Maintenance By ID
Status Pages-Components
List ComponentsDelete Component By IDGet Component By IDCreate ComponentUpdate Component By ID
Status Pages-Component groups
Delete Component Group By IDGet Component Group By IDCreate Component GroupList Component Groups
Status Pages-Subscribers
List Subscribers
Status Pages
List Status PagesDelete Status Page By IDList Status Page StatusesUpdate Status Page By IDGet Status Page By IDCreate Status Page
Global Event Rules-Rulesets-Rules
Create RuleReorder Ruleset By IndexUpdate Rule by IDDelete Rule by IDList Ruleset RulesGet Rule by ID
Global Event Rules-Rulesets
Get RulesetUpdate RulesetDelete GER RulesetCreate RulesetReorder Ruleset
Global Event Rules
List Global Event RulesCreate Global Event RuleDelete Global Event Rule by IDUpdate Global Event Rule by IDGet Global Event Rule by ID
Workflows
List WorkflowsEnable/Disable WorkflowUpdate Workflow ActionCreate ActionGet Workflow LogsGet Workflow By IDBulk Enable/Disable WorkflowsCreate WorkflowDelete WorkflowDelete Workflow ActionUpdate Actions OrderGet Workflow Action By IDUpdate Workflow
Global Oncall Reminder Rules
Update Global Oncall Reminder RulesDelete Global Oncall Reminder RulesGet Global Oncall Reminder RulesCreate Global Oncall Reminder Rules
Squadcast API V3 - staging
OAuth
Access Token
Incidents-Postmortems
Get Postmortems by team
Incidents-StatusPage Messages
Get All StatusPage MessagesPublish New StatusPage Message
Incidents-Notes
Update NoteDelete NoteGet All NotesCreate Notes
Incidents-Communication Card
Update Communication CardCreate Slack Channel in Communication CardArchive Slack ChannelCreate Communication CardDelete Communication CardGet All Communication Card
Incidents-Tags
Update Tag
Incidents
Get Incident by IDIncident ExportAcknowledge IncidentReassign IncidentGet Incidents Status By RequestIDsIncident Priority UpdateResolve IncidentBulk Incidents Priority UpdateBulk Resolve IncidentsBulk Acknowledge IncidentsGet Incident EventsIncident Export Async
Schedules-Oncall Events
Delete On-call EventGet All On-call EventsCreate On-call EventUpdate On-call EventGet On-call Event By ID
Schedules
Get schedules by teamCreate SchedulesGet schedules by IDGet Who Is On-CallUpdate ScheduleDelete ScheduleGet Schedule Gaps
Services-Tagging Rules
Get Tagging RulesCreate or Update Tagging Rules
Services-Maintenance Mode
Get Maintenance ModeCreate or Update Maintenance Mode
Services-Dependencies
Create or Update Dependencies
Services-Routing Rules
Get Routing RulesCreate or Update Routing Rules
Services-Deduplication Rules
Get Deduplication RulesCreate or Update Deduplication Rules
Services-Suppression Rules
Get suppression rulesCreate or Update Suppression Rules
Services
Get Service By teamCreate ServiceUpdate ServiceDelete ServiceGet Service By ID
Squads
Get Squad By teamCreate SquadGet Squad By IDUpdate SquadDelete Squad
Users-Api Token
Create TokenGet All TokensRemove Token
Users
Update Organization Level PermissionsRemove UserAdd UserGet User By IDGet All UsersGet User Roles
Teams-Roles
Create Team RoleUpdate Team RoleRemove Team RoleGet All Team Roles
Teams
Get Team By IDRemove TeamGet All TeamsUpdate TeamCreate Team
Escalation Policies
Get Escalation Policy By teamUpdate Escalation PolicyRemove Escalation PolicyCreate Escalation PoliciesGet Escalation Policy By ID
Extensions-Webhooks
Get Webhook By IDGet All WebhooksCreate WebhookUpdate WebhookDelete Webhook
Runbooks
Get All Runbooks By TeamRemove RunbookGet Runbook By IDUpdate RunbookCreate Runbook
Slos
Get Slo By IDCreate SloRemove SloGet All Slos
Webforms
Get All WebformsGet Webform By IDCreate WebformRemove Webform
Analytics
Get Org level analyticsGet Team level analytics
Export
Get Export Details
New Schedules-On-call Events
Who Is on-call
Workflows
Get Workflow LogsGet Workflow Action By IDList WorkflowsDelete WorkflowEnable/Disable WorkflowUpdate WorkflowUpdate Actions OrderGet Workflow By IDUpdate Workflow ActionCreate WorkflowBulk Enable/Disable WorkflowsDelete Workflow ActionCreate Action
TODO: Publish
To Export
Delayed Notification Config Copy
Introduction
Squadcast
OAuth
Access Token
Incidents-Postmortems
Get Postmortem By IncidentCreate PostmortemUpdate Postmortem By IncidentDelete Postmortem By IncidentGet All Postmortems
Incidents-Runbooks
Attach Runbooks
Incidents-Notes
Update NoteDelete NoteCreate NotesGet All Notes
Incidents-Communication Card
Archive Slack ChannelDelete Communication CardCreate Slack Channel in Communication CardUpdate Communication CardCreate Communication CardGet All Communication Card
Incidents-Tags
Append TagUpdate Tag
Incidents-Auto Pause Transient Alerts (APTA)
Mark as Not TransientMark as Transient
Incidents-Snooze Notifications
Snooze Incident NotificationsUnsnooze Incident Notifications
Incidents-Additional Responders
Remove Additional RespondersGet Additional RespondersAdd Additional Responders
Incidents
Bulk Incidents Priority UpdateReassign IncidentIncident Export AsyncAcknowledge IncidentGet Incident EventsGet Incidents Status By RequestIDsMark Incident SLO False PositiveGet Incident by IDIncident Priority UpdateResolve IncidentBulk Acknowledge IncidentsBulk Resolve IncidentsIncident Export
New Schedules-On-call Events (REST API)
Who Is on-callOn Call Hours Per User
Legacy Schedules-Oncall Events
Update On-call EventCreate On-call EventGet All On-call EventsGet On-call Event By IDDelete On-call Event
Legacy Schedules
Get schedules by teamGet Who Is On-CallGet schedules by IDCreate SchedulesDelete ScheduleGet Schedule GapsUpdate Schedule
Services-Tagging Rules
Get Tagging RulesCreate or Update Tagging Rules
Services-Maintenance Mode
Get Maintenance ModeCreate or Update Maintenance Mode
Services-Dependencies
Create or Update Dependencies
Services-Routing Rules
Get Routing RulesCreate or Update Routing Rules
Services-Deduplication Rules
Create or Update Deduplication RulesGet Deduplication Rules
Services-Suppression Rules
Create or Update Suppression RulesGet suppression rules
Services-Extensions
slack
Services-Overlay-Dedup Key Overlay-Opt-in
Opt-in for Key Based Deduplication for a serviceGet Opt-in for Key Based Deduplication for a service
Services-Overlay-Dedup Key Overlay
Delete Dedup Key OverlayGet Dedup Key Overlay for Alert SourceUpdate Dedup Key OverlayGet All Dedup Key Overlay by ServiceRender Dedup Key template
Services-Overlay-Custom Content Templates
Get Custom Content Template OverlayCreate or Update Notification Template OverlayDelete Notification Template OverlayGet All Custom Content Template Overlay by ServiceRender Custom Content Overlay
Services-Overlay
Get Overlay for Alert SourceGet All Overlays for Service
Services
Get Service By teamDelayed Notification ConfigDelete ServiceGet Services By NameCreate ServiceIntelligent Alert Grouping (IAG)Update ServiceAuto Pause Transient Alerts (APTA)Get Service By ID
Squads
Get Squad By teamCreate SquadDelete SquadGet Squad By IDUpdate Squad
Squads(v4)-Members
Update Squad MemberRemove Squad Member
Squads(v4)
Get Squad By IDUpdate SquadUpdate Squad NameGet All SquadsCreate Squad
Users-Api Token
Get All TokensCreate TokenRemove Token
Users
Update Organization Level PermissionsGet All UsersGet User RolesRemove User From OrgDelete UserGet User By IDAdd User
Teams-Roles
Update Team RoleRemove Team RoleCreate Team RoleGet All Team Roles
Teams-Members
Remove Team MemberGet All Team MembersAdd Team MemberAdd Bulk Team MemberUpdate Team Member
Teams
Update TeamGet Team By IDCreate TeamRemove TeamGet All Teams
Escalation Policies
Get Escalation Policy By teamGet Escalation Policy By IDCreate Escalation PoliciesUpdate Escalation PolicyRemove Escalation Policy
Extensions-Webhooks
Create WebhookGet Webhook By IDUpdate WebhookGet All WebhooksDelete Webhook
Extensions-MSTeams
Get MSTeams ConfigCreate MSTeams Configuration
Runbooks
Get All Runbooks By TeamCreate RunbookUpdate RunbookGet Runbook By IDRemove Runbook
SLOs
Mark SLO AffectedMark SLO False PositiveGet All SLOsRemove SLOCreate SLOGet SLO By ID
Webforms
Remove WebformCreate WebformGet Webform By IDGet All Webforms
Analytics
Get Org level analyticsGet Team level analytics
Export
Get Export Details
Status Pages-Issues
Update IssueGet Issue By IDList IssuesCreate IssueList Status Page Issue StatesDelete Issue By ID
Status Pages-Maintenances
Create MaintenanceGet Maintenance By IDList MaintenancesUpdate Maintenance By IDDelete Maintenance By ID
Status Pages-Components
List ComponentsDelete Component By IDGet Component By IDCreate ComponentUpdate Component By ID
Status Pages-Component groups
Delete Component Group By IDGet Component Group By IDCreate Component GroupList Component Groups
Status Pages-Subscribers
List Subscribers
Status Pages
List Status PagesDelete Status Page By IDList Status Page StatusesUpdate Status Page By IDGet Status Page By IDCreate Status Page
Global Event Rules-Rulesets-Rules
Create RuleReorder Ruleset By IndexUpdate Rule by IDDelete Rule by IDList Ruleset RulesGet Rule by ID
Global Event Rules-Rulesets
Get RulesetUpdate RulesetDelete GER RulesetCreate RulesetReorder Ruleset
Global Event Rules
List Global Event RulesCreate Global Event RuleDelete Global Event Rule by IDUpdate Global Event Rule by IDGet Global Event Rule by ID
Workflows
List WorkflowsEnable/Disable WorkflowUpdate Workflow ActionCreate ActionGet Workflow LogsGet Workflow By IDBulk Enable/Disable WorkflowsCreate WorkflowDelete WorkflowDelete Workflow ActionUpdate Actions OrderGet Workflow Action By IDUpdate Workflow
Global Oncall Reminder Rules
Update Global Oncall Reminder RulesDelete Global Oncall Reminder RulesGet Global Oncall Reminder RulesCreate Global Oncall Reminder Rules
Squadcast API V3 - staging
OAuth
Access Token
Incidents-Postmortems
Get Postmortems by team
Incidents-StatusPage Messages
Get All StatusPage MessagesPublish New StatusPage Message
Incidents-Notes
Update NoteDelete NoteGet All NotesCreate Notes
Incidents-Communication Card
Update Communication CardCreate Slack Channel in Communication CardArchive Slack ChannelCreate Communication CardDelete Communication CardGet All Communication Card
Incidents-Tags
Update Tag
Incidents
Get Incident by IDIncident ExportAcknowledge IncidentReassign IncidentGet Incidents Status By RequestIDsIncident Priority UpdateResolve IncidentBulk Incidents Priority UpdateBulk Resolve IncidentsBulk Acknowledge IncidentsGet Incident EventsIncident Export Async
Schedules-Oncall Events
Delete On-call EventGet All On-call EventsCreate On-call EventUpdate On-call EventGet On-call Event By ID
Schedules
Get schedules by teamCreate SchedulesGet schedules by IDGet Who Is On-CallUpdate ScheduleDelete ScheduleGet Schedule Gaps
Services-Tagging Rules
Get Tagging RulesCreate or Update Tagging Rules
Services-Maintenance Mode
Get Maintenance ModeCreate or Update Maintenance Mode
Services-Dependencies
Create or Update Dependencies
Services-Routing Rules
Get Routing RulesCreate or Update Routing Rules
Services-Deduplication Rules
Get Deduplication RulesCreate or Update Deduplication Rules
Services-Suppression Rules
Get suppression rulesCreate or Update Suppression Rules
Services
Get Service By teamCreate ServiceUpdate ServiceDelete ServiceGet Service By ID
Squads
Get Squad By teamCreate SquadGet Squad By IDUpdate SquadDelete Squad
Users-Api Token
Create TokenGet All TokensRemove Token
Users
Update Organization Level PermissionsRemove UserAdd UserGet User By IDGet All UsersGet User Roles
Teams-Roles
Create Team RoleUpdate Team RoleRemove Team RoleGet All Team Roles
Teams
Get Team By IDRemove TeamGet All TeamsUpdate TeamCreate Team
Escalation Policies
Get Escalation Policy By teamUpdate Escalation PolicyRemove Escalation PolicyCreate Escalation PoliciesGet Escalation Policy By ID
Extensions-Webhooks
Get Webhook By IDGet All WebhooksCreate WebhookUpdate WebhookDelete Webhook
Runbooks
Get All Runbooks By TeamRemove RunbookGet Runbook By IDUpdate RunbookCreate Runbook
Slos
Get Slo By IDCreate SloRemove SloGet All Slos
Webforms
Get All WebformsGet Webform By IDCreate WebformRemove Webform
Analytics
Get Org level analyticsGet Team level analytics
Export
Get Export Details
New Schedules-On-call Events
Who Is on-call
Workflows
Get Workflow LogsGet Workflow Action By IDList WorkflowsDelete WorkflowEnable/Disable WorkflowUpdate WorkflowUpdate Actions OrderGet Workflow By IDUpdate Workflow ActionCreate WorkflowBulk Enable/Disable WorkflowsDelete Workflow ActionCreate Action
TODO: Publish
To Export
Delayed Notification Config Copy
HomeSquadcastServices-Overlay

Services-Overlay

Number of APIs: 2

  1. Get Overlay for Alert Source GET {{baseUrl}}/services/:serviceID/overlays/:alertSource

  2. Get All Overlays for Service GET {{baseUrl}}/services/:serviceID/overlays/

Previous
Render Custom Content Overlay
Next
Get Overlay for Alert Source