Get All Pinboards
Get the list of all pinboards for a user
Request
URI
GET
https://vrni.example.com/api/ni/pinboards
COPY
Query Parameters
number
size
Optional
Page size of results
string
cursor
Optional
Cursor from previous response
Responses
200
OK
Returns PagedPinboardResponse of type(s) application/json
{
"results": [
{
"id": "18799:10002:211561153588",
"name": "Pinboard Name",
"description": "This is the pinboard description",
"create_timestamp": 156789876,
"last_updated_timestamp": 156789876,
"owner": "admin@local",
"users_read_access": [
"user1@vmware.com",
"user3@vmware.com"
],
"users_write_access": [
"user@vmware.com",
"user2@vmware.com"
],
"pins": [
{
"id": "1000:10001:78690089",
"name": "Pin Name",
"query": "Alert where Severity = 'Critical'"
}
],
"groups_write_access": [
"CN=HR,CN=Users"
],
"groups_read_access": [
"cn=administrators"
]
}
],
"cursor": 0,
"total_records": 0
}
integer
cursor
Optional
cursor
integer
total_records
Optional
total_records
400
Bad Request
Returns ApiError of type(s) application/json
{
"code": 0,
"message": "string",
"details": [
{
"code": 0,
"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": 0,
"message": "string",
"details": [
{
"code": 0,
"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": 0,
"message": "string",
"details": [
{
"code": 0,
"message": "string",
"target": [
"string"
]
}
]
}
integer As int32 As int32
code
Optional
code
string
message
Optional
message
500
Internal Error
Operation doesn't return any data structure