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

Get All Pinboards

Description

Get the list of all pinboards for a user

Request

Request

URL

URL


get
https://vrni.example.com/api/ni/pinboards
Copy

Query Parameters

Query Parameters

string
cursor Optional

Cursor from previous response


number
size Optional

Page size of results


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns PagedPinboardResponse of type(s) application/json
{
	"cursor": 0,
	"results": [
		{
			"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"
			]
		}
	],
	"total_records": 0
}
integer
cursor Optional

array of PinboardResponse
results Optional

integer
total_records Optional
Errors

Errors

400

Bad Request


401

Unauthorized


404

Not Found


500

Internal Error

Code Samples

Code Samples

cURL Command

curl https://vrni.example.com/api/ni/pinboards


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

Was this page helpful?