Upsert incident image

Developing

POST

/incident/image/put

Uses src as the unique key: if the incident already contains an image with the same src, its href / alt are updated in place; otherwise a new entry is appended.

Constraints:

Each incident may hold at most 5 images; exceeding this limit returns 400.

src must start with img_ or http, with a trimmed length not exceeding 512 characters.

alt is capped at 128 characters and href at 512 characters (any excess is silently truncated).

When the incident is in the closed state, the data is still written but no card refresh is triggered.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Using a Flashcat internal image-host keyUsing an external URL

{
    "incident_id": "65f0b4d5e12a4a0012345678",
    "image": {
        "src": "img_abc123",
        "href": "https://grafana.example.com/d/cpu",
        "alt": "CPU usage"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Using a Flashcat internal image-host keyUsing an external URL

curl --location --request POST 'http://prod-cn.your-api-server.com/incident/image/put' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "incident_id": "65f0b4d5e12a4a0012345678",
    "image": {
        "src": "img_abc123",
        "href": "https://grafana.example.com/d/cpu",
        "alt": "CPU usage"
    }
}'

Responses

🟢200

application/json

Success

Body

Example

{
    "err": 0,
    "dat": {},
    "msg": ""
}

🟠400

🔴500

Modified at 2026-04-28 05:23:46

Channel

Delete incident image