POST Create log export
/api/v1/logs/exports
Start a CSV or NDJSON export over a frozen filter snapshot. Exceeding the complete-export limit fails explicitly instead of returning truncated output.
On this page
Access and permissions
Start a CSV or NDJSON export over a frozen filter snapshot. Exceeding the complete-export limit fails explicitly instead of returning truncated output.
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 |
|---|---|---|---|---|
| format | URL query | string; {"enum":["csv","ndjson"]} | Yes | Export format. Export limits are checked before download. |
Request body
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | CentralLogQuery | Yes | — |
| $.cursor | string; {"maxLength":4096} | No | — |
| $.environment | string | No | — |
| $.from | string; {"format":"date-time"} | No | — |
| $.host | string | No | — |
| $.levels | array<string>; {"maxItems":7} | No | — |
| $.levels[] | string | Yes | — |
| $.limit | integer; {"default":50,"maximum":100,"minimum":1} | No | — |
| $.pattern | string | No | — |
| $.service | string | No | — |
| $.snapshot | string; {"format":"date-time"} | No | — |
| $.source_ids | array<string; {"format":"uuid"}>; {"maxItems":100} | No | — |
| $.source_ids[] | string; {"format":"uuid"} | Yes | — |
| $.text | string; {"maxLength":4096} | No | — |
| $.to | string; {"format":"date-time"} | No | — |
| $.trace_id | string | No | — |
| $.workspace_id | string; {"format":"uuid"} | Yes | — |
| $.facet_fields | array<string; {"enum":["service","environment","host","level","source_id"]}>; {"maxItems":5} | No | Additional exact field-value counts to calculate for the complete filtered time range. Omit when not needed; normal search still returns the complete count, histogram and message patterns. |
| $.facet_fields[] | string; {"enum":["service","environment","host","level","source_id"]} | Yes | — |
| $.stream_id | string; {"maxLength":128} | No | — |
| $.incident_id | string; {"format":"uuid"} | No | — |
| $.incident_scope | string; {"enum":["associated","workspace"]} | No | — |
| $.incident_mode | string; {"enum":["matched","warnings","all"]} | No | — |
Responses
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | CentralLogExportJob | Yes | — |
| $.error_code | string | null | No | — |
| $.id | string; {"format":"uuid"} | Yes | — |
| $.result | CentralLogResult | No | — |
| $.result.count | integer | No | — |
| $.result.facets | array<object; {"additionalProperties":false}>; {"maxItems":150} | No | — |
| $.result.facets[] | object; {"additionalProperties":false} | Yes | — |
| $.result.facets[].count | integer | No | — |
| $.result.facets[].field | string | No | — |
| $.result.facets[].value | string | No | — |
| $.result.histogram | array<object; {"additionalProperties":false}>; {"maxItems":1000} | No | — |
| $.result.histogram[] | object; {"additionalProperties":false} | Yes | — |
| $.result.histogram[].count | integer | No | — |
| $.result.histogram[].level | string | No | — |
| $.result.histogram[].time | string; {"format":"date-time"} | No | — |
| $.result.next_cursor | string | No | — |
| $.result.patterns | array<object; {"additionalProperties":false}>; {"maxItems":30} | No | — |
| $.result.patterns[] | object; {"additionalProperties":false} | Yes | — |
| $.result.patterns[].count | integer | No | — |
| $.result.patterns[].message | string | No | — |
| $.result.patterns[].pattern | string | No | — |
| $.result.pending | integer | No | — |
| $.result.records | array<CentralLogRecord>; {"maxItems":100} | No | — |
| $.result.records[] | CentralLogRecord | Yes | — |
| $.result.records[].attributes | object; {"additionalProperties":true} | No | — |
| $.result.records[].body | JSON | No | — |
| $.result.records[].environment | string | No | — |
| $.result.records[].host | string | No | — |
| $.result.records[].id | string; {"maxLength":256} | Yes | — |
| $.result.records[].level | string | Yes | — |
| $.result.records[].message | string; {"maxLength":65536} | Yes | — |
| $.result.records[].pattern | string | Yes | — |
| $.result.records[].received_at | string; {"format":"date-time"} | Yes | — |
| $.result.records[].resource | object; {"additionalProperties":true} | No | — |
| $.result.records[].scope | string | No | — |
| $.result.records[].service | string | No | — |
| $.result.records[].source_id | string; {"format":"uuid"} | Yes | — |
| $.result.records[].span_id | string | No | — |
| $.result.records[].time | string; {"format":"date-time"} | Yes | — |
| $.result.records[].time_origin | string | Yes | — |
| $.result.records[].trace_id | string | No | — |
| $.result.records[].workspace_id | string; {"format":"uuid"} | Yes | — |
| $.result.snapshot | string; {"format":"date-time"} | No | — |
| $.result.incomplete | boolean | No | — |
| $.result.expires_at | string; {"format":"date-time"} | No | — |
| $.result.summary_pending | boolean | No | Records are available while complete-range counts, histogram, facets and patterns are still being calculated. Their interim zero or empty values are not final statistics. |
| $.result.observation_state | string; {"enum":["complete","delivery_delayed","catching_up","incomplete"]} | No | — |
| $.result.observation_issues | array<CentralLogObservationIssue>; {"maxItems":100} | No | — |
| $.result.observation_issues[] | CentralLogObservationIssue | Yes | — |
| $.result.observation_issues[].source_id | string; {"format":"uuid"} | Yes | — |
| $.result.observation_issues[].source_name | string | Yes | — |
| $.result.observation_issues[].stream_id | string | Yes | — |
| $.result.observation_issues[].stream_name | string | Yes | — |
| $.result.observation_issues[].status | string | Yes | — |
| $.result.observation_issues[].code | string | Yes | — |
| $.result.observation_issues[].phase | string | Yes | — |
| $.result.observation_issues[].started_at | string; {"format":"date-time"} | Yes | — |
| $.result.observation_issues[].ended_at | string; {"format":"date-time"} | No | — |
| $.result.observation_issues[].http_status | integer | No | — |
| $.result.observation_issues[].server_phase | string | No | — |
| $.result.observation_issues[].sqlstate | string | No | — |
| $.result.observation_issues[].last_at | string; {"format":"date-time"} | No | — |
| $.status | string; {"enum":["queued","running","complete","failed","cancelled"]} | Yes | — |
| $.from_time | string; {"format":"date-time"} | Yes | — |
| $.to_time | string; {"format":"date-time"} | Yes | — |
| $.created_at | string; {"format":"date-time"} | Yes | — |
| $.expires_at | string; {"format":"date-time"} | Yes | — |
| $.row_key | string | Yes | — |
| $.workspace_id | string; {"format":"uuid"} | Yes | — |
| $.format | string; {"enum":["csv","ndjson"]} | Yes | — |
| $.completed_at | string | null; {"format":"date-time"} | Yes | — |
| $.result_available | boolean | Yes | — |
| $.download_url | string | No | — |
| $.error_detail | object | No | — |
| $.error_detail.message_key | string | No | — |
| $.error_detail.message_params | object | No | — |
| 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 |
| account_busy |
| database_lock_timeout |
| database_timeout |
| database_unavailable |
| database_error |
| request_cancelled |
| 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.
HTTP 202 means the background job was accepted. Use the returned job ID to check its status. Download results when the job is complete, or inspect its error or cancellation status.
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 POST --header @"$HOME/.config/metribeacon/headers.txt" --header "Content-Type: application/json" --data-binary '{"workspace_id":"00000000-0000-4000-8000-000000000001","text":"service:api level:>=error","source_ids":[],"levels":[]}' 'https://metribeacon.com/api/v1/logs/exports?format=ndjson'
import json
from pathlib import Path
from urllib.request import Request, urlopen
headers=json.loads((Path.home()/".config/metribeacon/headers.json").read_text())
headers["Content-Type"]="application/json"
request=Request('https://metribeacon.com/api/v1/logs/exports?format=ndjson',headers=headers,method='POST',data='{"workspace_id":"00000000-0000-4000-8000-000000000001","text":"service:api level:>=error","source_ids":[],"levels":[]}'.encode())
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"));
headers["Content-Type"]="application/json";
const response=await fetch("https://metribeacon.com/api/v1/logs/exports?format=ndjson",{method:"POST",headers,redirect:"error",signal:AbortSignal.timeout(30000),body:"{\"workspace_id\":\"00000000-0000-4000-8000-000000000001\",\"text\":\"service:api level:>=error\",\"source_ids\":[],\"levels\":[]}"});
console.log(response.status);await response.body?.cancel();
package main
import("net/http";"os";"path/filepath";"encoding/json";"time";"fmt";"strings")
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("POST","https://metribeacon.com/api/v1/logs/exports?format=ndjson",strings.NewReader("{\"workspace_id\":\"00000000-0000-4000-8000-000000000001\",\"text\":\"service:api level:>=error\",\"source_ids\":[],\"levels\":[]}"));for k,v:=range h{r.Header.Set(k,v)};r.Header.Set("Content-Type","application/json");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.
- GET Read log export status
Read the status of your protected export job. Download becomes available only after the complete export is ready.
- GET Download log export
Download a complete export while its current workspace access, source revisions and retention remain valid.
- GET Read approved log policy
A source write key reads only its own enabled state and masking policy. It cannot approve new local files or commands.