How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

FireHydrant Services API

The Services API from FireHydrant — 2 operation(s) for services.

FireHydrant Services API is one of 28 APIs that FireHydrant publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Services. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 24 operations across 16 paths, and defines 67 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.firehydrant.io/, https://api.firehydrant.io/v1.

24 operations 16 paths 67 schemas 4 DELETE11 GET3 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.firehydrant.io/v1
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

FireHydrant Services API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (api_key). It accepts HTTP bearer tokens (bearerAuth).

Paths & Operations 24

Across 16 paths, the API surfaces 24 operations — 4 DELETE, 11 GET, 3 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Services 24

Operations related to Services

POST
/v1/catalogs/{catalog_id}/ingest
Ingest service catalog data
ingestCatalogData 1 param body → 201
GET
/v1/catalogs/{catalog_id}/refresh
Refresh a service catalog
refreshCatalog 1 param → 200
GET
/v1/infrastructures
List catalog entries
listInfrastructures 5 params → 200
POST
/v1/service_dependencies
Create a dependency relationship between services
createServiceDependency body → 201
GET
/v1/service_dependencies/{service_dependency_id}
Get a service dependency
getServiceDependency 1 param → 200
DELETE
/v1/service_dependencies/{service_dependency_id}
Delete a service dependency
deleteServiceDependency 1 param → 200
PATCH
/v1/service_dependencies/{service_dependency_id}
Update a service dependency
updateServiceDependency 1 param body → 200
GET
/v1/services
List services
listServices 14 params → 200
POST
/v1/services
Create a service
createService body → 201400
POST
/v1/services/service_links
Create multiple services and link them to external services
createServiceLinks body → 201
GET
/v1/services/{service_id}
Get a service
getService 1 param → 200
DELETE
/v1/services/{service_id}
Delete a service
deleteService 1 param → 200
PATCH
/v1/services/{service_id}
Update a service
updateService 1 param body → 200
GET
/v1/services/{service_id}/available_downstream_dependencies
List available downstream service dependencies
listServiceAvailableDownstreamDependencies 1 param → 200
GET
/v1/services/{service_id}/available_upstream_dependencies
List available upstream service dependencies
listServiceAvailableUpstreamDependencies 1 param → 200
POST
/v1/services/{service_id}/checklist_response/{checklist_id}
Create a checklist response for a service
createServiceChecklistResponse 2 params body → 201
GET
/v1/services/{service_id}/dependencies
List dependencies for a service
getServiceDependencies 2 params → 200
DELETE
/v1/services/{service_id}/service_links/{remote_id}
Delete a service link
deleteServiceLink 2 params → 204
GET
/v1/users/{id}/services
List services for a user's teams
listUserServices 3 params → 200
GET
/services
List services
getServices 3 params → 200
POST
/services
Create a service
postServices body → 201
GET
/services/{service_id}
Retrieve a service
getServicesByServiceId 1 param → 200
PATCH
/services/{service_id}
Update a service
patchServicesByServiceId 1 param body → 200
DELETE
/services/{service_id}
Delete a service
deleteServicesByServiceId 1 param → 204

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are IncidentEntity (56 properties), ServiceEntity (24 properties), TeamEntity (19 properties), Ticketing_TicketEntity (18 properties). Each schema is shown below with its type and property counts.

