object	object
collectors15 fields	array[object]
id	string
lastSeen	string
alloyStatus	string	ALLOY_UNSPECIFIED: never seen or status unknown ALLOY_ONLINE: polled within 2× poll interval (default: 2 min) ALLOY_STALE: no poll for > 2× interval but < 5 min ALLOY_OFFLINE: no poll for > 5 min Enum: `ALLOY_UNSPECIFIED`,`ALLOY_ONLINE`,`ALLOY_STALE`,`ALLOY_OFFLINE` Default: ALLOY_UNSPECIFIED
configHash	string
remotecfgStatus	string	REMOTECFG_UNSPECIFIED: etcd query failed — status unknown REMOTECFG_UP: lease key present — process is running REMOTECFG_DOWN: lease key absent — process died or never started Enum: `REMOTECFG_UNSPECIFIED`,`REMOTECFG_UP`,`REMOTECFG_DOWN` Default: REMOTECFG_UNSPECIFIED
pipelineHealth	string	─── Collectors ────────────────────────────────────────────────────────────── PipelineHealth is the runtime health of the logging pipeline on one Alloy agent, derived by polling the Alloy HTTP API on a configurable cadence. DEGRADED covers component errors and runtime failures for a SUBSET of targets. ERROR means ALL configured exporters have active failures. UNKNOWN means the Alloy HTTP API was unreachable. UNSPECIFIED: never polled or address not yet known HEALTHY: all components healthy, no metric failures DEGRADED: unhealthy component, or some (not all) exporters failing UNKNOWN: Alloy HTTP API unreachable ERROR: all configured exporters are failing — no logs leaving the host Enum: `UNSPECIFIED`,`HEALTHY`,`DEGRADED`,`UNKNOWN`,`ERROR` Default: UNSPECIFIED
unhealthyComponents5 fields	array[object]
localId	string
name	string
state	string
message	string
updatedTime	string
pipelineCheckedAt	string
pipelineError	string
exporterSendFailedDelta	string
lokiDroppedEntriesDelta	string
failingExporters	array[string]
totalExporters	int32
exporterSendFailedTotal	string
exporterQueueSize	string

default

An unexpected error response.

Response

