Skip to main content
POST
/
enrichment
/
info
Get enrichment rules
curl --request POST \
  --url 'https://api.flashcat.cloud/enrichment/info?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": 5001
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "integration_id": 5001,
    "rules": [
      {
        "kind": "extraction",
        "settings": {
          "source_field": "labels.env",
          "result_label": "environment",
          "pattern": "^(prod|staging|dev).*$",
          "override": true
        }
      }
    ],
    "status": "enabled",
    "updated_by": 80011,
    "creator_id": 80011,
    "created_at": 1710000000,
    "updated_at": 1710000000
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flashcat.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Restrictions

AspectValue
Rate limits1,000 requests/minute; 50 requests/second per account
PermissionsChannels Read (on-call) or Channels Manage (on-call) or Integrations Read (on-call) or Integrations Manage (on-call)

Usage

  • Returns null if no enrichment rules have been configured for the integration.

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json
integration_id
integer<int64>
required

Integration ID to query enrichment rules for. Must be greater than 0.

Required range: x >= 1

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
required

Enrichment rule set for an integration.