MetriBeacon
Menu

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

FieldLocationType and limitsRequiredMeaning
workspace_idURL querystring; {"format":"uuid"}YesThe permitted workspace.
idURL querystring; {"format":"uuid"}NoOptional exact resource ID within the authorized workspace.

Request body

No request body.

Responses

application/json

FieldType and limitsRequiredMeaning
$object; {"additionalProperties":false}Yes—
$.sourcesarray<CentralLogSource>; {"maxItems":100}No—
$.sources[]CentralLogSourceYes—
$.sources[].agent_statusstring | nullNo—
$.sources[].agent_status_atstring | null; {"format":"date-time"}No—
$.sources[].bytes_todayintegerNo—
$.sources[].enabledbooleanNo—
$.sources[].entries_todayintegerNo—
$.sources[].filtered_todayintegerNo—
$.sources[].idstring; {"format":"uuid"}No—
$.sources[].kindstring; {"enum":["http","otlp","syslog","agent","vercel","heroku","render","railway","fly","cloudflare","cloudwatch","supabase","netlify"]}No—
$.sources[].last_received_atstring | null; {"format":"date-time"}No—
$.sources[].last_reject_codestring | nullNo—
$.sources[].last_rejected_atstring | null; {"format":"date-time"}No—
$.sources[].monitor_idstring | null; {"format":"uuid"}No—
$.sources[].namestring; {"maxLength":128,"minLength":1}No—
$.sources[].pendingintegerNo—
$.sources[].policyCentralLogPolicyNo—
$.sources[].policy.drop_belowstring; {"enum":["unknown","trace","debug","info","warning","error","fatal"]}No—
$.sources[].policy.masksarray<object; {"additionalProperties":false}>; {"maxItems":32}No—
$.sources[].policy.masks[]object; {"additionalProperties":false}Yes—
$.sources[].policy.masks[].fieldstring; {"maxLength":256}No—
$.sources[].policy.masks[].patternstring; {"maxLength":512}No—
$.sources[].retained_fromstring; {"format":"date-time"}No—
$.sources[].retention_daysinteger; {"maximum":30,"minimum":1}No—
$.sources[].revisionintegerNo—
$.sources[].unobserved_untilstring | null; {"format":"date-time"}No—
$.sources[].workspace_idstring; {"format":"uuid"}No—
$.sources[].agent_device_idstring; {"format":"uuid"}No—
$.sources[].streamsarray<CentralLogStream>; {"maxItems":100}No—
$.sources[].streams[]CentralLogStreamYes—
$.sources[].streams[].idstring; {"maxLength":128}Yes—
$.sources[].streams[].namestringNo—
$.sources[].streams[].kindstringNo—
$.sources[].streams[].pathstringNo—
$.sources[].streams[].enabledbooleanYes—
$.sources[].streams[].statusstringNo—
$.sources[].streams[].status_atstring; {"format":"date-time"}No—
$.sources[].streams[].last_received_atstring; {"format":"date-time"}No—
$.sources[].streams[].diagnosticCentralLogDiagnostic | nullNo—
$.sources[].streams[].diagnostic (anyOf 1)CentralLogDiagnosticNo—
$.sources[].streams[].diagnostic (anyOf 1).codestring; {"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).phasestring; {"enum":["policy","upload","reader","spool","startup"]}Yes—
$.sources[].streams[].diagnostic (anyOf 1).atstring; {"format":"date-time"}Yes—
$.sources[].streams[].diagnostic (anyOf 1).http_statusinteger; {"minimum":100,"maximum":599}No—
$.sources[].streams[].diagnostic (anyOf 1).server_phasestring; {"enum":["admission","account","storage","usage","source","receipts","outbox","commit","checkpoint"]}No—
$.sources[].streams[].diagnostic (anyOf 1).sqlstatestring; {"pattern":"^[A-Z0-9]{5}$"}No—
$.sources[].streams[].diagnostic (anyOf 2)nullNo—
$.sources[].streams[].confirmed_throughstring | null; {"format":"date-time"}No—
$.sources[].device_iconAlarmMonitorIconNoOptional 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_typestringYes—
$.sources[].device_icon.list_groupstring; {"enum":["monitors","servers"]}Yes—
$.sources[].device_icon.summaryobject; {"additionalProperties":false}Yes—
$.sources[].device_icon.summary.platformstring; {"enum":["linux","darwin","windows"]}No—
$.sources[].device_icon.summary.favicon_urlstringNo—
$.usageCentralLogUsageNo—
$.usage.bytesintegerYes—
$.usage.daily_bytesintegerYes—
$.usage.entriesintegerYes—
$.usage.reset_atstring; {"format":"date-time"}Yes—
Stable error codes
invalid_credential
unauthorized
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"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-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
csrf
insufficient_scope
invalid_origin
operator_required
forbidden
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"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-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
invalid_workspace
not_found
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"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-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
invalid_workspace
stale_check
result_conflict
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"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-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
invalid_config
invalid_monitor
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"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-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
invalid_workspace
check_capacity
HeaderType and limitsMeaning
Retry-Afterstring; {"pattern":"^[0-9]+$"}Temporary server error; retry unchanged with Retry-After and the same idempotency identifier

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
check_location_unavailable
feature_unavailable
log_admission_busy
log_queue_full
log_storage_unavailable
unavailable
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"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-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
log_limit
request_too_large
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"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-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"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.

shell
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'
python
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)
javascript
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();
go
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)}
  • 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.