Skip to main content
POST
Get escalation rule detail

Restrictions

Usage

  • A deleted rule is still returned, with status deleted.
  • An unknown channel_id or rule_id returns InvalidParameter.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json
channel_id
integer<int64>
required

Owning channel ID; obtain it from POST /channel/list.

rule_id
string
required

Rule ID (24-character hex), as returned in rule_id by the create or list endpoint of the same rule type.

Pattern: ^[0-9a-fA-F]{24}$

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Operation-specific payload, documented in each operation's 200 response. Operations without a payload return {} or omit data entirely.