Show workflow rule

curl --request GET \
  --url http://localhost:8080/api/v1/workflow-rules/{workflowRule} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:8080/api/v1/workflow-rules/{workflowRule}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/api/v1/workflow-rules/{workflowRule}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/api/v1/workflow-rules/{workflowRule}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/workflow-rules/{workflowRule}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "provider_slug": "<string>",
    "ping_target_id": "<string>",
    "target_label": "<string>",
    "target_host": "<string>",
    "event": "<string>",
    "event_label": "Speedtest run completes",
    "condition_operator": "<string>",
    "is_active": true,
    "cooldown_minutes": 123,
    "last_triggered_at": "<string>",
    "conditions": [
      {
        "id": "<string>",
        "metric": "<string>",
        "operator": "<string>",
        "value": "<string>",
        "lookback_minutes": 123,
        "sort_order": 123
      }
    ],
    "actions": [
      {
        "id": "<string>",
        "type": "<string>",
        "mail_provider_id": "<string>",
        "email_template_id": "<string>",
        "recipient_email": "<string>",
        "webhook_id": "<string>",
        "apprise_id": "<string>",
        "sort_order": 123
      }
    ],
    "created_at": "<string>"
  },
  "success": true,
  "code": 200
}

{
  "success": false,
  "code": 401,
  "message": "<string>"
}

{
  "success": false,
  "code": 404,
  "message": "<string>"
}

{
  "success": false,
  "code": 405,
  "message": "<string>"
}

{
  "success": false,
  "code": 422,
  "message": "<string>",
  "errors": "<string>"
}

{
  "success": false,
  "code": 429,
  "message": "<string>"
}

{
  "success": false,
  "code": 500,
  "message": "<string>"
}

GET

workflow-rules

{workflowRule}

Show workflow rule

curl --request GET \
  --url http://localhost:8080/api/v1/workflow-rules/{workflowRule} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:8080/api/v1/workflow-rules/{workflowRule}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/api/v1/workflow-rules/{workflowRule}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/api/v1/workflow-rules/{workflowRule}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/workflow-rules/{workflowRule}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "provider_slug": "<string>",
    "ping_target_id": "<string>",
    "target_label": "<string>",
    "target_host": "<string>",
    "event": "<string>",
    "event_label": "Speedtest run completes",
    "condition_operator": "<string>",
    "is_active": true,
    "cooldown_minutes": 123,
    "last_triggered_at": "<string>",
    "conditions": [
      {
        "id": "<string>",
        "metric": "<string>",
        "operator": "<string>",
        "value": "<string>",
        "lookback_minutes": 123,
        "sort_order": 123
      }
    ],
    "actions": [
      {
        "id": "<string>",
        "type": "<string>",
        "mail_provider_id": "<string>",
        "email_template_id": "<string>",
        "recipient_email": "<string>",
        "webhook_id": "<string>",
        "apprise_id": "<string>",
        "sort_order": 123
      }
    ],
    "created_at": "<string>"
  },
  "success": true,
  "code": 200
}

{
  "success": false,
  "code": 401,
  "message": "<string>"
}

{
  "success": false,
  "code": 404,
  "message": "<string>"
}

{
  "success": false,
  "code": 405,
  "message": "<string>"
}

{
  "success": false,
  "code": 422,
  "message": "<string>",
  "errors": "<string>"
}

{
  "success": false,
  "code": 429,
  "message": "<string>"
}

{
  "success": false,
  "code": 500,
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workflowRule

string<uuid>

required

The workflow rule ID

Response

WorkflowRuleResource

data

WorkflowRuleResource · object

required

Hide child attributes

data.id

string

required

data.name

string

required

data.provider_slug

string | null

required

data.ping_target_id

string | null

required

data.target_label

string | null

required

data.target_host

string | null

required

data.event

string

required

data.event_label

enum<string>

required

Available options:

Speedtest run completes,

Speedtest run fails,

Speedtest run is skipped,

Any speedtest event,

Ping result recorded

data.condition_operator

string

required

data.is_active

boolean

required

data.cooldown_minutes

integer

required

data.last_triggered_at

string | null

required

data.conditions

object[]

required

Hide child attributes

data.conditions.id

string

required

data.conditions.metric

string

required

data.conditions.operator

string

required

data.conditions.value

string

required

data.conditions.lookback_minutes

integer | null

required

data.conditions.sort_order

integer

required

data.actions

object[]

required

Hide child attributes

data.actions.id

string

required

data.actions.type

string

required

data.actions.mail_provider_id

string | null

required

data.actions.email_template_id

string | null

required

data.actions.recipient_email

string | null

required

data.actions.webhook_id

string | null

required

data.actions.apprise_id

string | null

required

data.actions.sort_order

integer

required

data.created_at

string

required

success

boolean

required

code

integer

required

Getting Started

Configuration

Integrations

API Reference

More

Show workflow rule

Authorizations

Path Parameters

Response