curl --request POST \
--url 'https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"schema_name": "CMDB Lookup",
"description": "Enrich alerts with CMDB data",
"source_labels": [
"host"
],
"result_labels": [
"owner",
"team",
"service"
]
}
'import requests
url = "https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key="
payload = {
"schema_name": "CMDB Lookup",
"description": "Enrich alerts with CMDB data",
"source_labels": ["host"],
"result_labels": ["owner", "team", "service"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
schema_name: 'CMDB Lookup',
description: 'Enrich alerts with CMDB data',
source_labels: ['host'],
result_labels: ['owner', 'team', 'service']
})
};
fetch('https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'schema_name' => 'CMDB Lookup',
'description' => 'Enrich alerts with CMDB data',
'source_labels' => [
'host'
],
'result_labels' => [
'owner',
'team',
'service'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key="
payload := strings.NewReader("{\n \"schema_name\": \"CMDB Lookup\",\n \"description\": \"Enrich alerts with CMDB data\",\n \"source_labels\": [\n \"host\"\n ],\n \"result_labels\": [\n \"owner\",\n \"team\",\n \"service\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"schema_name\": \"CMDB Lookup\",\n \"description\": \"Enrich alerts with CMDB data\",\n \"source_labels\": [\n \"host\"\n ],\n \"result_labels\": [\n \"owner\",\n \"team\",\n \"service\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"schema_name\": \"CMDB Lookup\",\n \"description\": \"Enrich alerts with CMDB data\",\n \"source_labels\": [\n \"host\"\n ],\n \"result_labels\": [\n \"owner\",\n \"team\",\n \"service\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"schema_id": "665f1a2b3c4d5e6f7a8b9c01",
"schema_name": "CMDB Lookup"
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Create mapping schema
Create a new mapping schema defining source lookup labels and the result labels to populate. Requires a Pro plan.
curl --request POST \
--url 'https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"schema_name": "CMDB Lookup",
"description": "Enrich alerts with CMDB data",
"source_labels": [
"host"
],
"result_labels": [
"owner",
"team",
"service"
]
}
'import requests
url = "https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key="
payload = {
"schema_name": "CMDB Lookup",
"description": "Enrich alerts with CMDB data",
"source_labels": ["host"],
"result_labels": ["owner", "team", "service"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
schema_name: 'CMDB Lookup',
description: 'Enrich alerts with CMDB data',
source_labels: ['host'],
result_labels: ['owner', 'team', 'service']
})
};
fetch('https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'schema_name' => 'CMDB Lookup',
'description' => 'Enrich alerts with CMDB data',
'source_labels' => [
'host'
],
'result_labels' => [
'owner',
'team',
'service'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key="
payload := strings.NewReader("{\n \"schema_name\": \"CMDB Lookup\",\n \"description\": \"Enrich alerts with CMDB data\",\n \"source_labels\": [\n \"host\"\n ],\n \"result_labels\": [\n \"owner\",\n \"team\",\n \"service\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"schema_name\": \"CMDB Lookup\",\n \"description\": \"Enrich alerts with CMDB data\",\n \"source_labels\": [\n \"host\"\n ],\n \"result_labels\": [\n \"owner\",\n \"team\",\n \"service\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/enrichment/mapping/schema/create?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"schema_name\": \"CMDB Lookup\",\n \"description\": \"Enrich alerts with CMDB data\",\n \"source_labels\": [\n \"host\"\n ],\n \"result_labels\": [\n \"owner\",\n \"team\",\n \"service\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"schema_id": "665f1a2b3c4d5e6f7a8b9c01",
"schema_name": "CMDB Lookup"
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Restrictions
| Aspect | Value |
|---|---|
| Rate limits | 1,000 requests/minute; 50 requests/second per account |
| Permissions | Mappings Manage (on-call) |
Usage
- Schema names must be unique within an account.
source_labels(1–3 labels) are used as lookup keys;result_labels(1–10 labels) are the labels written on match.- Label names must match
^[a-z][a-z0-9_]{0,39}$(lowercase). source_labelsandresult_labelsmust not overlap.- An account can have at most 20 mapping schemas.
- Every call is recorded in the account audit log. Don’t put secrets in request fields.
Authorizations
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
Unique schema name (max 39 chars).
39Lookup key label names (1–3). Must not overlap with result_labels.
3Output label names (1–10). Must not overlap with source_labels.
10Optional description (max 500 chars).
500Owning team ID. 0 means no team.
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.
Was this page helpful?