/kibana-observability | Type: Application | PCID required: Yes
Tools
kibana_observability_bulk_delete_op
Bulk delete SLO definitions and their associated summary and rollup data. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
kbn-xsrf | string | Yes | — | Cross-site request forgery protection |
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
list | string[] | Yes | — | An array of SLO Definition id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"kbn-xsrf": {
"type": "string",
"description": "Cross-site request forgery protection"
},
"spaceId": {
"type": "string",
"description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used."
},
"list": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of SLO Definition id"
}
},
"required": [
"PCID",
"kbn-xsrf",
"spaceId",
"list"
]
}
kibana_observability_bulk_delete_status_op
Retrieve the status of the bulk deletion Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
kbn-xsrf | string | Yes | — | Cross-site request forgery protection |
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
taskId | string | Yes | — | The task id of the bulk delete operation |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"kbn-xsrf": {
"type": "string",
"description": "Cross-site request forgery protection"
},
"spaceId": {
"type": "string",
"description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used."
},
"taskId": {
"type": "string",
"description": "The task id of the bulk delete operation"
}
},
"required": [
"PCID",
"kbn-xsrf",
"spaceId",
"taskId"
]
}
kibana_observability_create_slo_op
Create an SLO Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
kbn-xsrf | string | Yes | — | Cross-site request forgery protection |
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
artifacts | object | No | — | Links to related assets for the SLO |
budgetingMethod | string | Yes | — | The budgeting method to use when computing the rollup data. |
description | string | Yes | — | A description for the SLO. |
groupBy | string[] | No | — | optional group by field or fields to use to generate an SLO per distinct value |
id | string | No | — | A optional and unique identifier for the SLO. Must be between 8 and 36 chars |
indicator | object | Yes | — | The indicator value |
name | string | Yes | — | A name for the SLO. |
objective | object | Yes | — | Defines properties for the SLO objective |
settings | object | No | — | Defines properties for SLO settings. |
tags | string[] | No | — | List of tags |
timeWindow | object | Yes | — | Defines properties for the SLO time window |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"kbn-xsrf": {
"type": "string",
"description": "Cross-site request forgery protection"
},
"spaceId": {
"type": "string",
"description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used."
},
"artifacts": {
"type": "object",
"description": "Links to related assets for the SLO",
"properties": {
"dashboards": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of dashboard references"
}
}
},
"budgetingMethod": {
"type": "string",
"description": "The budgeting method to use when computing the rollup data.",
"enum": [
"occurrences",
"timeslices"
]
},
"description": {
"type": "string",
"description": "A description for the SLO."
},
"groupBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "optional group by field or fields to use to generate an SLO per distinct value"
},
"id": {
"type": "string",
"description": "A optional and unique identifier for the SLO. Must be between 8 and 36 chars"
},
"indicator": {
"description": "The indicator value"
},
"name": {
"type": "string",
"description": "A name for the SLO."
},
"objective": {
"type": "object",
"description": "Defines properties for the SLO objective",
"properties": {
"target": {
"type": "number",
"description": "the target objective between 0 and 1 excluded"
},
"timesliceTarget": {
"type": "number",
"description": "the target objective for each slice when using a timeslices budgeting method"
},
"timesliceWindow": {
"type": "string",
"description": "the duration of each slice when using a timeslices budgeting method, as {duraton}{unit}"
}
},
"required": [
"target"
]
},
"settings": {
"type": "object",
"description": "Defines properties for SLO settings.",
"properties": {
"frequency": {
"type": "string",
"description": "The interval between checks for changes in the source data. The minimum value is 1m and the maximum is 59m. The default value is 1 minute."
},
"preventInitialBackfill": {
"type": "boolean",
"description": "Start aggregating data from the time the SLO is created, instead of backfilling data from the beginning of the time window."
},
"syncDelay": {
"type": "string",
"description": "The time delay in minutes between the current time and the latest source data time. Increasing the value will delay any alerting. The default value is 1 minute. The minimum value is 1m and the maximum is 359m. It should always be greater then source index refresh interval."
},
"syncField": {
"type": "string",
"description": "The date field that is used to identify new documents in the source. It is strongly recommended to use a field that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it accounts for data transmission delays. When unspecified, we use the indicator timestamp field."
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags"
},
"timeWindow": {
"type": "object",
"description": "Defines properties for the SLO time window",
"properties": {
"duration": {
"type": "string",
"description": "the duration formatted as {duration}{unit}. Accepted values for rolling: 7d, 30d, 90d. Accepted values for calendar aligned: 1w (weekly) or 1M (monthly)"
},
"type": {
"type": "string",
"description": "Indicates weither the time window is a rolling or a calendar aligned time window.",
"enum": [
"rolling",
"calendarAligned"
]
}
},
"required": [
"duration",
"type"
]
}
},
"required": [
"PCID",
"kbn-xsrf",
"spaceId",
"budgetingMethod",
"description",
"indicator",
"name",
"objective",
"timeWindow"
]
}
kibana_observability_delete_parameter
Delete a parameter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID for the parameter to delete. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID for the parameter to delete."
}
},
"required": [
"PCID",
"id"
]
}
kibana_observability_delete_parameters
Delete parameters Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | string[] | No | — | An array of parameter IDs to delete. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of parameter IDs to delete."
}
},
"required": [
"PCID"
]
}
kibana_observability_delete_private_location
Delete a private location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique identifier of the private location to be deleted. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The unique identifier of the private location to be deleted."
}
},
"required": [
"PCID",
"id"
]
}
kibana_observability_delete_rollup_data_op
Batch delete rollup and summary data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
kbn-xsrf | string | Yes | — | Cross-site request forgery protection |
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
list | string[] | Yes | — | An array of slo ids |
purgePolicy | object | Yes | — | Policy that dictates which SLI documents to purge based on age |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"kbn-xsrf": {
"type": "string",
"description": "Cross-site request forgery protection"
},
"spaceId": {
"type": "string",
"description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used."
},
"list": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of slo ids"
},
"purgePolicy": {
"type": "object",
"description": "Policy that dictates which SLI documents to purge based on age"
}
},
"required": [
"PCID",
"kbn-xsrf",
"spaceId",
"list",
"purgePolicy"
]
}
kibana_observability_delete_slo_instances_op
Batch delete rollup and summary data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
kbn-xsrf | string | Yes | — | Cross-site request forgery protection |
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
list | object[] | Yes | — | An array of slo id and instance id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"kbn-xsrf": {
"type": "string",
"description": "Cross-site request forgery protection"
},
"spaceId": {
"type": "string",
"description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used."
},
"list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"instanceId": {
"type": "string",
"description": "The SLO instance identifier"
},
"sloId": {
"type": "string",
"description": "The SLO unique identifier"
}
},
"required": [
"sloId",
"instanceId"
]
},
"description": "An array of slo id and instance id"
}
},
"required": [
"PCID",
"kbn-xsrf",
"spaceId",
"list"
]
}
kibana_observability_delete_slo_op
Delete an SLO Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
kbn-xsrf | string | Yes | — | Cross-site request forgery protection |
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
sloId | string | Yes | — | An identifier for the slo. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"kbn-xsrf": {
"type": "string",
"description": "Cross-site request forgery protection"
},
"spaceId": {
"type": "string",
"description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used."
},
"sloId": {
"type": "string",
"description": "An identifier for the slo."
}
},
"required": [
"PCID",
"kbn-xsrf",
"spaceId",
"sloId"
]
}
kibana_observability_delete_synthetic_monitor
Delete a monitor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The identifier for the monitor that you want to delete. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The identifier for the monitor that you want to delete."
}
},
"required": [
"PCID",
"id"
]
}
kibana_observability_delete_synthetic_monitors
Delete monitors Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | string[] | Yes | — | An array of monitor IDs to delete. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of monitor IDs to delete."
}
},
"required": [
"PCID",
"ids"
]
}
kibana_observability_disable_slo_op
Disable an SLO Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
kbn-xsrf | string | Yes | — | Cross-site request forgery protection |
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
sloId | string | Yes | — | An identifier for the slo. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"kbn-xsrf": {
"type": "string",
"description": "Cross-site request forgery protection"
},
"spaceId": {
"type": "string",
"description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used."
},
"sloId": {
"type": "string",
"description": "An identifier for the slo."
}
},
"required": [
"PCID",
"kbn-xsrf",
"spaceId",
"sloId"
]
}
kibana_observability_enable_slo_op
Enable an SLO Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
kbn-xsrf | string | Yes | — | Cross-site request forgery protection |
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
sloId | string | Yes | — | An identifier for the slo. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"kbn-xsrf": {
"type": "string",
"description": "Cross-site request forgery protection"
},
"spaceId": {
"type": "string",
"description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used."
},
"sloId": {
"type": "string",
"description": "An identifier for the slo."
}
},
"required": [
"PCID",
"kbn-xsrf",
"spaceId",
"sloId"
]
}
kibana_observability_find_slos_op
Get a paginated list of SLOs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
kbn-xsrf | string | Yes | — | Cross-site request forgery protection |
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
kqlQuery | string | No | — | A valid kql query to filter the SLO with |
size | integer | No | — | The page size to use for cursor-based pagination, must be greater or equal than 1 |
searchAfter | string[] | No | — | The cursor to use for fetching the results from, when using a cursor-base pagination. |
page | integer | No | — | The page to use for pagination, must be greater or equal than 1 |
perPage | integer | No | — | Number of SLOs returned by page |
sortBy | string | No | — | Sort by field |
sortDirection | string | No | — | Sort order |
hideStale | boolean | No | — | Hide stale SLOs from the list as defined by stale SLO threshold in SLO settings |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"kbn-xsrf": {
"type": "string",
"description": "Cross-site request forgery protection"
},
"spaceId": {
"type": "string",
"description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used."
},
"kqlQuery": {
"type": "string",
"description": "A valid kql query to filter the SLO with"
},
"size": {
"type": "integer",
"description": "The page size to use for cursor-based pagination, must be greater or equal than 1"
},
"searchAfter": {
"type": "array",
"items": {
"type": "string"
},
"description": "The cursor to use for fetching the results from, when using a cursor-base pagination."
},
"page": {
"type": "integer",
"description": "The page to use for pagination, must be greater or equal than 1"
},
"perPage": {
"type": "integer",
"description": "Number of SLOs returned by page"
},
"sortBy": {
"type": "string",
"description": "Sort by field",
"enum": [
"sli_value",
"status",
"error_budget_consumed",
"error_budget_remaining"
]
},
"sortDirection": {
"type": "string",
"description": "Sort order",
"enum": [
"asc",
"desc"
]
},
"hideStale": {
"type": "boolean",
"description": "Hide stale SLOs from the list as defined by stale SLO threshold in SLO settings"
}
},
"required": [
"PCID",
"kbn-xsrf",
"spaceId"
]
}
kibana_observability_get_parameter
Get a parameter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique identifier for the parameter. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The unique identifier for the parameter."
}
},
"required": [
"PCID",
"id"
]
}
kibana_observability_get_parameters
Get parametersShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
kibana_observability_get_private_location
Get a private location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | A private location identifier or label. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "A private location identifier or label."
}
},
"required": [
"PCID",
"id"
]
}
kibana_observability_get_private_locations
Get private locationsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
kibana_observability_get_slo_op
Get an SLO Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
kbn-xsrf | string | Yes | — | Cross-site request forgery protection |
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
sloId | string | Yes | — | An identifier for the slo. |
instanceId | string | No | — | the specific instanceId used by the summary calculation |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"kbn-xsrf": {
"type": "string",
"description": "Cross-site request forgery protection"
},
"spaceId": {
"type": "string",
"description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used."
},
"sloId": {
"type": "string",
"description": "An identifier for the slo."
},
"instanceId": {
"type": "string",
"description": "the specific instanceId used by the summary calculation"
}
},
"required": [
"PCID",
"kbn-xsrf",
"spaceId",
"sloId"
]
}
kibana_observability_get_synthetic_monitor
Get a monitor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the monitor. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the monitor."
}
},
"required": [
"PCID",
"id"
]
}
kibana_observability_get_synthetic_monitors
Get monitors Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | string | No | — | Additional filtering criteria. |
locations | object | No | — | The locations to filter by. |
monitorTypes | object | No | — | The monitor types to filter. |
page | integer | No | — | The page number for paginated results. |
per_page | integer | No | — | The number of items to return per page. |
projects | object | No | — | The projects to filter by. |
query | string | No | — | A free-text query string. |
schedules | object | No | — | The schedules to filter by. |
sortField | string | No | — | The field to sort the results by. |
sortOrder | string | No | — | The sort order. |
status | object | No | — | The status to filter by. |
tags | object | No | — | Tags to filter monitors. |
useLogicalAndFor | string[] | No | — | Specifies whether to apply logical AND filtering for specific fields. Accepts either a string with values “tags” or “locations” or an array containing both. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filter": {
"type": "string",
"description": "Additional filtering criteria."
},
"locations": {
"description": "The locations to filter by."
},
"monitorTypes": {
"description": "The monitor types to filter."
},
"page": {
"type": "integer",
"description": "The page number for paginated results."
},
"per_page": {
"type": "integer",
"description": "The number of items to return per page."
},
"projects": {
"description": "The projects to filter by."
},
"query": {
"type": "string",
"description": "A free-text query string."
},
"schedules": {
"description": "The schedules to filter by."
},
"sortField": {
"type": "string",
"description": "The field to sort the results by.",
"enum": [
"name",
"createdAt",
"updatedAt",
"status"
]
},
"sortOrder": {
"type": "string",
"description": "The sort order.",
"enum": [
"asc",
"desc"
]
},
"status": {
"description": "The status to filter by."
},
"tags": {
"description": "Tags to filter monitors."
},
"useLogicalAndFor": {
"type": "array",
"items": {
"type": "string",
"enum": [
"tags",
"locations"
]
},
"description": "Specifies whether to apply logical AND filtering for specific fields. Accepts either a string with values \"tags\" or \"locations\" or an array containing both."
}
},
"required": [
"PCID"
]
}
kibana_observability_post_parameters
Add parameters Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object[] | Yes | — | The request body can contain either a single parameter object or an array of parameter objects. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A description of the parameter."
},
"key": {
"type": "string",
"description": "The key of the parameter."
},
"share_across_spaces": {
"type": "boolean",
"description": "Specify whether the parameter should be shared across spaces."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tags to categorize the parameter."
},
"value": {
"type": "string",
"description": "The value associated with the parameter."
}
},
"required": [
"key",
"value"
]
},
"description": "The request body can contain either a single parameter object or an array of parameter objects."
}
},
"required": [
"PCID",
"body"
]
}
kibana_observability_post_private_location
Create a private location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agentPolicyId | string | Yes | — | The ID of the agent policy associated with the private location. |
geo | object | No | — | Geographic coordinates (WGS84) for the location. |
label | string | Yes | — | A label for the private location. |
spaces | string[] | No | — | An array of space IDs where the private location is available. If it is not provided, the private location is available in all spaces. |
tags | string[] | No | — | An array of tags to categorize the private location. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agentPolicyId": {
"type": "string",
"description": "The ID of the agent policy associated with the private location."
},
"geo": {
"type": "object",
"description": "Geographic coordinates (WGS84) for the location.",
"properties": {
"lat": {
"type": "number",
"description": "The latitude of the location."
},
"lon": {
"type": "number",
"description": "The longitude of the location."
}
},
"required": [
"lat",
"lon"
]
},
"label": {
"type": "string",
"description": "A label for the private location."
},
"spaces": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of space IDs where the private location is available. If it is not provided, the private location is available in all spaces."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tags to categorize the private location."
}
},
"required": [
"PCID",
"agentPolicyId",
"label"
]
}
kibana_observability_post_synthetic_monitors
Create a monitor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | The request body should contain the attributes of the monitor you want to create. The required and default fields differ depending on the monitor type. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"description": "The request body should contain the attributes of the monitor you want to create. The required and default fields differ depending on the monitor type."
}
},
"required": [
"PCID",
"body"
]
}
kibana_observability_post_synthetics_monitor_test
Trigger an on-demand test run for a monitor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
monitorId | string | Yes | — | The ID (config_id) of the monitor to test. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"monitorId": {
"type": "string",
"description": "The ID (config_id) of the monitor to test."
}
},
"required": [
"PCID",
"monitorId"
]
}
kibana_observability_put_parameter
Update a parameter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique identifier for the parameter. |
description | string | No | — | The updated description of the parameter. |
key | string | No | — | The key of the parameter. |
tags | string[] | No | — | An array of updated tags to categorize the parameter. |
value | string | No | — | The updated value associated with the parameter. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The unique identifier for the parameter."
},
"description": {
"type": "string",
"description": "The updated description of the parameter."
},
"key": {
"type": "string",
"description": "The key of the parameter."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of updated tags to categorize the parameter."
},
"value": {
"type": "string",
"description": "The updated value associated with the parameter."
}
},
"required": [
"PCID",
"id"
]
}
kibana_observability_put_private_location
Update a private location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique identifier of the private location to be updated. |
label | string | Yes | — | A new label for the private location. Must be at least 1 character long. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The unique identifier of the private location to be updated."
},
"label": {
"type": "string",
"description": "A new label for the private location. Must be at least 1 character long."
}
},
"required": [
"PCID",
"id",
"label"
]
}
kibana_observability_put_synthetic_monitor
Update a monitor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The identifier for the monitor that you want to update. |
body | object | Yes | — | The request body should contain the attributes of the monitor you want to update. The required and default fields differ depending on the monitor type. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The identifier for the monitor that you want to update."
},
"body": {
"type": "object",
"description": "The request body should contain the attributes of the monitor you want to update. The required and default fields differ depending on the monitor type."
}
},
"required": [
"PCID",
"id",
"body"
]
}
kibana_observability_reset_slo_op
Reset an SLO Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
kbn-xsrf | string | Yes | — | Cross-site request forgery protection |
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
sloId | string | Yes | — | An identifier for the slo. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"kbn-xsrf": {
"type": "string",
"description": "Cross-site request forgery protection"
},
"spaceId": {
"type": "string",
"description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used."
},
"sloId": {
"type": "string",
"description": "An identifier for the slo."
}
},
"required": [
"PCID",
"kbn-xsrf",
"spaceId",
"sloId"
]
}
kibana_observability_update_slo_op
Update an SLO Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
kbn-xsrf | string | Yes | — | Cross-site request forgery protection |
spaceId | string | Yes | — | An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. |
sloId | string | Yes | — | An identifier for the slo. |
artifacts | object | No | — | Links to related assets for the SLO |
budgetingMethod | string | No | — | The budgeting method to use when computing the rollup data. |
description | string | No | — | A description for the SLO. |
groupBy | string[] | No | — | optional group by field or fields to use to generate an SLO per distinct value |
indicator | object | No | — | The indicator value |
name | string | No | — | A name for the SLO. |
objective | object | No | — | Defines properties for the SLO objective |
settings | object | No | — | Defines properties for SLO settings. |
tags | string[] | No | — | List of tags |
timeWindow | object | No | — | Defines properties for the SLO time window |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"kbn-xsrf": {
"type": "string",
"description": "Cross-site request forgery protection"
},
"spaceId": {
"type": "string",
"description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used."
},
"sloId": {
"type": "string",
"description": "An identifier for the slo."
},
"artifacts": {
"type": "object",
"description": "Links to related assets for the SLO",
"properties": {
"dashboards": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of dashboard references"
}
}
},
"budgetingMethod": {
"type": "string",
"description": "The budgeting method to use when computing the rollup data.",
"enum": [
"occurrences",
"timeslices"
]
},
"description": {
"type": "string",
"description": "A description for the SLO."
},
"groupBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "optional group by field or fields to use to generate an SLO per distinct value"
},
"indicator": {
"description": "The indicator value"
},
"name": {
"type": "string",
"description": "A name for the SLO."
},
"objective": {
"type": "object",
"description": "Defines properties for the SLO objective",
"properties": {
"target": {
"type": "number",
"description": "the target objective between 0 and 1 excluded"
},
"timesliceTarget": {
"type": "number",
"description": "the target objective for each slice when using a timeslices budgeting method"
},
"timesliceWindow": {
"type": "string",
"description": "the duration of each slice when using a timeslices budgeting method, as {duraton}{unit}"
}
},
"required": [
"target"
]
},
"settings": {
"type": "object",
"description": "Defines properties for SLO settings.",
"properties": {
"frequency": {
"type": "string",
"description": "The interval between checks for changes in the source data. The minimum value is 1m and the maximum is 59m. The default value is 1 minute."
},
"preventInitialBackfill": {
"type": "boolean",
"description": "Start aggregating data from the time the SLO is created, instead of backfilling data from the beginning of the time window."
},
"syncDelay": {
"type": "string",
"description": "The time delay in minutes between the current time and the latest source data time. Increasing the value will delay any alerting. The default value is 1 minute. The minimum value is 1m and the maximum is 359m. It should always be greater then source index refresh interval."
},
"syncField": {
"type": "string",
"description": "The date field that is used to identify new documents in the source. It is strongly recommended to use a field that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it accounts for data transmission delays. When unspecified, we use the indicator timestamp field."
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags"
},
"timeWindow": {
"type": "object",
"description": "Defines properties for the SLO time window",
"properties": {
"duration": {
"type": "string",
"description": "the duration formatted as {duration}{unit}. Accepted values for rolling: 7d, 30d, 90d. Accepted values for calendar aligned: 1w (weekly) or 1M (monthly)"
},
"type": {
"type": "string",
"description": "Indicates weither the time window is a rolling or a calendar aligned time window.",
"enum": [
"rolling",
"calendarAligned"
]
}
},
"required": [
"duration",
"type"
]
}
},
"required": [
"PCID",
"kbn-xsrf",
"spaceId",
"sloId"
]
}