ChecklistCheckEntity
object
4 properties
Incidents_ChannelEntity
object
IncidentsChannelEntity model
8 properties
OrganizationEntity
object
2 properties
TeamEntityPaginated
object
TeamEntityPaginated model
2 properties
SeverityMatrix_ImpactEntity
object
SeverityMatrixImpactEntity model
5 properties
patchV1ServicesServiceId
object
Update a services attributes, you may also add or remove functionalities from the service as well. Note: You may not remove or add individual label key/value p…
17 properties
Imports_ImportableResourceEntity
object
4 properties
patchV1ServiceDependenciesServiceDependencyId
object
Update the notes of the service dependency
1 property
ServiceEntityLite
object
ServiceEntityLite model
11 properties
Attachments_LinkEntity
object
AttachmentsLinkEntity model
7 properties
Imports_ImportErrorEntity
object
5 properties
ServiceChildDependencyEntity
object
6 properties
IncidentEntity
object
IncidentEntity model
56 properties
Ticketing_PriorityEntity
object
TicketingPriorityEntity model
5 properties
Incidents_ContextObjectEntity
object
4 properties
CustomFields_FieldValue
object
9 properties
SlimRunbookEntity
object
10 properties
FunctionalityEntityLite
object
13 properties
Imports_ImportErrorEntity_ResourceEntity
object
3 properties
postV1ServiceDependencies
object
Creates a service dependency relationship between two services
3 properties 2 required
ChecklistTemplateEntity
object
ChecklistTemplateEntity model
8 properties
ServiceEntityChecklist
object
14 properties
postV1ServicesServiceLinks
object
Creates a service with the appropriate integration for each external service ID passed
3 properties 3 required
IncidentRoleEntity
object
IncidentRoleEntity model
7 properties
Imports_ImportEntity
object
ImportsImportEntity model
2 properties
Integrations_MicrosoftTeamsV2_ChannelEntity
object
8 properties
InfrastructureSearchEntity
object
InfrastructureSearchEntity model
2 properties
ServiceWithAllDependenciesEntity
object
ServiceWithAllDependenciesEntity model
3 properties
AuthorEntity
object
4 properties
Event_NoteEntity
object
EventNoteEntity model
5 properties
Integrations_Slack_SlackChannelEntity
object
3 properties
Incidents_LifecycleMilestoneEntity
object
9 properties
ServiceLinkEntity
object
ServiceLinkEntity model
2 properties
ServiceParentDependencyEntity
object
6 properties
postV1CatalogsCatalogIdIngest
object
Accepts catalog data in the configured format and asyncronously processes the data to incorporate changes into service catalog.
2 properties 2 required
FHTypes_GenericEntity
object
3 properties
postV1Services
object
Creates a service for the organization, you may also create or attach functionalities to the service on create.
11 properties 1 required
Incidents_ImpactEntity
object
5 properties
SuccinctEntity
object
2 properties
IncidentEntity_FieldRequirementEntity
object
2 properties
ErrorEntity
object
ErrorEntity model
4 properties
Incidents_StatusPageEntity
object
IncidentsStatusPageEntity model
6 properties
Incidents_ConferenceBridgeEntity
object
2 properties
ServiceDependencyEntity
object
ServiceDependencyEntity model
6 properties
Ticketing_TicketEntity
object
TicketingTicketEntity model
18 properties
Incidents_RoleAssignmentEntity
object
IncidentsRoleAssignmentEntity model
6 properties
Rules_RuleEntity
object
2 properties
TeamEntity
object
TeamEntity model
19 properties
Conversations_API_Entities_Reference
object
6 properties
Incidents_LifecycleMeasurementEntity
object
8 properties
ServiceEntityPaginated
object
ServiceEntityPaginated model
2 properties
FunctionalityEntity
object
FunctionalityEntity model
16 properties
LinksEntity
object
4 properties
PaginationEntity
object
7 properties
ScheduleEntity
object
4 properties
IntegrationEntity
object
5 properties
Incidents_TeamAssignmentEntityLite
object
5 properties
ExternalResourceEntity
object
8 properties
UserEntity
object
UserEntity model
8 properties
postV1ServicesServiceIdChecklistResponseChecklistId
object
Creates a response for a checklist item
2 properties 2 required
Incidents_LifecyclePhaseEntity
object
6 properties
Conversations_API_Entities_Channel
object
1 property
MembershipEntity
object
4 properties
TeamEntityLite
object
9 properties
ServiceEntity
object
ServiceEntity model
24 properties
Incidents_MilestoneEntity
object
6 properties
SeverityMatrix_ConditionEntity
object
SeverityMatrixConditionEntity model
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

firehydrant-services-api-openapi.yml Raw ↑

Other APIs FireHydrant publishes across the network.

FireHydrant Audits API
FireHydrant Change Events API
FireHydrant Changes API
FireHydrant Conversations API
FireHydrant Environments API
FireHydrant Functionalities API
FireHydrant Incidents API
FireHydrant Ping API
FireHydrant Priorities API
FireHydrant Runbooks API
FireHydrant Scheduled Maintenances API
FireHydrant Severities API
Where this information came from

This is an independent, third-party profile of FireHydrant Services API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.