Requesting managed system data

Edit online

This example shows how to request managed system data, which includes information about applications, groups, nodes, tables, self-describing agent (SDA) records, and Take Action command definitions.

Paths for managed system data endpoints include /system in the address.

When requesting managed system data, you can request information about all items, or you can use parameters to filter the results. The parameters that are available vary by endpoint and include name, affinity ID (id) and product.

You can use the following paths to request all applications, groups, nodes, SDA records, or Take Action definitions respectively:
```
https://host:port/api/v1/system/applications
```
```
https://host:port/api/v1/system/groups
```
```
https://host:port/api/v1/system/nodes
```
```
https://host:port/api/v1/system/sda
```
```
https://host:port/api/v1/system/actions
```
Note: Requesting all tables using the GET /system/tables endpoint is not supported.

Using information returned in the responses from the previous requests, you can then refine each request to be more specific, as shown in the following examples:

https://host:port/api/v1/system/applications?name=name&id=affinity_id

https://host:port/api/v1/system/groups?name=name&id=affinity_id

https://host:port/api/v1/system/nodes?name=name&id=affinity_id

https://host:port/api/v1/system/tables?name=name

https://host:port/api/v1/system/sda?node=node&product=product

https://host:port/api/v1/system/actions?name=name&id=affinity_id

Note: The name parameter is required for the

GET
/system/tables

endpoint.

The response for each of these endpoints is a JSON document that contains an array of objects that represent the records returned. Using the returned data, you can refine your requests for retrieving collection data, as shown in Requesting collection data.