Update Pin
This api is deprecated. Please use custom dashboard api instead.
Request
URI
PUT
https://vrni.example.com/api/ni/pinboards/{id}/pins/{pin-id}
COPY
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
UpdatePinRequest of type(s) application/json
Optional
{
"pin_name": "Pin Name"
}
string
pin_name
Optional
Name of the pin
Responses
200
OK
Returns PinResponse of type(s) application/json
{
"id": "1000:10001:7869000989",
"custom_dashboard_id": "1000:2504:7869098089",
"name": "Pin Name",
"created_timestamp": 1679088763,
"last_updated_timestamp": 16790887689,
"query": "Alert where Severity = 'Critical'",
"pinned_timestamp": 1679088763,
"owner": "admin@local"
}
string
id
Optional
Model key for the pin
string
custom_dashboard_id
Optional
Model key of the custom dashboard of which the pin is part of
string
name
Optional
Name of the pin
string
created_timestamp
Optional
Create timestamp of the pin
string
last_updated_timestamp
Optional
Last update timestamop of the pin
string
query
Optional
Query behind the pin
string
pinned_timestamp
Optional
Timestamp when the pin was pinned
string
owner
Optional
Owner of the pin
400
Bad Request
Returns ApiError of type(s) application/json
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}
integer As int32 As int32
code
Optional
code
string
message
Optional
message
401
Unauthorized
Returns ApiError of type(s) application/json
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}
integer As int32 As int32
code
Optional
code
string
message
Optional
message
403
Forbidden
Returns ApiError of type(s) application/json
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}
integer As int32 As int32
code
Optional
code
string
message
Optional
message
404
Not Found
Returns ApiError of type(s) application/json
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}
integer As int32 As int32
code
Optional
code
string
message
Optional
message
500
Internal Error
Returns ApiError of type(s) application/json
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}
integer As int32 As int32
code
Optional
code
string
message
Optional
message