GET List log sources
/api/v1/logs/sources
Read sources and the owner’s separate daily log usage in an authorized workspace.
On this page
Access and permissions
Read sources and the owner’s separate daily log usage in an authorized workspace.
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 |
|---|---|---|---|---|
| workspace_id | URL query | string; {"format":"uuid"} | Yes | The permitted workspace. |
| id | URL query | string; {"format":"uuid"} | No | Optional exact resource ID within the authorized workspace. |
Request body
No request body.
Responses
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object; {"additionalProperties":false} | Yes | — |
| $.sources | array<CentralLogSource>; {"maxItems":100} | No | — |
| $.sources[] | CentralLogSource | Yes | — |
| $.sources[].agent_status | string | null | No | — |
| $.sources[].agent_status_at | string | null; {"format":"date-time"} | No | — |
| $.sources[].bytes_today | integer | No | — |
| $.sources[].enabled | boolean | No | — |
| $.sources[].entries_today | integer | No | — |
| $.sources[].filtered_today | integer | No | — |
| $.sources[].id | string; {"format":"uuid"} | No | — |
| $.sources[].kind | string; {"enum":["http","otlp","syslog","agent","vercel","heroku","render","railway","fly","cloudflare","cloudwatch","supabase","netlify"]} | No | — |
| $.sources[].last_received_at | string | null; {"format":"date-time"} | No | — |
| $.sources[].last_reject_code | string | null | No | — |
| $.sources[].last_rejected_at | string | null; {"format":"date-time"} | No | — |
| $.sources[].monitor_id | string | null; {"format":"uuid"} | No | — |
| $.sources[].name | string; {"maxLength":128,"minLength":1} | No | — |
| $.sources[].pending | integer | No | — |
| $.sources[].policy | CentralLogPolicy | No | — |
| $.sources[].policy.drop_below | string; {"enum":["unknown","trace","debug","info","warning","error","fatal"]} | No | — |
| $.sources[].policy.masks | array<object; {"additionalProperties":false}>; {"maxItems":32} | No | — |
| $.sources[].policy.masks[] | object; {"additionalProperties":false} | Yes | — |
| $.sources[].policy.masks[].field | string; {"maxLength":256} | No | — |
| $.sources[].policy.masks[].pattern | string; {"maxLength":512} | No | — |
| $.sources[].retained_from | string; {"format":"date-time"} | No | — |
| $.sources[].retention_days | integer; {"maximum":30,"minimum":1} | No | — |
| $.sources[].revision | integer | No | — |
| $.sources[].unobserved_until | string | null; {"format":"date-time"} | No | — |
| $.sources[].workspace_id | string; {"format":"uuid"} | No | — |
| $.sources[].agent_device_id | string; {"format":"uuid"} | No | — |
| $.sources[].streams | array<CentralLogStream>; {"maxItems":100} | No | — |
| $.sources[].streams[] | CentralLogStream | Yes | — |
| $.sources[].streams[].id | string; {"maxLength":128} | Yes | — |
| $.sources[].streams[].name | string | No | — |
| $.sources[].streams[].kind | string | No | — |
| $.sources[].streams[].path | string | No | — |
| $.sources[].streams[].enabled | boolean | Yes | — |
| $.sources[].streams[].status | string | No | — |
| $.sources[].streams[].status_at | string; {"format":"date-time"} | No | — |
| $.sources[].streams[].last_received_at | string; {"format":"date-time"} | No | — |
| $.sources[].streams[].diagnostic | CentralLogDiagnostic | null | No | — |
| $.sources[].streams[].diagnostic (anyOf 1) | CentralLogDiagnostic | No | — |
| $.sources[].streams[].diagnostic (anyOf 1).code | string; {"enum":["transport_error","http_error","helper_unavailable","permission_denied","reader_unavailable","spool_unavailable","buffer_full","source_gap","checkpoint_conflict"]} | Yes | — |
| $.sources[].streams[].diagnostic (anyOf 1).phase | string; {"enum":["policy","upload","reader","spool","startup"]} | Yes | — |
| $.sources[].streams[].diagnostic (anyOf 1).at | string; {"format":"date-time"} | Yes | — |
| $.sources[].streams[].diagnostic (anyOf 1).http_status | integer; {"minimum":100,"maximum":599} | No | — |
| $.sources[].streams[].diagnostic (anyOf 1).server_phase | string; {"enum":["admission","account","storage","usage","source","receipts","outbox","commit","checkpoint"]} | No | — |
| $.sources[].streams[].diagnostic (anyOf 1).sqlstate | string; {"pattern":"^[A-Z0-9]{5}$"} | No | — |
| $.sources[].streams[].diagnostic (anyOf 2) | null | No | — |
| $.sources[].streams[].confirmed_through | string | null; {"format":"date-time"} | No | — |
| $.sources[].device_icon | AlarmMonitorIcon | No | Optional monitor identity for lists. Includes the list area, server platform and the same authenticated favicon address used in monitor lists. Target URLs, credentials and measurements are not included. |
| $.sources[].device_icon.monitor_type | string | Yes | — |
| $.sources[].device_icon.list_group | string; {"enum":["monitors","servers"]} | Yes | — |
| $.sources[].device_icon.summary | object; {"additionalProperties":false} | Yes | — |
| $.sources[].device_icon.summary.platform | string; {"enum":["linux","darwin","windows"]} | No | — |
| $.sources[].device_icon.summary.favicon_url | string | No | — |
| $.usage | CentralLogUsage | No | — |
| $.usage.bytes | integer | Yes | — |
| $.usage.daily_bytes | integer | Yes | — |
| $.usage.entries | integer | Yes | — |
| $.usage.reset_at | string; {"format":"date-time"} | Yes | — |
| Stable error codes |
|---|
| invalid_credential |
| unauthorized |
| 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 |
|---|
| csrf |
| insufficient_scope |
| invalid_origin |
| operator_required |
| 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 |
|---|
| invalid_workspace |
| not_found |
| 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 |
|---|
| invalid_workspace |
| stale_check |
| result_conflict |
| 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 |
|---|
| invalid_config |
| invalid_monitor |
| 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 |
|---|
| invalid_workspace |
| check_capacity |
| 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 |
|---|
| check_location_unavailable |
| feature_unavailable |
| log_admission_busy |
| log_queue_full |
| log_storage_unavailable |
| 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 | — |
Retries and asynchronous work
This operation reads or validates without applying a resource mutation. Respect rate limits and credential lifetime.
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 30 --request GET --header @"$HOME/.config/metribeacon/headers.txt" 'https://metribeacon.com/api/v1/logs/sources?workspace_id=00000000-0000-4000-8000-000000000001'
import json
from pathlib import Path
from urllib.request import Request, urlopen
headers=json.loads((Path.home()/".config/metribeacon/headers.json").read_text())
request=Request('https://metribeacon.com/api/v1/logs/sources?workspace_id=00000000-0000-4000-8000-000000000001',headers=headers,method='GET')
with urlopen(request,timeout=30) as response:
print(response.status)
import {readFile} from "node:fs/promises";
import {homedir} from "node:os";
const headers=JSON.parse(await readFile(homedir()+"/.config/metribeacon/headers.json","utf8"));
const response=await fetch("https://metribeacon.com/api/v1/logs/sources?workspace_id=00000000-0000-4000-8000-000000000001",{method:"GET",headers,redirect:"error",signal:AbortSignal.timeout(30000)});
console.log(response.status);await response.body?.cancel();
package main
import("net/http";"os";"path/filepath";"encoding/json";"time";"fmt")
func main(){home,_:=os.UserHomeDir();raw,e:=os.ReadFile(filepath.Join(home,".config/metribeacon/headers.json"));if e!=nil{panic("headers unavailable")};var h map[string]string;if json.Unmarshal(raw,&h)!=nil{panic("invalid headers")};r,_:=http.NewRequest("GET","https://metribeacon.com/api/v1/logs/sources?workspace_id=00000000-0000-4000-8000-000000000001",nil);for k,v:=range h{r.Header.Set(k,v)};c:=&http.Client{Timeout:30*time.Second,CheckRedirect:func(*http.Request,[]*http.Request)error{return http.ErrUseLastResponse}};res,e:=c.Do(r);if e!=nil{panic("request failed")};defer res.Body.Close();fmt.Println(res.StatusCode)}
Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- POST Create log source
Create a source without a monitor or series. Collection is disabled unless explicitly enabled.
- DELETE Delete log source
Revoke access, discard waiting ingestion and invalidate queries and exports. Physical deletion follows within 24 hours.
- PUT Update log source
Change a revision-bound source. Shorter retention requires confirm_delete and immediately invalidates affected query results.