Jump to Content
Home
Documentation
Recipes
API Reference
Contact Support
API Reference
Contact Support
Home
Documentation
Recipes
API Reference
FireHydrant API
All
Pages
Start typing to search…
JUMP TO
FireHydrant API
FireHydrant API
Call Routes
List call routes
get
List call routes for a team
get
Create a call route for a team
post
Retrieve a call route
get
Delete a call route
del
Update a call route
patch
Permissions
List permissions
get
Get all permissions for the current user
get
Get all permissions for a team
get
Roles
Get all roles
get
Create a role
post
Get a role
get
Delete a role
del
Update a role
patch
Audit Events
List audit events
get
Get a single audit event
get
Pages
Page a user, team, on-call schedule, or escalation policy
post
Account Settings
Check API connectivity
get
List entitlements
get
Check API connectivity
get
Get initial application configuration
get
Get AI preferences
get
Update AI preferences
patch
Alerts
List alerts for an incident
get
Attach an alert to an incident
post
Set an alert as primary for an incident
patch
Remove an alert from an incident
del
List alerts
get
Get an alert
get
List alert processing log entries
get
Update a Signal alert
patch
Audiences
List audiences
get
Create audience
post
Get audience
get
Archive audience
del
Update audience
patch
Restore audience
patch
Get default audience
get
Set default audience
put
Get latest summary
get
Generate summary (async)
post
List audience summaries
get
Changes
List changes
get
Create a new change entry
post
Archive a change entry
del
Update a change entry
patch
List identities for a change entry
get
Create an identity for a change entry
post
Delete an identity from a change entry
del
Update an identity for a change entry
patch
List change events
get
Create a change event
post
Get a change event
get
Delete a change event
del
Update a change event
patch
List change types
get
Communication
List status update templates
get
Create a status update template
post
Get a status update template
get
Delete a status update template
del
Update a status update template
patch
Conversations
Get votes
get
Update votes
patch
Delete a reaction from a conversation comment
del
List reactions for a conversation comment
get
Create a reaction for a conversation comment
post
Get a conversation comment
get
Archive a conversation comment
del
Update a conversation comment
patch
List comments for a conversation
get
Create a conversation comment
post
Incidents
List incidents
get
Create an incident
post
Get chat channel information for an incident
get
Close an incident
put
Resolve an incident
put
Get an incident
get
Archive an incident
del
Update an incident
patch
Unarchive an incident
post
Update milestone times
put
List incident milestones
get
List related changes on an incident
get
Add a related change to an incident
post
Update a change event attached to an incident
patch
List status pages for an incident
get
Add a status page to an incident
post
List links on an incident
get
Add a link to an incident
post
Update the external incident link
put
Remove a link from an incident
del
Update the attribution of a transcript
put
Lists all of the messages in the incident's transcript
get
Delete a transcript from an incident
del
Retrieve all conference bridges for an incident
get
Retrieve the translations for a specific conference bridge
get
List similar incidents
get
List attachments for an incident
get
Add an attachment to the incident timeline
post
List events for an incident
get
Get an incident event
get
Delete an incident event
del
Update an incident event
patch
Update impacts for an incident
put
Update impacts for an incident
patch
List impacted infrastructure for an incident
get
Add impacted infrastructure to an incident
post
Remove impacted infrastructure from an incident
del
Add a note to an incident
post
Update a note
patch
Add a chat message to an incident
post
Delete a chat message from an incident
del
Update a chat message on an incident
patch
List incident assignees
get
Assign a user to an incident
post
Unassign a user from an incident
del
Assign a team to an incident
post
Unassign a team from an incident
del
Get the current user's incident role
get
List incident relationships
get
List scheduled maintenance events
get
Create a scheduled maintenance event
post
Get a scheduled maintenance event
get
Delete a scheduled maintenance event
del
Update a scheduled maintenance event
patch
Get the current user's vote status for an AI-generated incident summary
get
Vote on an AI-generated incident summary
put
Incident Settings
List incident roles
get
Create an incident role
post
Get an incident role
get
Archive an incident role
del
Update an incident role
patch
Validate incident tags
post
List incident tags
get
List incident types
get
Create an incident type
post
Get an incident type
get
Archive an incident type
del
Update an incident type
patch
List measurement definitions
get
Create a measurement definition
post
Get a measurement definition
get
Archive a measurement definition
del
Update a measurement definition
patch
List phases and milestones
get
Create a milestone
post
Delete a milestone
del
Update a milestone
patch
List priorities
get
Create a priority
post
Get a priority
get
Delete a priority
del
Update a priority
patch
List severities
get
Create a severity
post
Get a severity
get
Delete a severity
del
Update a severity
patch
Get severity matrix
get
Update severity matrix
patch
List severity matrix conditions
get
Create a severity matrix condition
post
Get a severity matrix condition
get
Delete a severity matrix condition
del
Update a severity matrix condition
patch
List severity matrix impacts
get
Create a severity matrix impact
post
Delete a severity matrix impact
del
Update a severity matrix impact
patch
Delete a custom field definition
del
Update a custom field definition
patch
List custom field definitions
get
Create a custom field definition
post
Get available values for a custom field
get
Get a form configuration
get
Get data for a form field on select
get
Integrations
List integrations
get
Get an integration
get
Update field mapping
patch
List available fields for field mapping
get
Lists the available and configured integrations
get
Get an authed provider
patch
List integration connections
get
Create a new integration connection
post
Refresh an integration connection
patch
Update an integration connection
patch
Get integration connection status
get
Get an integration connection status
get
Get an integration connection status
get
List AWS connections
get
Get an AWS connection
get
Update an AWS connection
patch
List CloudTrail batches
get
Get a CloudTrail batch
get
Update a CloudTrail batch
patch
List events for an AWS CloudTrail batch
get
List Confluence spaces
get
List Slack workspaces
get
List Slack user groups
get
List Slack emoji actions
get
Create a new Slack emoji action
post
Get a Slack emoji action
get
Delete a Slack emoji action
del
Update a Slack emoji action
patch
List Statuspage connections
get
Get a Statuspage connection
get
Delete a Statuspage connection
del
Update a Statuspage connection
patch
List StatusPage pages for a connection
get
Search for Zendesk tickets
get
Search for Zendesk tickets
get
Metrics/Reporting
Get mean time metrics for incidents
get
List ticket task and follow up creation and completion metrics
get
List retrospective metrics
get
List milestone funnel metrics
get
List user metrics
get
List incident metrics and analytics
get
Get infrastructure metrics
get
List metrics for a component type
get
Get metrics for a component
get
Get a saved search
get
Delete a saved search
del
Update a saved search
patch
List saved searches
get
Create a saved search
post
Generate timeseries alert metrics
get
Generate grouped alert metrics
get
Get MTTX analytics for signals
get
Export on-call hours report
get
Get noise analytics for signals
get
Retrospectives
Share an incident's retrospective
post
Export an incident's retrospective(s)
post
All attached retrospectives for an incident
get
Create a new retrospective on the incident using the template
post
Update a retrospective on the incident
patch
Appends a new incident retrospective field to an incident retrospective
patch
Get a retrospective field
get
Update the value on a retrospective field
patch
Add a new dynamic input field to a retrospective's dynamic input group field
post
Removes a dynamic input from a retrospective's dynamic input group field
del
List retrospective reports
get
List retrospective reports
get
Create a retrospective report
post
Get a retrospective report
get
Update a retrospective report
patch
List contributing factors for a retrospective report
get
Create a contributing factor for a retrospective report
post
Delete a contributing factor from a retrospective report
del
Update a contributing factor in a retrospective report
patch
Reorder a contributing factor for a retrospective report
put
Publish a retrospective report
post
Update a retrospective field
patch
List retrospective questions
get
Update retrospective questions
put
Get a retrospective question
get
List retrospective templates
get
Create a retrospective template
post
Get a retrospective template
get
Delete a retrospective template
del
Update a retrospective template
patch
Runbooks
List runbook actions
get
List runbook executions
get
Create a runbook execution
post
Get a runbook execution
get
Terminate a runbook execution
del
Update a runbook step execution
put
Get a step's bash script
get
Update a script step's execution status
put
List select options for a runbook integration action field
get
List runbooks
get
Create a runbook
post
Get a runbook
get
Update a runbook
put
Delete a runbook
del
List runbook audits
get
SCIM
Get a SCIM group
get
Update a SCIM group and assign members
put
Delete a SCIM group
del
List SCIM groups
get
Create a SCIM group and assign members
post
Get a SCIM user
get
Update a User from SCIM data
put
Delete a User matching SCIM data
del
Update a User from SCIM data
patch
List SCIM users
get
Create a User from SCIM data
post
Partially update a SCIM group
patch
Catalog Entries
List environments
get
Create an environment
post
Get an environment
get
Archive an environment
del
Update an environment
patch
List services
get
Create a service
post
Create multiple services linked to external services
post
Get a service
get
Delete a service
del
Update a service
patch
List dependencies for a service
get
List available upstream service dependencies
get
List available downstream service dependencies
get
Delete a service link
del
Record a response for a checklist item
post
Create a service dependency
post
Get a service dependency
get
Delete a service dependency
del
Update a service dependency
patch
List functionalities
get
Create a functionality
post
Get a functionality
get
Archive a functionality
del
Update a functionality
patch
List services for a functionality
get
List services owned by a user's teams
get
Lists functionality, service and environment objects
get
Refresh a service catalog
get
Ingest service catalog data
post
List services for an environment
get
List functionalities for an environment
get
List environments for a service
get
List environments for a functionality
get
Signals
List escalation policies for a team
get
Create an escalation policy for a team
post
Get an escalation policy for a team
get
Delete an escalation policy for a team
del
Update an escalation policy for a team
patch
List on-call schedules for a team
get
Preview a new on-call schedule for a team
post
Create an on-call schedule for a team
post
Get an on-call schedule for a team
get
Delete an on-call schedule for a team
del
Update an on-call schedule for a team
patch
Create a shift for an on-call schedule
post
Get an on-call shift for a team schedule
get
Preview an on-call rotation
post
Delete an on-call shift from a team schedule
del
Create a new on-call rotation
post
Update an on-call shift for a team schedule
patch
Copy an on-call schedule's rotation
post
List Signals rules
get
Get an on-call rotation
get
Create a Signals rule
post
Delete an on-call schedule's rotation
del
Get a Signals rule
get
Update an on-call schedule's rotation
patch
Delete a Signals rule
del
Override one or more shifts in an on-call rotation
post
Update a Signals rule
patch
List event sources for Signals
get
List email targets for signals
get
Create an event source for Signals
put
Create an email target for signals
post
Get an event source for Signals
get
Get a signal email target
get
Delete an event source for Signals
del
Delete a signal email target
del
List alert grouping configurations.
get
Get hacker mode status
get
Update an email target
patch
Create an alert grouping configuration.
post
List webhook targets
get
Get an alert grouping configuration.
get
Create a webhook target
post
Delete an alert grouping configuration.
del
Get a webhook target
get
Update an alert grouping configuration.
patch
Delete a webhook target
del
Update a webhook target
patch
List signal transposers
get
Get the signals ingestion URL
get
Debug Signals expressions
post
List who's on call for the organization
get
List notification policies
get
Get a notification policy
get
Delete a notification policy
del
Update a notification policy
patch
Create a notification policy
post
Status Pages
Remove a status page from an incident
del
List status pages
get
Create a status page
post
List status page subscribers
get
Add subscribers to a status page
post
Remove subscribers from a status page
del
Get a status page
get
Update a status page
put
Delete a status page
del
Delete a status page component group
del
Update a status page component group
patch
Create a component group for a status page
post
Delete a status page link
del
Update a status page link
patch
Add link to a status page
post
Upload an image for a status page
put
Delete an image from a status page
del
Unsubscribe from status page notifications
del
Create a status page subscription
post
Unpublish a status page
post
Publish a status page
post
Tasks
Add tasks from a task list to an incident
post
List tasks for an incident
get
Create an incident task
post
Get an incident task
get
Delete an incident task
del
Update an incident task
patch
Convert a task to a follow-up
post
List task lists
get
Create a task list
post
Get a task list
get
Delete a task list
del
Update a task list
patch
List checklist templates
get
Create a checklist template
post
Get a checklist template
get
Archive a checklist template
del
Update a checklist template
patch
Teams
List teams
get
Create a team
post
Get a team
get
Archive a team
del
Update a team
patch
List schedules
get
Ticketing
List tickets
get
Create a ticket
post
Get a ticket
get
Archive a ticket
del
Update a ticket
patch
List ticketing projects
get
Get a ticketing project
get
List configuration options for a ticketing project
get
List a field's configuration options for a ticketing project
get
List available fields for ticket field mapping
get
Create a field mapping for a ticketing project
post
Get a field map for a ticketing project
get
Archive a field map for a ticketing project
del
Update a field map for a ticketing project
patch
List available fields for ticket field mapping
get
List inbound field maps for a ticketing project
get
Create inbound field map for a ticketing project
post
Get inbound field map for a ticketing project
get
Update inbound field map for a ticketing project
put
Archive inbound field map for a ticketing project
del
Create a ticketing project configuration
post
Get configuration for a ticketing project
get
Archive a ticketing project configuration
del
Update configuration for a ticketing project
patch
List ticketing priorities
get
Create a ticketing priority
post
Get a ticketing priority
get
Delete a ticketing priority
del
Update a ticketing priority
patch
List ticket tags
get
Users
List users
get
Get a user
get
Get the currently authenticated user
get
Webhooks
List webhooks
get
Create a webhook
post
List webhook deliveries
get
Get a webhook
get
Delete a webhook
del
Update a webhook
patch
Ticketing
Get the ticketing form configuration
get
List ticketing custom fields
get
Create a ticketing custom field
post
Delete a ticketing custom field
del
Update a ticketing custom field
patch
Retrospectives
Powered by
FireHydrant API
Ask AI
