GET Target

GET 
/workspaces/:workspaceId/alerting/targets/:targetName

GET Target

Request

Path Parameters

workspaceId uuidrequired
targetName stringrequired

Responses

200

Target details

application/json

Schema

Schema

name stringrequired
type stringrequired

Possible values: [Slack, AzureServiceBus, EmailGroup]

Allowed values: Slack, AzureServiceBus, EmailGroup

properties

object

required

uri urinullable

Applicable to 'Slack' target.

connectionString stringnullable

Applicable to 'ServiceBus' target.

entityPath stringnullable

Applicable to 'ServiceBus' target.

emails string[]nullable

Applicable to 'EmailGroup' target.

Example (from schema)

{
  "name": "string",
  "type": "Slack",
  "properties": {
    "uri": "string",
    "connectionString": "string",
    "entityPath": "string",
    "emails": [
      "string"
    ]
  }
}

example-1

{
  "name": "my-slack-target",
  "type": "Slack",
  "properties": {
    "uri": "https://example.com"
  }
}

example-2

{
  "name": "my-service-bus-target",
  "type": "AzureServiceBus",
  "properties": {
    "connectionString": "my-connection-string",
    "entityPath": "my-entity-path"
  }
}

404

A target was not found.

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...