This is the multi-page printable view of this section. Click here to print.
ListDashboards
1 - 1.2
scpcli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]
[--type <value>]
[--service_code <value>]
Description
Get list of dashboards
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | name:asc or modified_at:desc |
| name optional | string | Dashboard's name | MyProd |
| name_like optional | string | Wildcard Search for Dashboard Names | MyProd |
| favorite_enabled optional | boolean | Whether it is a favorite dashboard | True |
| type optional | string | Dashboard type | Custom |
| service_code optional | string | Associated service code | virtualserver |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| created_at | Created date time | |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| name | Dashboard’s name | Production-Web-Servers |
| type | Dashboard type | Custom |
2 - 1.1
scpcli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]
Description
Get list of dashboards
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | name:asc or modified_at:desc |
| name optional | string | Dashboard's name | MyProd |
| name_like optional | string | Wildcard Search for Dashboard Names | MyProd |
| favorite_enabled optional | boolean | Whether it is a favorite dashboard | True |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| created_at | Created date time | |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| name | Dashboard’s name | Production-Web-Servers |
| type | Dashboard type | Custom |
3 - 1.0
scpcli servicewatch dashboard list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--name_like <value>]
[--favorite_enabled <value>]
Description
Get list of dashboards
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | name:asc or modified_at:desc |
| name optional | string | Dashboard's name | MyProd |
| name_like optional | string | Wildcard Search for Dashboard Names | MyProd |
| favorite_enabled optional | boolean | Whether it is a favorite dashboard | True |
Responses
| Name | Description | Example |
|---|---|---|
| id | Dashboard’s unique ID | b48e730a70e74f6aa3d2555000b5c22b |
| created_at | Created date time | |
| favorite_enabled | Whether it is a favorite dashboard | True |
| modified_at | Modified date time | |
| name | Dashboard’s name | Production-Web-Servers |
| type | Dashboard type | Custom |