Getting Started
Ddboost Users
Auth
Alerts Notifylists
Cloud Profiles
Cloud Unit
Data Movement Policy
Data Movement
Data Movement Stats Files
Data Movement Stats Mtrees
Data Movement Stats Recall
Managed Files
Filesys
Filesys Block Storage
Licenses
Mdtags
Mtrees
Mtrees Id Rlfiles
Mtrees Id Stats
Mtrees Id Stats Capacity
Mtree Id Stats Compressions
Networks
Network
Network Host Name Reset
Network Host Name
Network Domain Name Reset
Network Domain Name
Network Search Domain Reset
Network Search Domain
Network Dns Server Reset
Network Dns Server
Network Gateway Reset
Network Gateway
Network Gateway Static Ipv4
Network Gateway Static Ipv6
Network Interface
Network Interface Physical
Network Interface Vlan
Network Interface Alias
Network Nic
Cifs Shares
Ddboost
Ddboost Clients
Ddboost Storage Units
Alerts
Nfs
Nfs Exports
Nfs Exports Id Clients
Nfs Exports Id Referrals
Vdisk Devgrps
Vdisk Devices
Vdisk Pools
Vdisk Stimgs
Services
Services Asup
Services Asup Reset
Iscsi
Services License Server
Services Log
Mdtags Services
Services Ntp
Snmp
Settings
Tenant Units
Tenants
Snapshots
Stats
Stats Capacity
Comp Measurements Support Check
Comp Measurements
Stats File Replications
Filesys Stats
Stats Performances Mtrees
Stats Systems File Replications
Storage Disks
Support
Support Bundles
System
System Repl
System Space
Users
Users Id Pre Check
Sso Registration
Trust
Filesys Object Store
Filesys Object Stores Aws
Cloudiq
Cifs Auth

Page the list result

In this tutorial, you can learn how to tailor responses according to your paging requirements.

Paging in the response

Each GET list API response includes the following paging information:

  • current_page: Current page number
  • page_entries: Number of entries in the page
  • total_entries: Total number of entries
  • page_size: Size of each page
  • page_links: Structure containing links to first, previous, next, and last pages

For example,

"paging_info": {
    "current_page": 0,
    "page_entries": 5,
    "total_entries": 7,
    "page_size": 5,
    "page_links": [
    {
       "rel": "first",
       "href": "/rest/v1.0/dd-systems/0/mtrees?page=0&size=5"
    },
    {
       "rel": "last",
       "href": "/rest/v1.0/dd-systems/0/mtrees?page=1&size=5"
    },
    {
       "rel": "next",
       "href": "/rest/v1.0/dd-systems/0/mtrees?page=1&size=5"
    }
   ]
}

Random access paging

In the PowerProtect DD system, most of the APIs that potentially return a list of resources support random access pagination.

You can implement random access pagination by using the query parameters “page” and “size”:

  • page - the current page number
  • size - the size of each page

?page=<page-number>&size=<page-size>

For example, if you want to get users on the first page with a page size of 20:

curl --request GET \
     --header 'content-type: application/json' \
     --header 'X-DD-AUTH-TOKEN: <your-auth-token>' \
     --url 'https://<DD-SYSTEM-IP/FQDN>:3009/rest/v1.0/dd-systems/0/users?page=0&size=20'

If you specify no paging parameters, the default values apply:

  • page - 0
  • size - 20

The maximum page size is 200, and the page number starts at 0.