Create a Map Dependency Request

curl --request POST \
  --url https://api.honeycomb.io/1/maps/dependencies/requests \
  --header 'Content-Type: application/json' \
  --header 'X-Honeycomb-Team: <api-key>' \
  --data '
{
  "time_range": 7200,
  "filters": [
    {
      "name": "user-service",
      "type": "service"
    }
  ]
}
'

{
  "request_id": "abc123",
  "status": "pending"
}

{
  "request_id": "abc123",
  "status": "pending"
}

{
  "status": 400,
  "type": "https://api.honeycomb.io/problems/unparseable",
  "title": "The request body could not be parsed.",
  "error": "invalid gzip data"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "something went wrong!",
  "status": 422,
  "type": "https://api.honeycomb.io/problems/validation-failed",
  "title": "The provided input is invalid.",
  "detail": "<string>",
  "instance": "<string>",
  "type_detail": [
    {
      "field": "<string>",
      "code": "invalid",
      "description": "<string>"
    }
  ]
}

{
  "error": "Rate Limited"
}

{
  "error": "<string>"
}

POST

maps

dependencies

requests

curl --request POST \
  --url https://api.honeycomb.io/1/maps/dependencies/requests \
  --header 'Content-Type: application/json' \
  --header 'X-Honeycomb-Team: <api-key>' \
  --data '
{
  "time_range": 7200,
  "filters": [
    {
      "name": "user-service",
      "type": "service"
    }
  ]
}
'

{
  "request_id": "abc123",
  "status": "pending"
}

{
  "request_id": "abc123",
  "status": "pending"
}

{
  "status": 400,
  "type": "https://api.honeycomb.io/problems/unparseable",
  "title": "The request body could not be parsed.",
  "error": "invalid gzip data"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "something went wrong!",
  "status": 422,
  "type": "https://api.honeycomb.io/problems/validation-failed",
  "title": "The provided input is invalid.",
  "detail": "<string>",
  "instance": "<string>",
  "type_detail": [
    {
      "field": "<string>",
      "code": "invalid",
      "description": "<string>"
    }
  ]
}

{
  "error": "Rate Limited"
}

{
  "error": "<string>"
}

Authorizations

X-Honeycomb-Team

string

header

required

Authenticate using a Honeycomb Configuration Key.

Pass the Token in the X-Honeycomb-Team header:

X-Honeycomb-Team: 1234567890123456789012

If you created your key using the API, use data.attributes.secret; this is the same value as the Token in the UI.

To learn how to create a Configuration Key, visit Manage Environment API Keys. To learn more about authenticating requests, visit API Authentication.

Query Parameters

limit

integer

default:10000

Maximum number of dependencies to return. Default is 10000, maximum is 64000.

Required range: 1 <= x <= 64000

Body

application/json

Create a Map Dependency Request.

start_time

integer

Absolute start time to evaluate dependencies, in seconds since UNIX epoch. Must be <= end_time (when time_range is not provided).

Example:

1622548800

end_time

integer

Absolute end time to evaluate dependencies, in seconds since UNIX epoch. Must be >= start_time (when time_range is not provided).

Example:

1622635200

time_range

integer

default:7200

Time range in seconds (minimum 1). Can be used with either start_time (seconds after start_time), end_time (seconds before end_time), or without either (seconds before now).

Required range: x >= 1

Example:

7200

filters

object[]

Optional list of service nodes to filter dependencies by. Only dependencies involving these nodes will be returned.

Show child attributes

Response

Success - Results are ready or request has failed (see status field)

Response for a Map Dependency Request.

request_id

string

Unique identifier for the Map Dependency Request.

Example:

"abc123"

status

enum<string>

Status of the Map Dependency Request.

Available options:

pending,

ready,

error

Example:

"pending"

Getting Started

Reference

API Endpoints

Create a Map Dependency Request

Authorizations

Query Parameters

Body

Response