v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Routing rules

List routing rules

Lists all routing rules of given team. It optionally takes two parameters - offset and size.

get/api/{cloudId}/v1/teams/{teamId}/routing-rules

Path parameters

teamIdstring required

Identifier of the routing rules owning team.

Query parameters

offsetinteger

The offset parameter controls the starting point within the collection of resource results.

sizeinteger

The limit parameter controls the maximum number of items that may be returned for a single request.

Response

Returned if the request is successful.

Example response

{
  "values": [
    {
      "id": "4292c912-12ac-4ac0-b195-9484fbb98c5c",
      "name": "My Primary Routing Rule",
      "isDefault": "true",
      "criteria": {
        "type": "match-any-condition",
        "conditions": [
          {
            "field": "message",
            "operation": "matches",
            "expectedValue": "my critical alert"
          }
        ]
      },
      "timezone": "Europe/Istanbul",
      "timeRestriction": {
        "type": "weekday-and-time-of-day",
        "restrictions": [
          {
            "startDay": "monday",
            "endDay": "friday",
            "startHour": 13,
            "endHour": 18,
            "startMin": 0,
            "endMin": 0
          }
        ]
      },
      "order": 0,
      "notify": {
        "id": "d2acfc54-a145-451e-a963-ffbc089baea1",
        "type": "escalation"
      }
    }
  ],
  "links": {
    "next": "/v1/teams/77b933c9-92bb-46e7-a73c-764b8d7c3c25/routing-rules?offset=10&size=5"
  }
}