GET Connection progress
/api/v1/logs/connections/{id}
Returns progress and non-secret settings for the issuing actor. Historical receipts do not confirm a new setup.
On this page
Access and permissions
Returns progress and non-secret settings for the issuing actor. Historical receipts do not confirm a new setup.
Browser session: __Host-mb_session cookie.
Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.
Parameters and headers
| Field | Location | Type and limits | Required | Meaning |
|---|---|---|---|---|
| id | Path | string; {"format":"uuid"} | Yes | An optional filter of the selected log view. |
| workspace_id | URL query | string; {"format":"uuid"} | Yes | The permitted workspace. |
Request body
No request body.
Responses
| Stable error codes |
|---|
| not_found |
| revision_conflict |
| invalid_source |
| source_exists |
| invalid_credential |
| unauthorized |
| provider_unavailable |
| source_limit |
| unavailable |
| agent_unavailable |
| invalid_log_key |
| forbidden |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| not_found |
| revision_conflict |
| invalid_source |
| agent_unavailable |
| source_exists |
| csrf |
| insufficient_scope |
| provider_unavailable |
| source_limit |
| invalid_origin |
| unavailable |
| operator_required |
| invalid_log_key |
| forbidden |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| revision_conflict |
| invalid_source |
| source_exists |
| invalid_workspace |
| provider_unavailable |
| source_limit |
| unavailable |
| agent_unavailable |
| not_found |
| forbidden |
| invalid_log_key |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| not_found |
| revision_conflict |
| invalid_source |
| source_exists |
| invalid_workspace |
| stale_check |
| provider_unavailable |
| source_limit |
| unavailable |
| agent_unavailable |
| result_conflict |
| forbidden |
| invalid_log_key |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| not_found |
| revision_conflict |
| invalid_source |
| source_exists |
| invalid_config |
| provider_unavailable |
| source_limit |
| invalid_monitor |
| unavailable |
| agent_unavailable |
| invalid_log_key |
| forbidden |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| not_found |
| revision_conflict |
| invalid_source |
| source_exists |
| invalid_workspace |
| provider_unavailable |
| source_limit |
| unavailable |
| check_capacity |
| agent_unavailable |
| invalid_log_key |
| forbidden |
| Header | Type and limits | Meaning |
|---|---|---|
| Retry-After | string; {"pattern":"^[0-9]+$"} | Temporary server error; retry unchanged with Retry-After and the same idempotency identifier |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| not_found |
| revision_conflict |
| invalid_source |
| source_exists |
| log_admission_busy |
| feature_unavailable |
| provider_unavailable |
| source_limit |
| unavailable |
| log_queue_full |
| forbidden |
| agent_unavailable |
| invalid_log_key |
| check_location_unavailable |
| log_storage_unavailable |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| log_limit |
| request_too_large |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | CentralLogConnection | Yes | — |
| $.id | string; {"format":"uuid"} | Yes | — |
| $.source_id | string; {"format":"uuid"} | Yes | — |
| $.status | string; {"enum":["prepared","approval_required","applying","waiting_logs","received","searchable","expired","changed","failed"]} | Yes | — |
| $.expires_at | string; {"format":"date-time"} | Yes | — |
| $.settings | CentralLogConnectionInput | Yes | — |
| $.settings.operation_id | string; {"format":"uuid"} | Yes | — |
| $.settings.workspace_id | string; {"format":"uuid"} | Yes | — |
| $.settings.source_id | string; {"format":"uuid"} | No | — |
| $.settings.kind | string; {"enum":["http","otlp","syslog","agent","vercel","heroku","render","railway","fly","cloudflare","cloudwatch","supabase","netlify"]} | Yes | — |
| $.settings.name | string; {"maxLength":128} | No | — |
| $.settings.agent_device_id | string; {"format":"uuid"} | No | — |
| $.settings.streams | array<CentralLogCandidate>; {"maxItems":100} | No | — |
| $.settings.streams[] | CentralLogCandidate | Yes | — |
| $.settings.streams[].id | string; {"pattern":"^log_[0-9a-f]{24}$"} | Yes | — |
| $.settings.streams[].kind | string; {"enum":["file","kernel","journal","windows","macos","docker"]} | Yes | — |
| $.settings.streams[].name | string; {"maxLength":128} | Yes | — |
| $.settings.streams[].path | string; {"maxLength":4096} | Yes | — |
| $.settings.streams[].category | string; {"enum":["system","services","applications","containers"]} | Yes | — |
| $.settings.retention_days | integer; {"minimum":1,"maximum":30,"default":7} | No | — |
| $.settings.policy | CentralLogPolicy | No | — |
| $.settings.policy.drop_below | string; {"enum":["unknown","trace","debug","info","warning","error","fatal"]} | No | — |
| $.settings.policy.masks | array<object; {"additionalProperties":false}>; {"maxItems":32} | No | — |
| $.settings.policy.masks[] | object; {"additionalProperties":false} | Yes | — |
| $.settings.policy.masks[].field | string; {"maxLength":256} | No | — |
| $.settings.policy.masks[].pattern | string; {"maxLength":512} | No | — |
| $.settings.expected_revision | integer; {"minimum":0} | No | — |
| $.settings.method | string; {"maxLength":32} | No | — |
| $.settings.target | string; {"maxLength":256} | No | — |
| $.settings.region | string; {"maxLength":64} | No | — |
| $.settings.connection_id | string; {"format":"uuid"} | No | — |
| $.settings.dataset | string; {"maxLength":200} | No | — |
| Stable error codes |
|---|
| not_found |
| revision_conflict |
| invalid_source |
| source_exists |
| invalid_config |
| provider_unavailable |
| source_limit |
| invalid_monitor |
| unavailable |
| agent_unavailable |
| invalid_log_key |
| forbidden |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
Retries and asynchronous work
This change does not have a general retry guarantee. If the response is unclear, read the affected resource before trying again. Follow Retry-After waiting times and request new sign-in or action codes when they expire.
Request examples
Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.
Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.
curl --proto "=https" --tlsv1.2 --fail-with-body --max-time 60 --request GET --header @"$HOME/.config/metribeacon/headers.txt" 'https://metribeacon.com/api/v1/logs/connections/00000000-0000-4000-8000-000000000001?workspace_id=00000000-0000-4000-8000-000000000001'
import json
from pathlib import Path
from urllib.request import Request, urlopen
base=Path.home()/".config/metribeacon"
headers=json.loads((base/"headers.json").read_text())
request=Request('https://metribeacon.com/api/v1/logs/connections/00000000-0000-4000-8000-000000000001?workspace_id=00000000-0000-4000-8000-000000000001',headers=headers,method='GET')
with urlopen(request,timeout=60) as response:
print(response.status)
import {readFile} from "node:fs/promises";
import {homedir} from "node:os";
const base=homedir()+"/.config/metribeacon/";
const headers=JSON.parse(await readFile(base+"headers.json","utf8"));
const response=await fetch("https://metribeacon.com/api/v1/logs/connections/00000000-0000-4000-8000-000000000001?workspace_id=00000000-0000-4000-8000-000000000001",{method:"GET",headers,redirect:"error",signal:AbortSignal.timeout(60000)});
console.log(response.status);await response.body?.cancel();
package main
import("bytes";"encoding/json";"fmt";"net/http";"os";"path/filepath";"time")
func main(){home,_:=os.UserHomeDir();base:=filepath.Join(home,".config/metribeacon");raw,e:=os.ReadFile(filepath.Join(base,"headers.json"));if e!=nil{panic("headers unavailable")};var headers map[string]string;if json.Unmarshal(raw,&headers)!=nil{panic("invalid headers")};var body []byte;request,e:=http.NewRequest("GET","https://metribeacon.com/api/v1/logs/connections/00000000-0000-4000-8000-000000000001?workspace_id=00000000-0000-4000-8000-000000000001",bytes.NewReader(body));if e!=nil{panic("request failed")};for k,v:=range headers{request.Header.Set(k,v)};client:=&http.Client{Timeout:60*time.Second,CheckRedirect:func(*http.Request,[]*http.Request)error{return http.ErrUseLastResponse}};response,e:=client.Do(request);if e!=nil{panic("request failed")};defer response.Body.Close();fmt.Println(response.StatusCode)}
Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- POST Replace a lost setup code
Explicitly replaces a lost or expired code for the same current selection. Existing working source keys are preserved.
- POST Configure provider forwarding
Configures only the explicitly selected provider target using the bound authorization. Existing unrelated forwarding is never replaced.
- POST Connect a log source
Explicitly creates or updates a source and selected streams. Repeating the same operation ID and settings preserves resources. Codes and keys are returned only once.