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

Update Pin

Description

Update the pin for given pinboard. Only admin and member users can perform this action

Request

Request

URL

URL


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

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


Request Body

Request Body

UpdatePinRequest of type(s) application/json Required

Pin details to be updated

{
    "name": "Pin Name"
}
string
name Optional

Name of the pin

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

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

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 '{"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
Feedback

Was this page helpful?