Skip to content

archivalEntities

Lists all the user-created archival entities. This includes data center archival targets and cloud-native archival target mappings.

Arguments

Argument Type Description
first Int Returns the first n elements from the list.
after String An opaque cursor returned from a previous query's endCursor field. Pass this value verbatim to retrieve the next page of results.
last Int Returns the last n elements from the list.
before String An opaque cursor returned from a previous query's startCursor field. Pass this value verbatim to retrieve the previous page of results.
filter [ArchivalEntityFilterInput!] Specifies how to filter the list of archival entities.
sortBy ArchivalEntityQuerySortByField Specifies the field by which the list of archival entities will be sorted.
sortOrder SortOrder Sorts the order of results.

Returns

ArchivalEntityConnection!

Sample

query {
  archivalEntities(first: 10) {
    nodes {
      useCaseType
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}
{}
{
  "data": {
    "archivalEntities": {
      "nodes": [
        [
          {
            "useCaseType": "BACKUP"
          }
        ]
      ],
      "pageInfo": {
        "endCursor": "example-string",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example-string"
      }
    }
  }
}