General APIs with JWT

Endpoint to get a specific backup log by ID.

get/backup-logs/{backup_log_id}

Request

  • Base URL: https://lium.io/api
  • URL: https://lium.io/api/backup-logs/{backup_log_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

backup_log_idstring uuid required

Response

Backup log retrieved successfully

idstring uuid required
namestring nullable
descriptionstring nullable
backup_config_idstring uuid required
backup_volume_idstring uuid required
statusstring required
progressnumber required
started_atstring date-time nullable
completed_atstring date-time nullable
error_messagestring nullable
created_atstring date-time required
estimated_backup_size_bytesinteger nullable
estimated_upload_secondsinteger nullable
backup_estimate_warning_codestring nullable
s3_verified_atstring date-time nullable
s3_content_lengthinteger nullable
s3_last_modifiedstring date-time nullable
s3_etagstring nullable
backup_enginestring required
snapshot_idstring nullable
result_qualitystring nullable
stagestring nullable
last_heartbeat_atstring date-time nullable
total_filesinteger nullable
processed_filesinteger nullable
total_bytesinteger nullable
processed_bytesinteger nullable
deletion_statestring nullable
physical_cleanup_atstring date-time nullable
status_messagestring nullable
elapsed_secondsinteger nullable
throughput_bytes_per_secondinteger nullable
estimated_remaining_secondsinteger nullable
failure_reasonstring nullable

Why a FAILED backup failed, as <code>: <detail>. Codes: heartbeat_timeout (the node stopped reporting; says how long before the failure its last report was), cancel_timeout (the node kept reporting but never honoured a cancel; says how long ago it was asked), executor_error (the node reported the failure; its message or exit code), completion_rejected (the node reported success without a snapshot), dispatch_failed (the backup could not be handed to the node). Null on non-failed backups, on backups failed before this field existed, and on the legacy engine.

failed_atstring date-time nullable

When the backup was marked FAILED (UTC).

Changes

    • info

      the endpoint scheme security APIKeyHeader was added to the API

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status