FireHydrant API
FireHydrant API
Home
Help
No results found.
ping
getV1Ping
get
environments
postV1Environments
post
getV1Environments
get
deleteV1EnvironmentsEnvironmentId
delete
patchV1EnvironmentsEnvironmentId
patch
getV1EnvironmentsEnvironmentId
get
services
Create a service
post
List all services
get
translation missing: en.api.services.delete.summary
delete
Update a service
patch
Retrieve a single service
get
functionalities
Create a functionality
post
List all functionalities
get
Archive a functionality
delete
Update a functionality
patch
Retrieve a single functionality
get
teams
postV1Teams
post
getV1Teams
get
patchV1TeamsTeamId
patch
getV1TeamsTeamId
get
changes
postV1Changes
post
getV1Changes
get
deleteV1ChangesChangeId
delete
patchV1ChangesChangeId
patch
postV1ChangesChangeIdIdentities
post
getV1ChangesChangeIdIdentities
get
deleteV1ChangesChangeIdIdentitiesIdentityId
delete
patchV1ChangesChangeIdIdentitiesIdentityId
patch
Create a change event
post
List change events
get
Delete a change event
delete
Update a change event
patch
Retrieve a change event
get
change_types
getV1ChangeTypes
get
incidents
getV1IncidentsIncidentIdEvents
get
patchV1IncidentsIncidentIdEventsEventId
patch
getV1IncidentsIncidentIdEventsEventId
get
Returns the status of the votes
get
patchV1IncidentsIncidentIdEventsEventIdVotes
patch
getV1IncidentsIncidentIdCounts
get
postV1IncidentsIncidentIdNotes
post
patchV1IncidentsIncidentIdNotesNoteId
patch
List all assignees
get
Assign a role
post
Unassign a role
delete
getV1IncidentsIncidentIdUsersUserId
get
postV1IncidentsIncidentIdTeamAssignments
post
postV1IncidentsIncidentIdAttachments
post
postV1Incidents
post
getV1Incidents
get
getV1IncidentsIncidentIdChannel
get
putV1IncidentsIncidentIdResolve
put
Archive an incident
delete
patchV1IncidentsIncidentId
patch
getV1IncidentsIncidentId
get
putV1IncidentsIncidentIdImpact
put
postV1IncidentsIncidentIdImpactType
post
getV1IncidentsIncidentIdImpactType
get
deleteV1IncidentsIncidentIdImpactTypeId
delete
postV1IncidentsIncidentIdRelatedChangeEvents
post
getV1IncidentsIncidentIdRelatedChangeEvents
get
patchV1IncidentsIncidentIdRelatedChangeEventsRelatedChangeEventId
patch
getV1IncidentsIncidentIdTasks
get
patchV1IncidentsIncidentIdTasksTaskId
patch
postV1IncidentsIncidentIdAlerts
post
getV1IncidentsIncidentIdAlerts
get
patchV1IncidentsIncidentIdAlertsIncidentAlertIdPrimary
patch
deleteV1IncidentsIncidentIdAlertsIncidentAlertId
delete
postV1IncidentsIncidentIdActionItems
post
getV1IncidentsIncidentIdActionItems
get
deleteV1IncidentsIncidentIdActionItemsActionItemId
delete
patchV1IncidentsIncidentIdActionItemsActionItemId
patch
postV1IncidentsIncidentIdStatusPages
post
getV1IncidentsIncidentIdStatusPages
get
deleteV1IncidentsIncidentIdStatusPagesStatusPageId
delete
putV1IncidentsIncidentIdMilestonesBulkUpdate
put
getV1IncidentsIncidentIdMilestones
get
events
getV1Events
get
patchV1EventsEventId
patch
getV1EventsEventId
get
Returns the status of the votes
get
patchV1EventsEventIdVotes
patch
notes
postV1Notes
post
patchV1NotesNoteId
patch
incident_roles
getV1IncidentRoles
get
postV1IncidentRoles
post
deleteV1IncidentRolesIncidentRoleId
delete
patchV1IncidentRolesIncidentRoleId
patch
getV1IncidentRolesIncidentRoleId
get
attachments
postV1Attachments
post
integrations
translation missing: en.api.integrations.statuspage.connections.delete.summary
delete
translation missing: en.api.integrations.statuspage.connections.update.summary
patch
translation missing: en.api.integrations.statuspage.connections.retrieve.summary
get
getV1IntegrationsStatuspageConnectionsIdPages
get
translation missing: en.api.integrations.statuspage.connections.list.summary
get
translation missing: en.api.integrations.aws.cloudtrail_batches.update.summary
patch
translation missing: en.api.integrations.aws.cloudtrail_batches.retrieve.summary
get
getV1IntegrationsAwsCloudtrailBatchesIdEvents
get
translation missing: en.api.integrations.aws.cloudtrail_batches.list.summary
get
translation missing: en.api.integrations.aws.connections.update.summary
patch
translation missing: en.api.integrations.aws.connections.retrieve.summary
get
translation missing: en.api.integrations.aws.connections.list.summary
get
getV1IntegrationsConnections
get
users
getV1Users
get
release_notes
translation missing: en.api.release_notes.list.summary
get
translation missing: en.api.release_notes.retrieve.summary
get
reports
getV1ReportsMeanTime
get
metrics
getV1MetricsIncidents
get
runbooks
List all runbook actions
get
postV1RunbooksExecutions
post
List all executions of runbooks
get
translation missing: en.api.runbooks.executions.delete.summary
delete
Returns the status of the votes
get
patchV1RunbooksExecutionsExecutionIdVotes
patch
translation missing: en.api.runbooks.executions.step.update.summary
put
Returns the status of the votes
get
patchV1RunbooksExecutionsExecutionIdStepsStepIdVotes
patch
Retrieves the bash script from a "script" step.
get
Updates the execution's step.
put
getV1RunbooksSelectOptionsIntegrationSlugActionSlugField
get
translation missing: en.api.runbooks.create.summary
post
translation missing: en.api.runbooks.list.summary
get
translation missing: en.api.runbooks.delete.summary
delete
translation missing: en.api.runbooks.update.summary
put
translation missing: en.api.runbooks.retrieve.summary
get
nunc_connections
translation missing: en.api.nunc_connections.create.summary
post
translation missing: en.api.nunc_connections.delete.summary
delete
translation missing: en.api.nunc_connections.update.summary
put
translation missing: en.api.nunc_connections.retrieve.summary
get
saved_searches
Delete a specific saved search
delete
Update a specific saved search
patch
Retrieve a specific save search
get
Lists save searches
get
Create saved search
post
webhooks
Create webhook
post
Lists webhooks
get
Delete a specific webhook
delete
Update a specific webhook
patch
Retrieve a specific webhook
get
severities
Create severity
post
Lists severities
get
Delete a specific severity
delete
Update a specific severity
patch
Retrieve a specific severity
get
severity_matrix
translation missing: en.api.severity_matrix.update.summary
patch
translation missing: en.api.severity_matrix.retrieve.summary
get
Lists conditions
get
Create condition
post
Delete a specific condition
delete
Update a specific condition
patch
Lists impacts
get
Create impact
post
Delete a specific impact
delete
Update a specific impact
patch
scheduled_maintenances
translation missing: en.api.scheduled_maintenances.create.summary
post
translation missing: en.api.scheduled_maintenances.list.summary
get
translation missing: en.api.scheduled_maintenances.delete.summary
delete
translation missing: en.api.scheduled_maintenances.update.summary
patch
translation missing: en.api.scheduled_maintenances.retrieve.summary
get
schedules
translation missing: en.api.schedules.list.summary
get
infrastructures
Lists functionality, service and environment objects
get
nunc
deleteV1NuncSubscriptionsUnsubscribeToken
delete
postV1NuncSubscriptions
post
organizations
getV1OrganizationsOrganizationIdGamedayReadiness
get
post_mortems
patchV1PostMortemsReportsReportId
patch
getV1PostMortemsReportsReportId
get
postV1PostMortemsReports
post
getV1PostMortemsReports
get
deleteV1PostMortemsReportsReportIdTags
delete
putV1PostMortemsReportsReportIdTags
put
getV1PostMortemsReportsReportIdParticipantsSearch
get
deleteV1PostMortemsReportsReportIdParticipantsParticipantId
delete
postV1PostMortemsReportsReportIdParticipants
post
getV1PostMortemsReportsReportIdParticipants
get
getV1PostMortemsReportsReportIdIncidentEvents
get
translation missing: en.api.post_mortems.report_events.list.summary
get
translation missing: en.api.post_mortems.incident_event.create.summary
delete
Create a report event
post
Update a report event
patch
Delete a report event
delete
Create a note as a report event
post
Update a report note
patch
postV1PostMortemsReportsReportIdReasons
post
getV1PostMortemsReportsReportIdReasons
get
patchV1PostMortemsReportsReportIdReasonsReasonId
patch
deleteV1PostMortemsReportsReportIdReasonsReasonId
delete
putV1PostMortemsReportsReportIdReasonsOrder
put
patchV1PostMortemsReportsReportIdFieldsFieldId
patch
getV1PostMortemsReportsReportIdActionItems
get
postV1PostMortemsReportsReportIdActionItems
post
deleteV1PostMortemsReportsReportIdActionItemsActionItemId
delete
patchV1PostMortemsReportsReportIdActionItemsActionItemId
patch
Publish a postmortem report
post
getV1PostMortemsTags
get
alerts
getV1Alerts
get
ticketing
Create a ticket
post
List all functionalities
get
deleteV1TicketingTicketsTicketId
delete
Update a ticket
patch
Retrieve a single ticket
get
noauth
getV1NoauthPing
get
Models
ActionConfigEntity
ActionItemEntity
ActionItemEntityPaginated
ActionsEntity
ActionsEntityPaginated
ActorEntity
AlertEntity
AlertEntityPaginated
AuthorEntity
BaseServiceEntity
BucketEntity
ChangeEntity
ChangeEntityPaginated
ChangeEventEntity
ChangeEventSlimEntity
ChangeEventSlimEntityPaginated
ChangeIdentityEntity
ChangeIdentityEntityPaginated
ChangeTypeEntity
ChangeTypeEntityPaginated
CloudtrailBatchEntity
CloudtrailBatchEntityPaginated
ConditionEntity
ConnectionEntity
ConnectionEntityPaginated
DataPointEntity
ElementDynamicSelectEntity
ElementEntity
ElementInputEntity
ElementMarkdownEntity
ElementTextareaEntity
EnvironmentEntity
EnvironmentEntityPaginated
ErrorEntity
EventEntity
ExecutionEntity
ExecutionEntityPaginated
ExecutionStepEntity
ExecutionStepExecutionEntity
FunctionalityEntity
ImpactEntity
IncidentAttachmentEntity
IncidentEntity
IncidentEntityPaginated
IncidentEventEntity
IncidentEventEntityPaginated
IncidentImpactEntity
IncidentImpactEntityPaginated
IncidentRoleEntity
IncidentRoleEntityPaginated
IncidentRoleSuccinctEntity
IncidentRoleTaskEntity
IncidentTeamAssignmentsEntity
InfrastructureSearchEntity
IntegrationEntity
ItemEntity
MembershipEntity
MetricsEntity
MilestoneEntity
MilestoneEntityPaginated
NoteEntity
NuncComponentEntity
NuncConditionEntity
NuncConnectionEntity
NuncLogoEntity
NuncSubscription
OrganizationEntity
PaginationEntity
ParticipantEntity
ParticipantEntityPaginated
ParticipantSearchEntity
PongEntity
ReadinessCheckEntity
ReadinessEntity
ReadinessMetadataEntity
ReasonEntity
ReasonEntityPaginated
RelatedChangeEventEntity
RelatedChangeEventEntityPaginated
RelationshipEntity
ReleaseNoteEntity
ReportEntity
ReportEntityPaginated
RoleAssignmentEntity
RoleAssignmentEntityPaginated
RunbookEntity
RunbookStepEntity
SavedSearchEntity
ScheduleEntity
ScheduledMaintenanceEntity
ScheduledMaintenancesImpactEntity
ScheduledMaintenancesStatusPageEntity
SectionFieldEntity
ServiceEntity
ServiceEntityPaginated
SeverityEntity
SeverityMatrixEntity
SlimActionsEntity
SlimRunbookEntity
StatusPageEntity
StatusPageEntityPaginated
SuccinctEntity
SuccinctTeamEntity
SuccinctUserEntity
TagEntity
TagEntityPaginated
TaskAssigneeEntity
TaskEntity
TaskEntityPaginated
TeamEntity
TeamEntityPaginated
TicketEntity
UserEntity
UserEntityPaginated
VotesEntity
WebhookEntity
patchV1Changes
patchV1ChangesChangeIdIdentities
patchV1ChangesEvents
patchV1Environments
patchV1EventsEventIdVotes
patchV1Functionalities
patchV1IncidentRoles
patchV1Incidents
patchV1IncidentsIncidentIdActionItems
patchV1IncidentsIncidentIdAlertsIncidentAlertIdPrimary
patchV1IncidentsIncidentIdEventsEventIdVotes
patchV1IncidentsIncidentIdNotes
patchV1IncidentsIncidentIdRelatedChangeEvents
patchV1IntegrationsAwsCloudtrailBatches
patchV1IntegrationsAwsConnections
patchV1IntegrationsStatuspageConnections
patchV1Notes
patchV1PostMortemsReports
patchV1PostMortemsReportsReportIdActionItems
patchV1PostMortemsReportsReportIdEvents
patchV1PostMortemsReportsReportIdEventsNotes
patchV1PostMortemsReportsReportIdFields
patchV1RunbooksExecutionsExecutionIdStepsStepIdVotes
patchV1RunbooksExecutionsExecutionIdVotes
patchV1SavedSearchesResourceType
patchV1ScheduledMaintenances
patchV1Services
patchV1SeverityMatrix
patchV1SeverityMatrixConditions
patchV1SeverityMatrixImpacts
patchV1Teams
patchV1TicketingTickets
patchV1Webhooks
postV1Changes
postV1ChangesChangeIdIdentities
postV1ChangesEvents
postV1Environments
postV1Functionalities
postV1IncidentRoles
postV1Incidents
postV1IncidentsIncidentIdActionItems
postV1IncidentsIncidentIdImpact
postV1IncidentsIncidentIdNotes
postV1IncidentsIncidentIdRelatedChangeEvents
postV1IncidentsIncidentIdRoleAssignments
postV1IncidentsIncidentIdTeamAssignments
postV1Notes
postV1PostMortemsReports
postV1PostMortemsReportsReportIdActionItems
postV1PostMortemsReportsReportIdEventsNotes
postV1PostMortemsReportsReportIdParticipants
postV1PostMortemsReportsReportIdReasons
postV1Runbooks
postV1RunbooksExecutions
postV1SavedSearches
postV1ScheduledMaintenances
postV1Services
postV1Severities
postV1SeverityMatrixConditions
postV1SeverityMatrixImpacts
postV1Teams
postV1TicketingTickets
postV1Webhooks
putV1IncidentsIncidentIdImpact
putV1IncidentsIncidentIdMilestonesBulkUpdate
putV1PostMortemsReportsReportIdReasonsOrder
putV1Runbooks
putV1RunbooksExecutionsExecutionIdSteps
Powered by Stoplight
put

/v1/runbooks/{runbook_id}

translation missing: en.api.runbooks.update.description

Authorization

apiKey - Authorization

Request Parameters

1 Path Parameter

Request Body

Schema
object

translation missing: en.api.runbooks.update.description

name
string
summary
string
description
string
severities
array[object]
incident_roles
array[object]
services
array[object]
environments
array[object]
steps
array[object]

Responses

200

translation missing: en.api.runbooks.update.description

Schema
object

translation missing: en.api.runbooks.retrieve.description

id
string
name
string
summary
string
description
string
type
string
created_at
string
1 validation
updated_at
string
1 validation
created_by
object
steps
object
default
boolean
severities
object
incident_roles
object
services
object
environments
object
functionalities
object
votes
object

Returns the status of the votes

Send a Test Request

SettingsHeaders [2]BodyCode Generation
Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
runbook_id
$$.env
2 variables not set
host
Authorization