[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Update Pin
DescriptionUpdate the pin for given pinboard. Only admin and member users can perform this action
Request
URLURL
https://vrni.example.com/api/ni/pinboards/{id}/pins/{pin-id}
Path Parameters
Path Parameters
string
id
Required
The Entity ID of object requestion information on
string
pin-id
Required
The ID of pin requesting information on
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
PinResponse
of type(s) application/json
{
"created_timestamp": "1679088763.000000",
"id": "1000:10001:7869000989",
"last_updated_timestamp": "16790887689.000000",
"name": "Pin Name",
"owner": "admin@local",
"pinboard_id": "1000:10002:7869098089",
"pinned_timestamp": "1679088763.000000",
"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
Code Samples
Code Samples
cURL Command
curl -X PUT -H "Content-Type: application/json" -d '{"name":"Pin Name"}' https://vrni.example.com/api/ni/pinboards/{id}/pins/{pin-id}
[{"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
