Create Custom Dashboard Pin

Create Custom Dashboard Pin

Create a pin for a custom dashboard. Only admin and member users can perform this action

Request
URI
POST
https://{api_host}/api/ni/custom-dashboards/{id}/pins
COPY
Path Parameters
string
id
Required

The Entity ID of object requestion information on

Request Body

Pin details

CustomPinRequest of type(s) application/json
Required 
{
    "pin_name": "Pin Name",
    "query": "Alert where Severity = 'Critical'"
}
string
pin_name
Optional

Name of the pin

string
query
Optional

Search query behind the pin

Authentication
This operation uses the following authentication methods.
Responses
201

OK

Returns CustomPinResponse of type(s) application/json 
{
    "pin_model_key": "1000:10001:78690089",
    "pin_name": "Pin Name",
    "custom_dashboard_id": "1000:2504:7869098089",
    "query": "Alert where Severity = 'Critical'",
    "created_timestamp": "1679088763",
    "last_updated_timestamp": "16790887689",
    "pinned_timestamp": "1679088763",
    "owner": "admin@local"
}
string
pin_model_key
Optional

Pin model key

string
pin_name
Optional

Name of the pin

string
custom_dashboard_id
Optional

Model key of the custom dashboard of which the pin is part of

string
query
Optional

Search query behind the pin

string
created_timestamp
Optional

Create timestamp of the pin

string
last_updated_timestamp
Optional

Last update timestamp of 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": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "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": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "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": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "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": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "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": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


On This Page
Custom Dashboards Operations
POST
Create Custom Dashboard
POST
Create Custom Dashboard Pin
DELETE
Delete Custom Dashboard
DELETE
Delete Custom Dashboard Pin
POST
Duplicate Custom Dashboard
PUT
Edit Custom Dashboard
GET
Get All Custom Dashboards
GET
Get Custom Dashboard
PUT
Remove Share Custom Dashboard
POST
Set Custom Dashboard Preference
PUT
Share Custom Dashboard
PUT
Update Custom Dashboard Pin