Partial response

In this tutorial, you learn how to tailor responses using include_fields and exclude_fields.

In PowerProtect DD REST API, you can select the fields you want to include or exclude from the response by using include_fields or exclude_fields in the query parameter:

?include_fields=<field_name_1>,<field_name_2>...

?exclude_fields=<field_name_1>,<field_name_2>...

For example, if you want to include only name and role fields in the users API response:

curl --request GET \
     --header 'content-type: application/json' \
     --header 'X-DD-AUTH-TOKEN: <auth-token>' \
     --url 'https://<DD-SYSTEM-IP/FQDN>:3009/rest/v1.0/dd-systems/0/users?include_fields=name%2Crole'

If you want to exclude UID and status fields in the users API response:

curl --request GET \
     --header 'content-type: application/json' \
     --header 'X-DD-AUTH-TOKEN: <auth-token>' \
     --url 'https://<DD-SYSTEM-IP/FQDN>:3009/rest/v1.0/dd-systems/0/users?exclude_fields=uid%2Cstatus'