Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Create Silence

POST
/observability/v1/workspaces/{workspace}/silences
 
curl --request POST \
  --url https://example.com/observability/v1/workspaces/example/silences \
  --header 'Content-Type: application/json' \
  --data '{ "matchers": [ { "label": "example", "value": "example", "is_regex": true } ], "starts_at": "2026-04-15T12:00:00Z", "ends_at": "2026-04-15T12:00:00Z", "comment": "example" }'

Creates a workspace-scoped silence that suppresses matching alerts for its window.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace
required
string

The workspace to create the silence in.

Request Body required

Section titled “Request Body required ”
Media type application/json

A silence is a workspace-scoped suppression window: while active, firing alerts whose labels satisfy the matchers are muted. It carries no engine axis. A silence is created and deleted, never edited.

object
id

The unique identifier of the silence.

stringOutput only
workspace_id

The workspace this silence belongs to. Derived from the {workspace} path segment on create; reported read-only thereafter.

stringOutput only
matchers
required

The label matchers selecting which firing alerts this silence suppresses (at least one).

Array<object>

A single label matcher used to select firing alerts for suppression.

object
label
required

The alert label name to match against.

string
value
required

The value to compare the label against (exact, or a regex when is_regex is true).

string
is_regex

Whether value is a regular expression rather than an exact match.

boolean
starts_at
required

Start of the suppression window (inclusive).

string format: date-time
ends_at
required

End of the suppression window (exclusive); must be after starts_at.

string format: date-time
created_by

Identifier of the principal who created the silence. Server-stamped from the authenticated caller; read-only (never accepted from the request body, to prevent attribution spoofing).

stringOutput only
comment
required

Free-text reason for the silence.

string
created

Timestamp when the silence was created.

string format: date-time Output only
updated

Timestamp when the silence was last modified.

string format: date-time Output only
Example generated
{
  "matchers": [
    {
      "label": "example",
      "value": "example",
      "is_regex": true
    }
  ],
  "starts_at": "2026-04-15T12:00:00Z",
  "ends_at": "2026-04-15T12:00:00Z",
  "comment": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

ObservabilityOperation

Tracks the synchronous result of an observability config-plane command (retention, sink, or ingestion mutation). Engine-neutral — operations carry no engine axis.

object
id

The unique operation identifier.

stringOutput only
resource_id

The id of the affected resource.

stringOutput only
resource_type

The type of resource the operation acted upon (URN).

stringOutput only
operation_type

The operation type (CREATE, UPDATE, DELETE).

string format: enum Output only
Allowed values: OBSERVABILITY_OPERATION_TYPE_UNSPECIFIED OBSERVABILITY_OPERATION_TYPE_CREATE OBSERVABILITY_OPERATION_TYPE_UPDATE OBSERVABILITY_OPERATION_TYPE_DELETE
status

The operation status (DONE for synchronous config mutations).

string format: enum Output only
Allowed values: OBSERVABILITY_OPERATION_STATUS_UNSPECIFIED OBSERVABILITY_OPERATION_STATUS_PENDING OBSERVABILITY_OPERATION_STATUS_RUNNING OBSERVABILITY_OPERATION_STATUS_DONE OBSERVABILITY_OPERATION_STATUS_ERROR
insert_time

When the operation was recorded.

string format: date-time Output only
start_time

When execution started.

string format: date-time Output only
end_time

When execution completed.

string format: date-time Output only
progress

Progress percentage (0–100).

integer format: int32 Output only
Example 
{
  "operation_type": "OBSERVABILITY_OPERATION_TYPE_UNSPECIFIED",
  "status": "OBSERVABILITY_OPERATION_STATUS_UNSPECIFIED"
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}