Skip to main content
POST
/
enrichment
/
mapping
/
api
/
create
Create mapping API
curl --request POST \
  --url 'https://api.flashcat.cloud/enrichment/mapping/api/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_name": "CMDB API",
  "description": "Query CMDB for host metadata",
  "url": "https://cmdb.example.com/api/lookup",
  "headers": {
    "X-Token": "mytoken"
  },
  "timeout": 2,
  "retry_count": 1,
  "insecure_skip_verify": false
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "api_id": "665f1a2b3c4d5e6f7a8b9c02",
    "api_name": "CMDB API"
  }
}

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
PermissionsMappings Manage (on-call)

​
Usage

  • url must start with http:// or https:// and cannot resolve to an internal IP (in SaaS mode).
  • timeout is the HTTP read timeout in seconds (1–3, default 2).
  • retry_count is the number of retries on failure (0–1, default 0).
  • Headers with security-sensitive names (e.g. authorization, cookie) are rejected in SaaS mode.
  • An account can have at most 50 mapping APIs.
  • Every call is recorded in the account audit log. Don’t put secrets in request fields.

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
​
api_name
string
required

Unique API name (max 199 chars).

Maximum string length: 199
​
url
string<uri>
required

HTTP/HTTPS endpoint URL (max 500 chars).

Maximum string length: 500
​
description
string

Optional description.

​
insecure_skip_verify
boolean

Skip TLS certificate verification. Default false.

​
headers
object

Custom HTTP request headers.

​
timeout
integer

Request timeout in seconds (1–3). Default 2.

​
retry_count
integer

Number of retries on failure (0–1). Default 0.

​
team_id
integer<int64>

Owning team ID.

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

Endpoint-specific payload. See each operation's 200 response schema.