Get agents
GET {{baseUrl}}/agents?filter=<string>&size=20&page=0&sort=<string>
Gets the agents for the given filter.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter | string | JSON based filter. | |
| Filter json can contain following fields: |
- securityProfile (Agents securityProfiles can be "RSA_3072", "SHARED_SECRET") E.g.: {"securityProfile":"SHARED_SECRET"}
- id E.g.: {"id":"3b27818ea09a46b48c7eb3fbd878349f"}
- name
E.g.: {"name":"Nanobox Agent"}
|
|
size| number | | The maximum number of elements in a page. | |page| number | | The (0-based) index of page. | |sort| string | | The order of returned elements. Multiple fields could be used separated by commas (e.g. ''field1,field2''). Descending order could be requested by appending '',desc'' at the end of parameter.(e.g. ''field1,field2,desc'')' |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"content":[{"name":"Nanobox Agent","securityProfile":"NATIVE_CA_CERTIFIED_X509","entityId":"3b27818ea09a46b48c7eb3fbd878349f","id":"3b27818ea09a46b48c7eb3fbd878349f","eTag":"2"},{"name":"Nanobox Agent","securityProfile":"NATIVE_CA_CERTIFIED_X509","entityId":"3b27818ea09a46b48c7eb3fbd878349f","id":"3b27818ea09a46b48c7eb3fbd878349f","eTag":"2"}],"totalPages":1,"totalElements":1,"last":true,"numberOfElements":1,"first":true,"sort":[{"direction":"DESC","property":"in","ignoreCase":true,"nullHandling":"NULLS_FIRST","descending":true,"ascending":false},{"direction":"ASC","property":"dolore et","ignoreCase":true,"nullHandling":"NULLS_LAST","descending":false,"ascending":false}],"size":20,"number":0}