[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

Edit Pinboard

Description

Edit pinboard. Only admin and member users can perform this action.

Request

Request

URL

URL


put
https://vrni.example.com/api/ni/pinboards/{id}
Copy

Path Parameters

Path Parameters

string
id Required

The Entity ID of object requestion information on


Request Body

Request Body

PinboardRequest of type(s) application/json Required

Pinboard details to be updated

{
	"description": "This is a pinboard",
	"name": "Pinboard Name"
}
string
description Optional

Description of the pinboard


string
name Optional

Name of the pinboard

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns PinboardResponse of type(s) application/json
{
	"create_timestamp": "156789876.000000",
	"description": "This is the pinboard description",
	"groups_read_access": [
		"cn=administrators"
	],
	"groups_write_access": [
		"CN=HR,CN=Users"
	],
	"id": "18799:10002:211561153588",
	"last_updated_timestamp": "156789876.000000",
	"name": "Pinboard Name",
	"owner": "admin@local",
	"pins": [
		{
			"id": "1000:10001:78690089",
			"name": "Pin Name",
			"query": "Alert where Severity = 'Critical'"
		}
	],
	"users_read_access": [
		"user1@vmware.com | user3@vmware.com"
	],
	"users_write_access": [
		"user@vmware.com | user2@vmware.com"
	]
}
string
create_timestamp Optional

Create timestamp for pinboard


string
description Optional

Description of the pinboard


array of string
groups_read_access Optional

LDAP/VIDM groups with read privilege of the pinboard


array of string
groups_write_access Optional

LDAP/VIDM groups with read and write privilege of the pinboard


string
id Optional

Entity Identifier for a pinboard


string
last_updated_timestamp Optional

Last update timestamp for pinboard


string
name Optional

Descriptor or identifier for particular pinboard.


string
owner Optional

User email of the pinboard owner


array of PinAssociation
pins Optional

Pins associated with Pinboard


array of string
users_read_access Optional

List of users with read privilege for the pinboard


array of string
users_write_access Optional

List of users with read and write privilege for the pinboard

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found


500

Internal Error

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"description":"This is a pinboard","name":"Pinboard Name"}' https://vrni.example.com/api/ni/pinboards/{id}


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Feedback

Was this page helpful?