Edit Custom Dashboard | VMware Aria Operations for Networks API

Edit Custom Dashboard

Edit custom dashboard. Only admin and member users can perform this action.

Request

URI

PUT

https://{api_host}/api/ni/custom-dashboards/{id}

COPY

Path Parameters

string

Required

The Entity ID of object requestion information on

Request Body

Custom dashboard details to be updated

CustomDashboardRequest of type(s) application/json

Required

{
    "name": "Custom Dashboard Name",
    "description": "This is a Custom Dashboard"
}

string

name

Optional

Name of the custom dashboard

string

description

Optional

Description of the custom dashboard

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns CustomDashboardResponse of type(s) application/json

{
    "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"
    ]
}

string

Optional

Entity Identifier for a custom dashboard

string

name

Optional

Descriptor or identifier for particular custom dashboard.

string

description

Optional

Description of the custom dashboard

string

create_timestamp

Optional

Create timestamp for custom dashboard

string

last_updated_timestamp

Optional

Last update timestamp for custom dashboard

string

owner

Optional

User email of the custom dashboard owner

array of string

users_read_access

Optional

List of users with read privilege for the custom dashboard

array of string

users_write_access

Optional

List of users with read and write privilege for the custom dashboard

array of CustomPinObject

pins

Optional

Pins associated with custom dashboard

array of string

groups_write_access

Optional

LDAP/VIDM groups with read and write privilege of the custom dashboard

array of string

groups_read_access

Optional

LDAP/VIDM groups with read privilege of the custom dashboard

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

array of ErrorDetail

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

array of ErrorDetail

details

Optional

details

403

Forbidden

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

array of ErrorDetail

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

array of ErrorDetail

details

Optional

details

500

Internal Error

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

array of ErrorDetail

details

Optional

details