Skip to content

List archives

Method

GET https://papi.afi.ai/api/v1/tenants/{tenant_id}/archives

Description

Retrieves a list of archives for the specified tenant and resource.

Path params
tenant_id string required

ID of the tenant for which to retrieve the list of archives.
Query params
resource_id string

Optional ID of a specific resource to list archives for.
limit int32

Maximum number of items to return in a single page.
page_token string

Token from the previous list operation (next_page_token) to continue listing.

 
curl -X GET \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/tenants/{tenant_id}/archives
Successful response (200) schema
object

ArchivePage represents a page of archive listing results.
next_page_token string

Token for the next page in the listing operation, to be used in the next request's page_token. Empty on the last page.
items array of objects

List of archives.

object

Represents a set of related backups (a backup sequence) of a single resource stored in the same location (such as a full backup and subsequent incremental backups). A resource can have several backup archives associated with it.
id string

Unique ID of the archive.
tenant_id string

ID of the tenant where the archive belongs.
delete_pending boolean

Indicates whether the archive and its data are scheduled for deletion.
created_at date-time

Date of archive creation.
stats object

Statistics related to the archive.

object

Provides storage and other statistics for the archive.
size uint64

Storage size used by the archive, in KB.
Response example
{
  "next_page_token": "string",
  "items": [
    {
      "id": "string",
      "tenant_id": "string",
      "delete_pending": true,
      "created_at": "2024-11-15T12:47:12.547424Z",
      "stats": {
        "size": "uint64-as-string"
      }
    }
  ]
}