GET

/api/v1/system/logs/{stream}/{file}

Read a sanitized excerpt from a technical log file (at most 256 KiB and 1,000 lines)

Request#

POSIX shell · curl

curl --fail-with-body --request GET \
  "$ADBR_API_URL/api/v1/system/logs/{stream}/{file}" \
  -H "Authorization: Bearer $ADBR_API_TOKEN"

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs.

Authentication and permissions#

Authentication: Bearer token

Scopes: audit:read

All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.

Parameters#

Parameter	Location	Required	Description
`stream`	path	Yes
`file`	path	Yes

Complete parameter schemas

OpenAPI JSON

[
  {
    "schema": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "core"
          ]
        },
        {
          "type": "string",
          "enum": [
            "api"
          ]
        },
        {
          "type": "string",
          "enum": [
            "jobs"
          ]
        },
        {
          "type": "string",
          "enum": [
            "kernel"
          ]
        },
        {
          "type": "string",
          "enum": [
            "relay"
          ]
        }
      ]
    },
    "in": "path",
    "name": "stream",
    "required": true
  },
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 155,
      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,150}\\.log$"
    },
    "example": "core.log",
    "in": "path",
    "name": "file",
    "required": true
  }
]

Request body#

No request body declared.

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "stream",
          "file",
          "size",
          "modified_at",
          "text",
          "lines",
          "truncated"
        ],
        "properties": {
          "stream": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "core"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "api"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "jobs"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "kernel"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "relay"
                ]
              }
            ]
          },
          "file": {
            "type": "string"
          },
          "size": {
            "type": "integer"
          },
          "modified_at": {
            "type": "integer"
          },
          "text": {
            "type": "string"
          },
          "lines": {
            "type": "integer"
          },
          "truncated": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

default · HTTP error envelope. The status and error.code identify the failure.

OpenAPI JSON

{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

General authentication and transport errors may occur in addition to the documented responses.

OpenAPI definition#

Complete operation definition

OpenAPI JSON

{
  "summary": "Bereinigten Auszug einer technischen Protokolldatei lesen (maximal 256 KiB und 1.000 Zeilen)",
  "tags": [
    "System"
  ],
  "parameters": [
    {
      "schema": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "core"
            ]
          },
          {
            "type": "string",
            "enum": [
              "api"
            ]
          },
          {
            "type": "string",
            "enum": [
              "jobs"
            ]
          },
          {
            "type": "string",
            "enum": [
              "kernel"
            ]
          },
          {
            "type": "string",
            "enum": [
              "relay"
            ]
          }
        ]
      },
      "in": "path",
      "name": "stream",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 155,
        "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,150}\\.log$"
      },
      "example": "core.log",
      "in": "path",
      "name": "file",
      "required": true
    }
  ],
  "x-required-scopes": [
    "audit:read"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "stream",
              "file",
              "size",
              "modified_at",
              "text",
              "lines",
              "truncated"
            ],
            "properties": {
              "stream": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "core"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "api"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "jobs"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "kernel"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "relay"
                    ]
                  }
                ]
              },
              "file": {
                "type": "string"
              },
              "size": {
                "type": "integer"
              },
              "modified_at": {
                "type": "integer"
              },
              "text": {
                "type": "string"
              },
              "lines": {
                "type": "integer"
              },
              "truncated": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}