Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Honeycomb Service Maps API

The Service Maps API endpoints allow you to visualize the relationships between your services in Honeycomb.This API allows you to create and retrieve service Dependency Requests, which are used to generate maps of dependencies between services.## AuthorizationThe API key must have the **Read Service Maps** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).

Honeycomb Service Maps API is one of 21 APIs that Honeycomb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Service Maps. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.honeycomb.io, https://api.eu1.honeycomb.io.

2 operations 2 paths 10 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.honeycomb.io
License
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Service Maps 2

The Service Maps API endpoints allow you to visualize the relationships between your services in Honeycomb. This API allows you to create and retrieve service Dependency Requests,…

POST
/1/maps/dependencies/requests
Create a Map Dependency Request
createMapDependencyRequest 1 param body → 200201400401403404422429
GET
/1/maps/dependencies/requests/{requestId}
Get Map Dependencies
getMapDependencies 3 params → 200400401403404422429default

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are DetailedError (6 properties), GetMapDependenciesResponse (4 properties), CreateMapDependenciesRequest (4 properties), MapDependency (3 properties). Each schema is shown below with its type and property counts.

CreateMapDependenciesResponse
object
Response for a Map Dependency Request.
2 properties
PaginationLinks
object
Links to iterate through the pages of results.
1 property 1 required
MapNode
object
A node in the service map (typically a service).
2 properties 1 required
Error
object
A legacy error, containing only a textual description.
1 property
MapDependency
object
A dependency relationship between two services.
3 properties
ValidationError
CreateMapDependenciesRequest
object
Create a Map Dependency Request.
4 properties
DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
JSONAPIError
object
A JSONAPI-formatted error message.
1 property
GetMapDependenciesResponse
object
Response containing map dependencies data.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-io-service-maps-api-openapi.yml Raw ↑

Other APIs Honeycomb publishes across the network.

Honeycomb Auth API
Honeycomb Boards API
Honeycomb Burn Alerts API
Honeycomb Calculated Fields API
Honeycomb Columns API
Honeycomb Dataset Definitions API
Honeycomb Datasets API
Honeycomb Environments API
Honeycomb Events API
Honeycomb Key Management API
Honeycomb Kinesis Events API
Honeycomb Marker Settings API