# List Backups

Endpoint: GET /v1/backups
Security: httpAuth

## Query parameters:

  - `limit` (integer)
    The number of entities to return.

  - `startingAfter` (string)
    Entity id used to the determine beginning of query results.

  - `sortBy` (string)
    Property name used to sort the query results.
    Enum: "id", "alias", "metadata.createdAt", "metadata.lastModifiedAt"

  - `sortOrder` (string)
    Sort order applied to the query results.
    Enum: "ASC", "DESC"

  - `vaultId` (string)
    Return entities matching given vault id.
    Example: "8e92eb53-40e7-4809-bb52-7e7b3b41a4be"

  - `lastOnly` (boolean)
    Return entities with acknowledged status and limits results to latest one.
    Example: "true"

  - `acknowledged` (boolean)
    Return entities with acknowledged status equals true.
    Example: "true"

  - `data.type` (string)
    Return entities that matches given type.
    Enum: "VaultHsm", "VaultMpc"

  - `metadata.createdBy` (string)
    Return entities that were created by matching user.
    Example: "fdeeeb4b-f987-4ec4-9880-1eb280581d49"

  - `metadata.lastModifiedBy` (string)
    Return entities that were last modified by matching user.
    Example: "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b"

  - `metadata.description` (string)
    Return entities with descriptions that contains or equals to provided description.
    Example: "description1"

  - `metadata.customProperties` (array)
    Return entities that contains provided custom properties.
    Example: ["key1:value1","key2:value2"]

  - `additionalDetails.processingStatus` (string)
    Return entities matching given processing status.
    Enum: "Pending", "Preparing", "Completed", "Failed"

## Response 200 fields (application/json):

  - `items` (array, required)

  - `items.id` (string, required)

  - `items.data` (any, required)

  - `items.metadata` (object, required)

  - `items.metadata.description` (string)

  - `items.metadata.revision` (integer, required)

  - `items.metadata.createdAt` (string, required)

  - `items.metadata.createdBy` (object)

  - `items.metadata.createdBy.id` (string, required)

  - `items.metadata.createdBy.domainId` (string, required)

  - `items.metadata.lastModifiedAt` (string, required)

  - `items.metadata.lastModifiedBy` (object)

  - `items.metadata.customProperties` (object, required)

  - `items.additionalDetails` (object)

  - `items.additionalDetails.processing` (any, required)

  - `count` (integer, required)

  - `currentStartingAfter` (string)

  - `nextStartingAfter` (string)

## Response 401 fields (application/json):

  - `reason` (string, required)

  - `message` (string)