environments
get
Lists all environments
Authorizations
Responses
200
Happy response.
application/json
default
Error object.
application/json
get
/v1/environmentsGET /v1/environments HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-10-24T16:23:29.612Z",
"tier": "development",
"status": {
"agent_connected": true,
"agent": {
"updated_at": "2025-10-24T16:23:29.612Z",
"roundtrip_duration": 1,
"agent": {
"hostname": "text",
"version": "text",
"capabilities": {
"metrics": true,
"k2k": true
}
},
"metrics": {
"kafka": {
"version": "text",
"num_brokers": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"data": {
"num_topics": 1,
"num_partitions": 1,
"num_schemas": 1,
"num_policies": 1,
"topic_data_total_bytes": 1,
"data_in_bytes_per_sec": 1,
"data_out_bytes_per_sec": 1,
"data_in_messages_per_sec": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"apps": {
"num_consumers": 1,
"num_other_apps": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"connect": {
"num_clusters": 1,
"num_connectors": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"other": {
"num_issues": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
}
}
}
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
]
}post
Creates a new environment.
Authorizations
Body
namestring · hq-resource-name · min: 1 · max: 63Required
Sets the name of the new environment. It must be a valid HQ resource name: it can only contain lowercase alphanumeric characters or hyphens; hyphens cannot appear at the end or start; the length is 63 characters at most.
display_namestring · min: 1 · max: 150Optional
Sets the display name of the new environment. If not provided, the value of "name" will be used.
tierstring · enumRequiredPossible values:
Enumerates Tiers.
Responses
201
Happy response.
application/json
Responseall of
Is returned on creation, contains the agent key but lacks dynamic fields which are unavailble on creation by definition.
default
Error object.
application/json
post
/v1/environmentsPOST /v1/environments HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104
{
"name": "text",
"display_name": "text",
"tier": "development",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-10-24T16:23:29.612Z",
"tier": "development",
"status": {
"agent_connected": true,
"agent": {
"updated_at": "2025-10-24T16:23:29.612Z",
"roundtrip_duration": 1,
"agent": {
"hostname": "text",
"version": "text",
"capabilities": {
"metrics": true,
"k2k": true
}
},
"metrics": {
"kafka": {
"version": "text",
"num_brokers": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"data": {
"num_topics": 1,
"num_partitions": 1,
"num_schemas": 1,
"num_policies": 1,
"topic_data_total_bytes": 1,
"data_in_bytes_per_sec": 1,
"data_out_bytes_per_sec": 1,
"data_in_messages_per_sec": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"apps": {
"num_consumers": 1,
"num_other_apps": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"connect": {
"num_clusters": 1,
"num_connectors": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"other": {
"num_issues": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
}
}
}
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"agent_key": "text"
}get
Retrieves a single environment by name.
Authorizations
Path parameters
namestringRequired
Responses
200
Happy response.
application/json
default
Error object.
application/json
get
/v1/environments/{name}GET /v1/environments/{name} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-10-24T16:23:29.612Z",
"tier": "development",
"status": {
"agent_connected": true,
"agent": {
"updated_at": "2025-10-24T16:23:29.612Z",
"roundtrip_duration": 1,
"agent": {
"hostname": "text",
"version": "text",
"capabilities": {
"metrics": true,
"k2k": true
}
},
"metrics": {
"kafka": {
"version": "text",
"num_brokers": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"data": {
"num_topics": 1,
"num_partitions": 1,
"num_schemas": 1,
"num_policies": 1,
"topic_data_total_bytes": 1,
"data_in_bytes_per_sec": 1,
"data_out_bytes_per_sec": 1,
"data_in_messages_per_sec": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"apps": {
"num_consumers": 1,
"num_other_apps": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"connect": {
"num_clusters": 1,
"num_connectors": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"other": {
"num_issues": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
}
}
}
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}delete
Deletes an environment.
Authorizations
Path parameters
namestringRequired
Responses
204
Successful deletion.
No content
default
Error object.
application/json
delete
/v1/environments/{name}DELETE /v1/environments/{name} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
patch
Updates an environment.
Authorizations
Path parameters
namestringRequired
Body
tierstring · enumOptionalPossible values:
Enumerates Tiers.
display_namestring · min: 1 · max: 150Optional
Updates the display name of the environment.
Responses
200
Happy response.
application/json
default
Error object.
application/json
patch
/v1/environments/{name}PATCH /v1/environments/{name} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"tier": "development",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"display_name": "text"
}{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-10-24T16:23:29.612Z",
"tier": "development",
"status": {
"agent_connected": true,
"agent": {
"updated_at": "2025-10-24T16:23:29.612Z",
"roundtrip_duration": 1,
"agent": {
"hostname": "text",
"version": "text",
"capabilities": {
"metrics": true,
"k2k": true
}
},
"metrics": {
"kafka": {
"version": "text",
"num_brokers": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"data": {
"num_topics": 1,
"num_partitions": 1,
"num_schemas": 1,
"num_policies": 1,
"topic_data_total_bytes": 1,
"data_in_bytes_per_sec": 1,
"data_out_bytes_per_sec": 1,
"data_in_messages_per_sec": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"apps": {
"num_consumers": 1,
"num_other_apps": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"connect": {
"num_clusters": 1,
"num_connectors": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"other": {
"num_issues": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
}
}
}
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}get
Lists Kafka connections defined for an Environment.
Authorizations
Path parameters
env_namestringRequired
Responses
200
Happy response.
application/json
default
Error object.
application/json
get
/v1/environments/{env_name}/kafka-connectionsGET /v1/environments/{env_name}/kafka-connections HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"name": "text",
"override_broker_addresses": [
"text"
],
"auth": {}
}
]
}get
Retrieves a Kafka connection defined for an Environment.
Authorizations
Path parameters
env_namestringRequired
conn_namestringRequired
Responses
200
Happy response.
application/json
default
Error object.
application/json
get
/v1/environments/{env_name}/kafka-connections/{conn_name}GET /v1/environments/{env_name}/kafka-connections/{conn_name} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"name": "text",
"override_broker_addresses": [
"text"
],
"auth": {}
}put
Upserts a particular Environment's Kafka connection.
Authorizations
Path parameters
env_namestringRequired
conn_namestringRequired
Body
Creates/updates a Kafka connection.
override_broker_addressesstring[]Optional
Optionally overrides the broker addresses. If not set, those of the agent are used.
authone ofRequired
Contains auth settings specific to a particular auth type.
objectOptional
Configures Kafka Plaintext "authentication".
or
or
Responses
200
Happy response.
application/json
default
Error object.
application/json
put
/v1/environments/{env_name}/kafka-connections/{conn_name}PUT /v1/environments/{env_name}/kafka-connections/{conn_name} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"override_broker_addresses": [
"text"
],
"auth": {}
}{
"name": "text",
"override_broker_addresses": [
"text"
],
"auth": {}
}delete
Deletes a particular Environment's Kafka connection.
Authorizations
Path parameters
env_namestringRequired
conn_namestringRequired
Responses
204
Succesful deletion.
No content
default
Error object.
application/json
delete
/v1/environments/{env_name}/kafka-connections/{conn_name}DELETE /v1/environments/{env_name}/kafka-connections/{conn_name} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
post
Generates a new agent key and invalidates the old.
Authorizations
Path parameters
namestringRequired
Responses
200
Happy response.
application/json
Responseall of
Is returned on creation, contains the agent key but lacks dynamic fields which are unavailble on creation by definition.
default
Error object.
application/json
post
/v1/environments/{name}/renew-keyPOST /v1/environments/{name}/renew-key HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"name": "text",
"display_name": "text",
"lrn": "text",
"id": "text",
"created_at": "2025-10-24T16:23:29.612Z",
"tier": "development",
"status": {
"agent_connected": true,
"agent": {
"updated_at": "2025-10-24T16:23:29.612Z",
"roundtrip_duration": 1,
"agent": {
"hostname": "text",
"version": "text",
"capabilities": {
"metrics": true,
"k2k": true
}
},
"metrics": {
"kafka": {
"version": "text",
"num_brokers": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"data": {
"num_topics": 1,
"num_partitions": 1,
"num_schemas": 1,
"num_policies": 1,
"topic_data_total_bytes": 1,
"data_in_bytes_per_sec": 1,
"data_out_bytes_per_sec": 1,
"data_in_messages_per_sec": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"apps": {
"num_consumers": 1,
"num_other_apps": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"connect": {
"num_clusters": 1,
"num_connectors": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
},
"other": {
"num_issues": 1,
"updated_at": "2025-10-24T16:23:29.612Z"
}
}
}
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"agent_key": "text"
}get
Provides Server-Sent Events (SSE) for environment updates. TODO.
Authorizations
Responses
default
Error object.
application/json
get
/v1/environments/live/sseGET /v1/environments/live/sse HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
default
Error object.
{
"type": "not_found",
"title": "text",
"status": 1,
"invalid_fields": [
{
"name": "text",
"error": "reference_not_found",
"title": "text"
}
],
"sso_url": "text",
"request_id": "text"
}get
Proxies HTTP to a Lenses instance. Note: this is not a regular HTTP API endpoint. The path specified here is a prefix. Everything beneath it gets proxied to the corresponding Lenses instance. Any request body and method (the GET here is only a placeholder) are accepted, as long as the Lenses API accepts it. The connection can even be upgraded to a websocket. The status code and response body are controlled by the Lenses API. This concept does not fit into the OpenAPI world at all; this definition is only here for the sake of documentation to avoid having an undocumented dark matter API.
Authorizations
Path parameters
namestringRequired
Responses
default
Error object.
application/json
get
/v1/environments/{name}/proxy/GET /v1/environments/{name}/proxy/ HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
default
Error object.
{
"type": "not_found",
"title": "text",
"status": 1,
"invalid_fields": [
{
"name": "text",
"error": "reference_not_found",
"title": "text"
}
],
"sso_url": "text",
"request_id": "text"
}Last updated
Was this helpful?