{

"collectors": [

{

"id": "{string}",

"lastSeen": "{string}",

"alloyStatus": "{string}",

"configHash": "{string}",

"remotecfgStatus": "{string}",

"pipelineHealth": "{string}",

"unhealthyComponents": [

{

"localId": "{string}",

"name": "{string}",

"state": "{string}",

"message": "{string}",

"updatedTime": "{string}"

}

"pipelineCheckedAt": "{string}",

"pipelineError": "{string}",

"exporterSendFailedDelta": "{string}",

"lokiDroppedEntriesDelta": "{string}",

"failingExporters": [

"{array[string]...}"

"totalExporters": "{int32}",

"exporterSendFailedTotal": "{string}",

"exporterQueueSize": "{string}"

}

]

}

Copy

GetCollector returns the heartbeat state for a single collector by ID.

Auth

Path Params

id string

GET /api/v2/logs/collectors/{id}

curl --get \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/collectors/{id}' \

--header 'Authorization: {Authorization}'

Copy

Responses application/json

200

A successful response.

object	object
collector15 fields	object	CollectorStatus is the composite health view for one log collector (Alloy instance).
id	string
lastSeen	string
alloyStatus	string	ALLOY_UNSPECIFIED: never seen or status unknown ALLOY_ONLINE: polled within 2× poll interval (default: 2 min) ALLOY_STALE: no poll for > 2× interval but < 5 min ALLOY_OFFLINE: no poll for > 5 min Enum: `ALLOY_UNSPECIFIED`,`ALLOY_ONLINE`,`ALLOY_STALE`,`ALLOY_OFFLINE` Default: ALLOY_UNSPECIFIED
configHash	string
remotecfgStatus	string	REMOTECFG_UNSPECIFIED: etcd query failed — status unknown REMOTECFG_UP: lease key present — process is running REMOTECFG_DOWN: lease key absent — process died or never started Enum: `REMOTECFG_UNSPECIFIED`,`REMOTECFG_UP`,`REMOTECFG_DOWN` Default: REMOTECFG_UNSPECIFIED
pipelineHealth	string	─── Collectors ────────────────────────────────────────────────────────────── PipelineHealth is the runtime health of the logging pipeline on one Alloy agent, derived by polling the Alloy HTTP API on a configurable cadence. DEGRADED covers component errors and runtime failures for a SUBSET of targets. ERROR means ALL configured exporters have active failures. UNKNOWN means the Alloy HTTP API was unreachable. UNSPECIFIED: never polled or address not yet known HEALTHY: all components healthy, no metric failures DEGRADED: unhealthy component, or some (not all) exporters failing UNKNOWN: Alloy HTTP API unreachable ERROR: all configured exporters are failing — no logs leaving the host Enum: `UNSPECIFIED`,`HEALTHY`,`DEGRADED`,`UNKNOWN`,`ERROR` Default: UNSPECIFIED
unhealthyComponents5 fields	array[object]
localId	string
name	string
state	string
message	string
updatedTime	string
pipelineCheckedAt	string
pipelineError	string
exporterSendFailedDelta	string
lokiDroppedEntriesDelta	string
failingExporters	array[string]
totalExporters	int32
exporterSendFailedTotal	string
exporterQueueSize	string

default

An unexpected error response.

Response

{

"collector": {

"id": "{string}",

"lastSeen": "{string}",

"alloyStatus": "{string}",

"configHash": "{string}",

"remotecfgStatus": "{string}",

"pipelineHealth": "{string}",

"unhealthyComponents": [

{

"localId": "{string}",

"name": "{string}",

"state": "{string}",

"message": "{string}",

"updatedTime": "{string}"

}

"pipelineCheckedAt": "{string}",

"pipelineError": "{string}",

"exporterSendFailedDelta": "{string}",

"lokiDroppedEntriesDelta": "{string}",

"failingExporters": [

"{array[string]...}"

"totalExporters": "{int32}",

"exporterSendFailedTotal": "{string}",

"exporterQueueSize": "{string}"

}

Copy

sources

Auth

GET /api/v2/logs/sources

curl --get \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/sources' \

--header 'Authorization: {Authorization}'

Copy

Responses application/json

200

A successful response.

object	object
sources6 fields	array[object]
name	string
enabled	boolean
logFormat	string	LB_STORE_TEXT: Reserved for the lb-store storage backend, which is under development and not supported in this release. Rust `tracing` output as captured from its stderr by journald: " module::path: msg". Enum: `LOG_FORMAT_UNSPECIFIED`,`ZAP_JSON`,`LOGFMT`,`DUROSLIGHT_TEXT`,`GFTL_TEXT`,`UNSTRUCTURED`,`LB_STORE_TEXT` Default: LOG_FORMAT_UNSPECIFIED
minLevel	string	Enum: `UNSPECIFIED`,`DEBUG`,`INFO`,`WARN`,`ERROR` Default: UNSPECIFIED
journald	object
syslogIdentifier	string
file2 fields	object
paths	array[string]
labels	object
*	string

default

An unexpected error response.

Response

{

"sources": [

{

"name": "{string}",

"enabled": "{boolean}",

"logFormat": "{string}",

"minLevel": "{string}",

"journald": {

"syslogIdentifier": "{string}"

"file": {

"paths": [

"{array[string]...}"

"labels": {}

}

]

}

Copy

sources

Auth

Request Body application/json

object	object
name	string
enabled	boolean
logFormat	string	LB_STORE_TEXT: Reserved for the lb-store storage backend, which is under development and not supported in this release. Rust `tracing` output as captured from its stderr by journald: " module::path: msg". Enum: `LOG_FORMAT_UNSPECIFIED`,`ZAP_JSON`,`LOGFMT`,`DUROSLIGHT_TEXT`,`GFTL_TEXT`,`UNSTRUCTURED`,`LB_STORE_TEXT` Default: LOG_FORMAT_UNSPECIFIED
minLevel	string	Enum: `UNSPECIFIED`,`DEBUG`,`INFO`,`WARN`,`ERROR` Default: UNSPECIFIED
journald	object
syslogIdentifier	string
file2 fields	object
paths	array[string]
labels	object
*	string

POST /api/v2/logs/sources

curl --request POST \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/sources' \

--header 'Authorization: {Authorization}' \

--data '{

"name": "{string}",

"enabled": "{boolean}",

"logFormat": "{string}",

"minLevel": "{string}",

"journald": {

"syslogIdentifier": "{string}"

"file": {

"paths": [

"{array[string]...}"

"labels": {}

}

Copy

Responses application/json

200

A successful response.

object	object
source6 fields	object
name	string
enabled	boolean
logFormat	string	LB_STORE_TEXT: Reserved for the lb-store storage backend, which is under development and not supported in this release. Rust `tracing` output as captured from its stderr by journald: " module::path: msg". Enum: `LOG_FORMAT_UNSPECIFIED`,`ZAP_JSON`,`LOGFMT`,`DUROSLIGHT_TEXT`,`GFTL_TEXT`,`UNSTRUCTURED`,`LB_STORE_TEXT` Default: LOG_FORMAT_UNSPECIFIED
minLevel	string	Enum: `UNSPECIFIED`,`DEBUG`,`INFO`,`WARN`,`ERROR` Default: UNSPECIFIED
journald	object
syslogIdentifier	string
file2 fields	object
paths	array[string]
labels	object
*	string

default

An unexpected error response.

Response

{

"source": {

"name": "{string}",

"enabled": "{boolean}",

"logFormat": "{string}",

"minLevel": "{string}",

"journald": {

"syslogIdentifier": "{string}"

"file": {

"paths": [

"{array[string]...}"

"labels": {}

}

Copy

{name}

Auth

Path Params

name string

GET /api/v2/logs/sources/{name}

curl --get \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/sources/{name}' \

--header 'Authorization: {Authorization}'

Copy

Responses application/json

200

A successful response.

object	object
source6 fields	object
name	string
enabled	boolean
logFormat	string	LB_STORE_TEXT: Reserved for the lb-store storage backend, which is under development and not supported in this release. Rust `tracing` output as captured from its stderr by journald: " module::path: msg". Enum: `LOG_FORMAT_UNSPECIFIED`,`ZAP_JSON`,`LOGFMT`,`DUROSLIGHT_TEXT`,`GFTL_TEXT`,`UNSTRUCTURED`,`LB_STORE_TEXT` Default: LOG_FORMAT_UNSPECIFIED
minLevel	string	Enum: `UNSPECIFIED`,`DEBUG`,`INFO`,`WARN`,`ERROR` Default: UNSPECIFIED
journald	object
syslogIdentifier	string
file2 fields	object
paths	array[string]
labels	object
*	string

default

An unexpected error response.

Response

{

"source": {

"name": "{string}",

"enabled": "{boolean}",

"logFormat": "{string}",

"minLevel": "{string}",

"journald": {

"syslogIdentifier": "{string}"

"file": {

"paths": [

"{array[string]...}"

"labels": {}

}

Copy

{name}

Auth

Path Params

name string

DELETE /api/v2/logs/sources/{name}

curl --request DELETE \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/sources/{name}' \

--header 'Authorization: {Authorization}'

Copy

Responses application/json

200

A successful response.

object	object
deleted	boolean	True if the source existed and was removed; false if it was already absent.

default

An unexpected error response.

Response

{

"deleted": "{boolean}"

}

Copy

{source.name}

Auth

Path Params

source.name string

Request Body application/json

object	object
enabled	boolean
logFormat	string	LB_STORE_TEXT: Reserved for the lb-store storage backend, which is under development and not supported in this release. Rust `tracing` output as captured from its stderr by journald: " module::path: msg". Enum: `LOG_FORMAT_UNSPECIFIED`,`ZAP_JSON`,`LOGFMT`,`DUROSLIGHT_TEXT`,`GFTL_TEXT`,`UNSTRUCTURED`,`LB_STORE_TEXT` Default: LOG_FORMAT_UNSPECIFIED
minLevel	string	Enum: `UNSPECIFIED`,`DEBUG`,`INFO`,`WARN`,`ERROR` Default: UNSPECIFIED
journald	object
syslogIdentifier	string
file2 fields	object
paths	array[string]
labels	object
*	string

PUT /api/v2/logs/sources/{source.name}

curl --request PUT \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/sources/{source.name}' \

--header 'Authorization: {Authorization}' \

--data '{

"enabled": "{boolean}",

"logFormat": "{string}",

"minLevel": "{string}",

"journald": {

"syslogIdentifier": "{string}"

"file": {

"paths": [

"{array[string]...}"

"labels": {}

}

Copy

Responses application/json

200

A successful response.

object	object
source6 fields	object
name	string
enabled	boolean
logFormat	string	LB_STORE_TEXT: Reserved for the lb-store storage backend, which is under development and not supported in this release. Rust `tracing` output as captured from its stderr by journald: " module::path: msg". Enum: `LOG_FORMAT_UNSPECIFIED`,`ZAP_JSON`,`LOGFMT`,`DUROSLIGHT_TEXT`,`GFTL_TEXT`,`UNSTRUCTURED`,`LB_STORE_TEXT` Default: LOG_FORMAT_UNSPECIFIED
minLevel	string	Enum: `UNSPECIFIED`,`DEBUG`,`INFO`,`WARN`,`ERROR` Default: UNSPECIFIED
journald	object
syslogIdentifier	string
file2 fields	object
paths	array[string]
labels	object
*	string

default

An unexpected error response.

Response

{

"source": {

"name": "{string}",

"enabled": "{boolean}",

"logFormat": "{string}",

"minLevel": "{string}",

"journald": {

"syslogIdentifier": "{string}"

"file": {

"paths": [

"{array[string]...}"

"labels": {}

}

Copy

targets

Auth

GET /api/v2/logs/targets

curl --get \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/targets' \

--header 'Authorization: {Authorization}'

Copy

Responses application/json

200

A successful response.

object	object
targets5 fields	array[object]
name	string
type	string	Enum: `TYPE_UNSPECIFIED`,`LOKI`,`RSYSLOG` Default: TYPE_UNSPECIFIED
enabled	boolean
loki4 fields	object
url	string
username	string
password	string
tlsBundle	string	Name of a TLSBundle. When set, overrides basic auth with TLS.
rsyslog5 fields	object
endpoint	string	Hostname (RFC 1123) or IP address of the rsyslog server, host only with no port and no scheme, e.g. "rsyslog.example.com". Set the port in the port field. Hostnames are resolved by each node at connect time.
port	int32	TCP port of the rsyslog server, 1-65535.
timeout	string	How long each node waits for a send to the rsyslog server before counting it as failed, as a Go duration string, e.g. "5s", "30s". Defaults to "5s" when empty.
debug	boolean	When true, each node also prints every log record it sends to this target to the log collector's own log, for troubleshooting.
tlsBundle	string	Name of a TLSBundle. When empty, connection is plain TCP (no TLS).

default

An unexpected error response.

Response

{

"targets": [

{

"name": "{string}",

"type": "{string}",

"enabled": "{boolean}",

"loki": {

"url": "{string}",

"username": "{string}",

"password": "{string}",

"tlsBundle": "{string}"

"rsyslog": {

"endpoint": "{string}",

"port": "{int32}",

"timeout": "{string}",

"debug": "{boolean}",

"tlsBundle": "{string}"

}

]

}

Copy

targets

Auth

Request Body application/json

object	object
name	string
type	string	Enum: `TYPE_UNSPECIFIED`,`LOKI`,`RSYSLOG` Default: TYPE_UNSPECIFIED
enabled	boolean
loki4 fields	object
url	string
username	string
password	string
tlsBundle	string	Name of a TLSBundle. When set, overrides basic auth with TLS.
rsyslog5 fields	object
endpoint	string	Hostname (RFC 1123) or IP address of the rsyslog server, host only with no port and no scheme, e.g. "rsyslog.example.com". Set the port in the port field. Hostnames are resolved by each node at connect time.
port	int32	TCP port of the rsyslog server, 1-65535.
timeout	string	How long each node waits for a send to the rsyslog server before counting it as failed, as a Go duration string, e.g. "5s", "30s". Defaults to "5s" when empty.
debug	boolean	When true, each node also prints every log record it sends to this target to the log collector's own log, for troubleshooting.
tlsBundle	string	Name of a TLSBundle. When empty, connection is plain TCP (no TLS).

POST /api/v2/logs/targets

curl --request POST \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/targets' \

--header 'Authorization: {Authorization}' \

--data '{

"name": "{string}",

"type": "{string}",

"enabled": "{boolean}",

"loki": {

"url": "{string}",

"username": "{string}",

"password": "{string}",

"tlsBundle": "{string}"

"rsyslog": {

"endpoint": "{string}",

"port": "{int32}",

"timeout": "{string}",

"debug": "{boolean}",

"tlsBundle": "{string}"

}

Copy

Responses application/json

200

A successful response.

object	object
target5 fields	object
name	string
type	string	Enum: `TYPE_UNSPECIFIED`,`LOKI`,`RSYSLOG` Default: TYPE_UNSPECIFIED
enabled	boolean
loki4 fields	object
url	string
username	string
password	string
tlsBundle	string	Name of a TLSBundle. When set, overrides basic auth with TLS.
rsyslog5 fields	object
endpoint	string	Hostname (RFC 1123) or IP address of the rsyslog server, host only with no port and no scheme, e.g. "rsyslog.example.com". Set the port in the port field. Hostnames are resolved by each node at connect time.
port	int32	TCP port of the rsyslog server, 1-65535.
timeout	string	How long each node waits for a send to the rsyslog server before counting it as failed, as a Go duration string, e.g. "5s", "30s". Defaults to "5s" when empty.
debug	boolean	When true, each node also prints every log record it sends to this target to the log collector's own log, for troubleshooting.
tlsBundle	string	Name of a TLSBundle. When empty, connection is plain TCP (no TLS).

default

An unexpected error response.

Response

{

"target": {

"name": "{string}",

"type": "{string}",

"enabled": "{boolean}",

"loki": {

"url": "{string}",

"username": "{string}",

"password": "{string}",

"tlsBundle": "{string}"

"rsyslog": {

"endpoint": "{string}",

"port": "{int32}",

"timeout": "{string}",

"debug": "{boolean}",

"tlsBundle": "{string}"

}

Copy

{name}

Auth

Path Params

name string

GET /api/v2/logs/targets/{name}

curl --get \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/targets/{name}' \

--header 'Authorization: {Authorization}'

Copy

Responses application/json

200

A successful response.

object	object
target5 fields	object
name	string
type	string	Enum: `TYPE_UNSPECIFIED`,`LOKI`,`RSYSLOG` Default: TYPE_UNSPECIFIED
enabled	boolean
loki4 fields	object
url	string
username	string
password	string
tlsBundle	string	Name of a TLSBundle. When set, overrides basic auth with TLS.
rsyslog5 fields	object
endpoint	string	Hostname (RFC 1123) or IP address of the rsyslog server, host only with no port and no scheme, e.g. "rsyslog.example.com". Set the port in the port field. Hostnames are resolved by each node at connect time.
port	int32	TCP port of the rsyslog server, 1-65535.
timeout	string	How long each node waits for a send to the rsyslog server before counting it as failed, as a Go duration string, e.g. "5s", "30s". Defaults to "5s" when empty.
debug	boolean	When true, each node also prints every log record it sends to this target to the log collector's own log, for troubleshooting.
tlsBundle	string	Name of a TLSBundle. When empty, connection is plain TCP (no TLS).

default

An unexpected error response.

Response

{

"target": {

"name": "{string}",

"type": "{string}",

"enabled": "{boolean}",

"loki": {

"url": "{string}",

"username": "{string}",

"password": "{string}",

"tlsBundle": "{string}"

"rsyslog": {

"endpoint": "{string}",

"port": "{int32}",

"timeout": "{string}",

"debug": "{boolean}",

"tlsBundle": "{string}"

}

Copy

{name}

Auth

Path Params

name string

DELETE /api/v2/logs/targets/{name}

curl --request DELETE \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/targets/{name}' \

--header 'Authorization: {Authorization}'

Copy

Responses application/json

200

A successful response.

object	object
deleted	boolean	True if the target existed and was removed; false if it was already absent.

default

An unexpected error response.

Response

{

"deleted": "{boolean}"

}

Copy

{target.name}

Auth

Path Params

target.name string

Request Body application/json

object	object
type	string	Enum: `TYPE_UNSPECIFIED`,`LOKI`,`RSYSLOG` Default: TYPE_UNSPECIFIED
enabled	boolean
loki4 fields	object
url	string
username	string
password	string
tlsBundle	string	Name of a TLSBundle. When set, overrides basic auth with TLS.
rsyslog5 fields	object
endpoint	string	Hostname (RFC 1123) or IP address of the rsyslog server, host only with no port and no scheme, e.g. "rsyslog.example.com". Set the port in the port field. Hostnames are resolved by each node at connect time.
port	int32	TCP port of the rsyslog server, 1-65535.
timeout	string	How long each node waits for a send to the rsyslog server before counting it as failed, as a Go duration string, e.g. "5s", "30s". Defaults to "5s" when empty.
debug	boolean	When true, each node also prints every log record it sends to this target to the log collector's own log, for troubleshooting.
tlsBundle	string	Name of a TLSBundle. When empty, connection is plain TCP (no TLS).

PUT /api/v2/logs/targets/{target.name}

curl --request PUT \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/targets/{target.name}' \

--header 'Authorization: {Authorization}' \

--data '{

"type": "{string}",

"enabled": "{boolean}",

"loki": {

"url": "{string}",

"username": "{string}",

"password": "{string}",

"tlsBundle": "{string}"

"rsyslog": {

"endpoint": "{string}",

"port": "{int32}",

"timeout": "{string}",

"debug": "{boolean}",

"tlsBundle": "{string}"

}

Copy

Responses application/json

200

A successful response.

object	object
target5 fields	object
name	string
type	string	Enum: `TYPE_UNSPECIFIED`,`LOKI`,`RSYSLOG` Default: TYPE_UNSPECIFIED
enabled	boolean
loki4 fields	object
url	string
username	string
password	string
tlsBundle	string	Name of a TLSBundle. When set, overrides basic auth with TLS.
rsyslog5 fields	object
endpoint	string	Hostname (RFC 1123) or IP address of the rsyslog server, host only with no port and no scheme, e.g. "rsyslog.example.com". Set the port in the port field. Hostnames are resolved by each node at connect time.
port	int32	TCP port of the rsyslog server, 1-65535.
timeout	string	How long each node waits for a send to the rsyslog server before counting it as failed, as a Go duration string, e.g. "5s", "30s". Defaults to "5s" when empty.
debug	boolean	When true, each node also prints every log record it sends to this target to the log collector's own log, for troubleshooting.
tlsBundle	string	Name of a TLSBundle. When empty, connection is plain TCP (no TLS).

default

An unexpected error response.

Response

{

"target": {

"name": "{string}",

"type": "{string}",

"enabled": "{boolean}",

"loki": {

"url": "{string}",

"username": "{string}",

"password": "{string}",

"tlsBundle": "{string}"

"rsyslog": {

"endpoint": "{string}",

"port": "{int32}",

"timeout": "{string}",

"debug": "{boolean}",

"tlsBundle": "{string}"

}

Copy

tls-bundles

Auth

GET /api/v2/logs/tls-bundles

curl --get \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/tls-bundles' \

--header 'Authorization: {Authorization}'

Copy

Responses application/json

200

A successful response.

object	object
bundles4 fields	array[object]
name	string	Stable name used as the etcd key and referenced from target configs.
caPem	string	PEM-encoded CA certificate (required). Used to verify the remote server.
certPem	string	PEM-encoded client certificate (optional). Present = mTLS mode.
keyPem	string	PEM-encoded client private key (optional). Present = mTLS mode. Stored AES-256-GCM encrypted in etcd when TLS_BUNDLE_KEY is configured.

default

An unexpected error response.

Response

{

"bundles": [

{

"name": "{string}",

"caPem": "{string}",

"certPem": "{string}",

"keyPem": "{string}"

}

]

}

Copy

tls-bundles

Auth

Request Body application/json

object	object
name	string	Stable name used as the etcd key and referenced from target configs.
caPem	string	PEM-encoded CA certificate (required). Used to verify the remote server.
certPem	string	PEM-encoded client certificate (optional). Present = mTLS mode.
keyPem	string	PEM-encoded client private key (optional). Present = mTLS mode. Stored AES-256-GCM encrypted in etcd when TLS_BUNDLE_KEY is configured.

POST /api/v2/logs/tls-bundles

curl --request POST \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/tls-bundles' \

--header 'Authorization: {Authorization}' \

--data '{

"name": "{string}",

"caPem": "{string}",

"certPem": "{string}",

"keyPem": "{string}"

Copy

Responses application/json

200

A successful response.

object	object
bundle4 fields	object
name	string	Stable name used as the etcd key and referenced from target configs.
caPem	string	PEM-encoded CA certificate (required). Used to verify the remote server.
certPem	string	PEM-encoded client certificate (optional). Present = mTLS mode.
keyPem	string	PEM-encoded client private key (optional). Present = mTLS mode. Stored AES-256-GCM encrypted in etcd when TLS_BUNDLE_KEY is configured.

default

An unexpected error response.

Response

{

"bundle": {

"name": "{string}",

"caPem": "{string}",

"certPem": "{string}",

"keyPem": "{string}"

}

Copy

{bundle.name}

Auth

Path Params

bundle.name

string

Stable name used as the etcd key and referenced from target configs.

Request Body application/json

object	object
caPem	string	PEM-encoded CA certificate (required). Used to verify the remote server.
certPem	string	PEM-encoded client certificate (optional). Present = mTLS mode.
keyPem	string	PEM-encoded client private key (optional). Present = mTLS mode. Stored AES-256-GCM encrypted in etcd when TLS_BUNDLE_KEY is configured.

PUT /api/v2/logs/tls-bundles/{bundle.name}

curl --request PUT \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/tls-bundles/{bundle.name}' \

--header 'Authorization: {Authorization}' \

--data '{

"caPem": "{string}",

"certPem": "{string}",

"keyPem": "{string}"

Copy

Responses application/json

200

A successful response.

object	object
bundle4 fields	object
name	string	Stable name used as the etcd key and referenced from target configs.
caPem	string	PEM-encoded CA certificate (required). Used to verify the remote server.
certPem	string	PEM-encoded client certificate (optional). Present = mTLS mode.
keyPem	string	PEM-encoded client private key (optional). Present = mTLS mode. Stored AES-256-GCM encrypted in etcd when TLS_BUNDLE_KEY is configured.

default

An unexpected error response.

Response

{

"bundle": {

"name": "{string}",

"caPem": "{string}",

"certPem": "{string}",

"keyPem": "{string}"

}

Copy

{name}

Auth

Path Params

name string

GET /api/v2/logs/tls-bundles/{name}

curl --get \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/tls-bundles/{name}' \

--header 'Authorization: {Authorization}'

Copy

Responses application/json

200

A successful response.

object	object
bundle4 fields	object
name	string	Stable name used as the etcd key and referenced from target configs.
caPem	string	PEM-encoded CA certificate (required). Used to verify the remote server.
certPem	string	PEM-encoded client certificate (optional). Present = mTLS mode.
keyPem	string	PEM-encoded client private key (optional). Present = mTLS mode. Stored AES-256-GCM encrypted in etcd when TLS_BUNDLE_KEY is configured.

default

An unexpected error response.

Response

{

"bundle": {

"name": "{string}",

"caPem": "{string}",

"certPem": "{string}",

"keyPem": "{string}"

}

Copy

{name}

Auth

Path Params

name string

DELETE /api/v2/logs/tls-bundles/{name}

curl --request DELETE \

--url 'https://documentation.lightbitslabs.com/api/v2/logs/tls-bundles/{name}' \

--header 'Authorization: {Authorization}'

Copy

Responses application/json

200

A successful response.

object object

default

An unexpected error response.

Response

{}

Copy