v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Addons /

Get addon backup logs

Get logs for an addon backup

Required permission

Project > Addons > Deployment > View Instance Logs

Path parameters

    • projectId

      string required
      ID of the project

    • addonId

      string required
      ID of the addon

    • backupId

      string required
      ID of the backup

Query parameters

    • containerName

      string
      Limits logs to a specific container.

    • queryType

      string
      `range` selects a log range and returns immediately.
      one of
      range

    • startTime

      string
      Fetch logs generated after this timestamp.

    • endTime

      string
      Fetch logs generated before this timestamp.

    • duration

      integer
      Range duration in seconds. If set, only one of `startTime` or `endTime` can be set.

    • lineLimit

      number
      Number of log lines to fetch.

    • direction

      string
      Ordering of log lines
      one of
      backward, forward

    • textIncludes

      string
      Filter log lines to match this search string

    • textNotIncludes

      string
      Filter log lines to not match this search string

    • regexIncludes

      string
      Filter log lines to match this regular expression

    • regexNotIncludes

      string
      Filter log lines to not match this regular expression

Response body

  • {object}
    Response object.

    • data

      [array] required
      Result data.
      • {object}

        • containerId

          string required

        • log

          required

        • ts

          string required
API
CLI
JS Client

GET /v1/projects/{projectId}/addons/{addonId}/backups/{backupId}/logs

Example response

200 OK

List of logs values

JSON

{
  "data": [
    {
      "log": "stdout F This is a log line",
      "ts": "2023-03-21T15:01:17.310Z"
    }
  ]
}

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com