Description: Retrieves a list of components associated with a specific watch.
API Version: v2
Security: Requires a valid user with "Admin" permissions. For Xray 3.8 and above, this only requires a valid user with the "Manage Reports" role.
Usage: GET api/v2/component/data/{watch_name}?limit=(?)&offset=(?)&from=(?)to=(?)
Consumes: None
Produces: application/json
Path parameters:
Name | Type | Required/Optional | Description |
|---|---|---|---|
| string | required | The name of the watch to retrieve components for. |
Query parameters:
Name | Type | Required/Optional | Description |
|---|---|---|---|
| integer | optional | The maximum number of components to retrieve. Default is determined by the server. |
| integer | optional | The offset from which to start retrieving components. Default is 0. |
| string | optional | The start date-time range for filtering components. |
| string | optional | The end date-time range for filtering components. |
Sample Request
GET /api/v2/component/data/xray-demo-watch?limit=3&offset=1
Sample Response
[
{
"checksum": "1e4aa36346ceb27a30ea0fb2a531b35fb74e4fe7cf5231ee94a58736518d5685",
"binary_manager_id": "default",
"repo": "xray-demo-docker-local",
"path": "/ics/latest/manifest.json",
"package_name": "docker://ics",
"version": "latest"
},
{
"checksum": "1e4aa36346ceb27a30ea0fb2a531b35fb74e4fe7cf5231ee94a58736518d5685",
"binary_manager_id": "default",
"repo": "xray-demo-docker-local",
"path": "/ics/latest/manifest.json",
"package_name": "docker://ics/latest",
"version": "latest"
},
{
"checksum": "1e4aa36346ceb27a30ea0fb2a531b35fb74e4fe7cf5231ee94a58736518d5685",
"binary_manager_id": "default",
"repo": "xray-demo-docker-local",
"path": "/ics/latest/manifest.json",
"package_name": "docker://ics1",
"version": "latest"
}
]