[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Create Pinboard
DescriptionCreate Pinboard. Only admin and member users can perform this action
Request
URLURL
https://vrni.example.com/api/ni/pinboards
Request Body
Request Body
{
"description": "This is a pinboard",
"name": "Pinboard Name"
}
string
description
Optional
Description of the pinboard
string
name
Optional
Name of the pinboard
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created
Returns
PinboardResponse
of type(s) application/json
{
"create_timestamp": 156789876,
"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,
"name": "Pinboard Name",
"owner": "admin@local",
"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
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
ApiError
400
Bad Request
401
Unauthorized
500
Internal Error
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"description":"This is a pinboard","name":"Pinboard Name"}' https://vrni.example.com/api/ni/pinboards
[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
On This Page
Pinboards Operations
post
post
delete
delete
post
put
get
put
put