Anomaly Detection5

Auth2

Boards10

Burn Alerts5

Calculated Fields5

Columns5

Dataset Definitions2

Datasets5

Environments5

Events2

Key Management5

Kinesis Events1

Marker Settings4

Markers4

Queries2

Query Annotations5

Query Data2

Recipients5

Reporting1

Service Maps2

SLOs7

Triggers6

Columns

Update a Column

Update a column

put/1/columns/{datasetSlug}/{columnId}

Request

Base URL
https://api.honeycomb.io
URL
https://api.honeycomb.io/1/columns/{datasetSlug}/{columnId}
Auth
API key in header X-Honeycomb-Team

Request body

key_namestring required

Name of the Column.

type'string' | 'float' | 'integer' | 'boolean' | 'histogram'

Type of data that the Column will contain. Histogram is in beta and only works in your Metrics dataset.

descriptionstring

Column description.

hiddenboolean

If true, the column is excluded from autocomplete and raw data field lists.

idstring

Unique identifier (ID), returned in response bodies.

last_writtenstring

ISO8601 formatted time the column was last written to (received event data).

created_atstring

ISO8601 formatted time the column was created.

updated_atstring

ISO8601 formatted time the column was updated.

Example request

{
  "key_name": "my_column",
  "type": "integer",
  "description": "An integer column"
}

Response

Success