Update Pin | VMware Aria Operations for Networks (SAAS) API

Update Pin

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

Request

URI

PUT

https://www.mgmt.cloud.vmware.com/ni/api/ni/pinboards/{id}/pins/{pin-id}

COPY

Path Parameters

string

Required

The Entity ID of object requestion information on

string

pin-id

Required

The ID of pin requesting information on

Request Body

Pin details to be updated

UpdatePinRequest of type(s) application/json

Required

{
    "name": "Pin Name"
}

string

name

Optional

Name of the pin

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns PinResponse of type(s) application/json

{
    "id": "1000:10001:7869000989",
    "pinboard_id": "1000:10002:7869098089",
    "name": "Pin Name",
    "created_timestamp": 1679088763,
    "last_updated_timestamp": 16790887689,
    "query": "Alert where Severity = 'Critical'",
    "pinned_timestamp": 1679088763,
    "owner": "admin@local"
}

string

Optional

Model key for the pin

string

pinboard_id

Optional

Model key of the pinboard of which the pin is part of

string

name

Optional

Name of the pin

string

created_timestamp

Optional

Create timestmp 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

array of ErrorDetail

details

Optional

details

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

array of ErrorDetail

details

Optional

details

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

array of ErrorDetail

details

Optional

details

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

array of ErrorDetail

details

Optional

details

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

array of ErrorDetail

details

Optional

details