Get All Custom Dashboards

Get All Custom Dashboards

Get the list of all custom dashboards for a user. By default size and cursor would be set to 10 and 0 respectively.

Request
URI
GET
https://{api_host}/api/ni/custom-dashboards
COPY
Query Parameters
number
size
Optional

Page size of results

string
cursor
Optional

Cursor from previous response


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PagedCustomDashboardResponse of type(s) application/json
{
    "results": [
        {
            "id": "18799:10002:211561153588",
            "name": "Custom Dashboard Name",
            "description": "This is the Custom Dashboard description",
            "create_timestamp": "156789876",
            "last_updated_timestamp": "156789876",
            "owner": "admin@local",
            "users_read_access": [
                "user1@vmware.com",
                "user3@vmware.com"
            ],
            "users_write_access": [
                "user@vmware.com",
                "user2@vmware.com"
            ],
            "pins": [
                {
                    "pin_model_key": "1000:10001:78690089",
                    "pin_name": "Pin Name",
                    "query": "Alert where Severity = 'Critical'"
                }
            ],
            "groups_write_access": [
                "CN=HR,CN=Users"
            ],
            "groups_read_access": [
                "cn=administrators"
            ]
        }
    ],
    "cursor": 0,
    "total_records": 0
}
results
Optional

results

integer
cursor
Optional

cursor

integer
total_records
Optional

total_records


400

Bad Request

Returns ApiError of type(s) application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

details
Optional

details


401

Unauthorized

Returns ApiError of type(s) application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

details
Optional

details


404

Not Found

Returns ApiError of type(s) application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

details
Optional

details


500

Internal Error

Operation doesn't return any data structure