Global Event Rules/Rulesets/Rules

List Ruleset Rules

get

https://api.squadcast.comhttps://api.eu.squadcast.com

/v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules

Get all rules of a GER Ruleset.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ger_idintegerRequired

alert_source_versionstringRequired

alert_source_shortnamestringRequired

Query parameters

page_sizeintegerOptional

page_numberintegerOptional

filters.searchstringOptional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get/v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules

HTTPcURLJavaScriptPython

GET /v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": 1,
      "global_event_rule_id": 1,
      "description": "text",
      "expression": "text",
      "action": {
        "route_to": "text"
      },
      "created_at": "2026-08-08T13:57:15.099Z",
      "created_by": "text",
      "updated_at": "2026-08-08T13:57:15.099Z",
      "updated_by": "text"
    }
  ],
  "meta": {
    "total_count": 1
  }
}

Create Rule

post

https://api.squadcast.comhttps://api.eu.squadcast.com

/v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules

Create a GER Ruleset Rule.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ger_idintegerRequired

alert_source_versionstringRequired

alert_source_shortnamestringRequired

Body

application/json

descriptionstringRequired

expressionstringRequired

Responses

201

The request has succeeded and a new resource has been created as a result.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

post/v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules

HTTPcURLJavaScriptPython

POST /v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "description": "text",
  "expression": "text",
  "action": {
    "route_to": "text"
  }
}

{
  "data": {
    "id": 1,
    "global_event_rule_id": 1,
    "description": "text",
    "expression": "text",
    "action": {
      "route_to": "text"
    },
    "created_at": "2026-08-08T13:57:15.099Z",
    "created_by": "text",
    "updated_at": "2026-08-08T13:57:15.099Z",
    "updated_by": "text"
  }
}

Get Rule by ID

get

https://api.squadcast.comhttps://api.eu.squadcast.com

/v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules/{rule_id}

Get a GER Ruleset Rule by its ID.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ger_idintegerRequired

alert_source_versionstringRequired

alert_source_shortnamestringRequired

rule_idstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get/v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules/{rule_id}

HTTPcURLJavaScriptPython

GET /v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules/{rule_id} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": 1,
    "global_event_rule_id": 1,
    "description": "text",
    "expression": "text",
    "action": {
      "route_to": "text"
    },
    "created_at": "2026-08-08T13:57:15.099Z",
    "created_by": "text",
    "updated_at": "2026-08-08T13:57:15.099Z",
    "updated_by": "text"
  }
}

Delete Rule by ID

delete

https://api.squadcast.comhttps://api.eu.squadcast.com

/v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules/{rule_id}

Delete a GER Ruleset Rule by its ID.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ger_idintegerRequired

alert_source_versionstringRequired

alert_source_shortnamestringRequired

rule_idstringRequired

Responses

204

There is no content to send for this request, but the headers may be useful.

*/*

objectOptional

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

delete/v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules/{rule_id}

HTTPcURLJavaScriptPython

DELETE /v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules/{rule_id} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Update Rule by ID

patch

https://api.squadcast.comhttps://api.eu.squadcast.com

/v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules/{rule_id}

Update a GER Ruleset Rule by its ID.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ger_idintegerRequired

alert_source_versionstringRequired

alert_source_shortnamestringRequired

rule_idstringRequired

Body

application/json

descriptionstringOptional

expressionstringOptional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

patch/v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules/{rule_id}

HTTPcURLJavaScriptPython

PATCH /v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules/{rule_id} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "description": "text",
  "expression": "text",
  "action": {
    "route_to": "text"
  }
}

{
  "data": {
    "id": 1,
    "global_event_rule_id": 1,
    "description": "text",
    "expression": "text",
    "action": {
      "route_to": "text"
    },
    "created_at": "2026-08-08T13:57:15.099Z",
    "created_by": "text",
    "updated_at": "2026-08-08T13:57:15.099Z",
    "updated_by": "text"
  }
}

Reorder Ruleset By Index

patch

https://api.squadcast.comhttps://api.eu.squadcast.com

/v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules/{rule_id}/priority

Reorder a GER Ruleset Rule by its index in the ruleset.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ger_idintegerRequired

alert_source_versionstringRequired

alert_source_shortnamestringRequired

rule_idstringRequired

Body

application/json

shift_tostringOptional

shift_index_byintegerOptional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

patch/v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules/{rule_id}/priority

HTTPcURLJavaScriptPython

PATCH /v3/global-event-rules/{ger_id}/rulesets/{alert_source_version}/{alert_source_shortname}/rules/{rule_id}/priority HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "shift_to": "text",
  "shift_index_by": 1
}

{
  "data": {
    "ordering": [
      1
    ]
  }
}