Skip to main content

Get an update on a restore operation

GET 
/archive/restore/:id

Returns the status of a specific restore operation by its ID. Please ensure to change the region in the URL to match your account's region.

Request​

Path Parameters

    id int32required

    ID of the restore process

Responses​

successful operation

Response Headers
    Schema
      id int32

      ID of the restore operation in Logz.io

      accountId int32

      ID of the restored account in Logz.io

      accountName string

      Name of the restored account

      restoredVolumeGb floatnullable

      Volume of data restored so far. If the restore operation is still in progress, this will be continuously updated.

      status string

      Possible values: [IN_PROGRESS, ACTIVE, LIMIT_EXCEEDED, ABORTED, FAILED, DELETED, EXPIRED]

      Returns the current status of the restored account.

      • IN_PROGRESS - Data is being restored and is not yet available for querying or searching in Kibana.
      • ACTIVE - The restored account is active and available for searching and querying in Kibana. Be sure to search the data in its original timestamp.
      • LIMIT_EXCEEDED - The data exceeded 100 GB and caused the restore action to fail.
      • ABORTED - A user aborted the restore operation before it completed. Only one account can be restored at a time.
      • FAILED - The restored account failed to restore the data.
      • DELETED - The restored account was deleted by a user.
      • EXPIRED - Restored accounts automatically expire after a number of days, as indicated by expiresAt.
      startTime int64

      UNIX timestamp in milliseconds specifying the earliest logs to be restored.

      endTime int64

      UNIX timestamp in milliseconds specifying the latest logs to be restored.

      createdAt int64

      Timestamp when the restore process was created and entered the queue. (Since only one account can be restored at a time, the process may not initiate immediately.)

      startedAt int64nullable

      UNIX timestamp in milliseconds when the restore process initiated.

      finishedAt int64nullable

      UNIX timestamp in milliseconds when the restore process completed.

      expiresAt int64nullable

      UNIX timestamp in milliseconds specifying when the account is due to expire. Restored accounts expire automatically after a number of days, as specified in the account's terms.

    Loading...