diff --git a/api-docs/index.md b/api-docs/index.md index 24e82317..18102083 100644 --- a/api-docs/index.md +++ b/api-docs/index.md @@ -17,7 +17,7 @@ This endpoint enables the client to interact with resources on Baselime platform ## Authentication Headers * `content-type: application/json` -* `x-api-key: ` - get your API key from [Baselime console](https://console.baselime.io) +* `x-api-key: ` - get your admin API key from [Baselime console](https://console.baselime.io) ## Dashboards @@ -371,7 +371,6 @@ This endpoint enables the client to interact with resources on Baselime platform } ``` === - ## Alerts ==- [!badge GET] `/alerts` @@ -621,6 +620,65 @@ This endpoint enables the client to interact with resources on Baselime platform --- +## Services + +==- [!badge GET] `/services` +**Description:** Lists all services in the environment. + +**Response** +```typescript Body +{ + "data": Array<{ + "name": string + "workspaceId": string + "environmentId": string + "userId": string + "generated": boolean + "created": string + "updated": string + "metadata": Record + }> +} + +``` + +==- [!badge GET] `/services/{name}` +**Description:** Gets a service by name. + + +**Request** +* `{id}` - The name of the service. + +**Response** +```typescript Body +{ + "data": { + "name": string + "workspaceId": string + "environmentId": string + "userId": string + "generated": boolean + "created": string + "updated": string + "metadata": Record + } +} +``` + +==- [!badge variant="danger" text="DELETE"] `/services/{name}` +**Description:** Deletes a service. + +**Request** +* `{name}` - The name of the service. + +**Response** +```typescript Body +{ + "message": "Service deleted", +} +``` +=== + # Telemetry data @@ -630,7 +688,7 @@ This endpoint enables you to query your telemetry data. ## Authentication * `content-type: application/json` -* `x-api-key: ` - get your API key from [Baselime console](https://console.baselime.io) +* `x-api-key: ` - get your admin API key from [Baselime console](https://console.baselime.io) ==- [!badge POST] `/query_runs` **Description:** Creates a new query run and returns its results. diff --git a/sending-data/platforms/opentelemetry/opentelemetry.md b/sending-data/platforms/opentelemetry/opentelemetry.md index 5fe32a7c..7f68c91c 100644 --- a/sending-data/platforms/opentelemetry/opentelemetry.md +++ b/sending-data/platforms/opentelemetry/opentelemetry.md @@ -9,8 +9,11 @@ If your codebase is already instrumented with [OpenTelemetry](https://openteleme ## Configuration ### Endpoint -* HTTP: `otel.baselime.io/v1/` -* gRPC: `otel-ingest.baselime.io:4317` +* HTTP: + * `otel.baselime.io/v1/traces` - traces + * `otel.baselime.io/v1/metrics` - metrics + * `otel.baselime.io/v1/logs` - logs +* gRPC: `otel-ingest.baselime.io:8443` ### Headers ```yaml