CREATE OR UPDATE Rule

PATCH 
/workspaces/:workspaceId/alerting/rules/:ruleName

CREATE OR UPDATE Rule

Request

Path Parameters

workspaceId uuidrequired
ruleName stringrequired

Header Parameters

If-None-Match string

To ensure that no existing rule is updated pass If-None-Match header set to "*".

application/json

Body

deviceId stringnullable

Applicable when rule is created.

streamName stringnullable

Required when rule is created.

streamGroupName stringnullable

Required when rule is created.

inactivityTimeout [d.]hh:mm:ss[.fffffff]nullable

Applicable when rule is updated. Minimum timeout is 1 minute, maximum is not limited.

targets string[]nullable

Applicable when rule is updated.

Responses

200

Rule has been updated.

201

Rule has been created.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

400

Rule cannot be created because not all required values were provided, some of them are invalid, or because a rule with the same name already exists.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

503

Rule cannot be created or updated because conflicting operation is in progress.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...