[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Create Pin
DescriptionCreate a pin for a pinboard. Only admin and member users can perform this action
Request
URLURL
https://vrni.example.com/api/ni/pinboards/{id}/pins
Path Parameters
Path Parameters
string
id
Required
The Entity ID of object requestion information on
Request Body
Request Body
{
"name": "Pin Name",
"query": "Alert where Severity = 'Critical'"
}
string
name
Optional
Name of the pin
string
query
Optional
Search query for the pin
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created
Returns
PinResponse
of type(s) application/json
{
"created_timestamp": 1679088763,
"id": "1000:10001:7869000989",
"last_updated_timestamp": 16790887689,
"name": "Pin Name",
"owner": "admin@local",
"pinboard_id": "1000:10002:7869098089",
"pinned_timestamp": 1679088763,
"query": "Alert where Severity = 'Critical'"
}
string
created_timestamp
Optional
Create timestmp of the pin
string
id
Optional
Model key for the pin
string
last_updated_timestamp
Optional
Last update timestamop of the pin
string
name
Optional
Name of the pin
string
owner
Optional
Owner of the pin
string
pinboard_id
Optional
Model key of the pinboard of which the pin is part of
string
pinned_timestamp
Optional
Timestamp when the pin was pinned
string
query
Optional
Query behind the pin
Errors
ApiError
400
Bad Request
ApiError
401
Unauthorized
ApiError
403
Forbidden
ApiError
404
Not Found
ApiError
500
Internal Error
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"name":"Pin Name","query":"Alert where Severity = 'Critical'"}' https://vrni.example.com/api/ni/pinboards/{id}/pins
[{"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
