Skip to main content
POST
Update mapping API

Restrictions

Usage

  • Fields left out keep their current values. headers, when sent, replaces the whole header map; send {} to remove all headers. team_id 0 removes the team.
  • The fields you send are validated as on create (url scheme and internal-address check, header rules, timeout 1–3, retry_count 0–1); description is cut to 500 characters.
  • An unknown api_id returns InvalidParameter; a new api_name must not be used by another mapping API.
  • Only an account admin, the mapping API creator, or a member of the mapping API’s owning team may call this; others get AccessDenied.
  • Every call is recorded in the account audit log. Don’t put secrets in request fields.

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
api_id
string
required

Mapping API ID (MongoDB ObjectID hex).

api_name
string | null

New name, unique among non-deleted mapping APIs (max 199 characters). Omit to keep.

Maximum string length: 199
description
string | null

New description; longer than 500 characters is truncated. Omit to keep, send "" to clear.

url
string<uri> | null

New http/https endpoint (max 500 characters); in SaaS the host must not resolve to an internal IP. Omit to keep.

Maximum string length: 500
insecure_skip_verify
boolean | null

New TLS skip-verify setting. Omit to keep.

headers
object

Replaces the whole header map when sent; send {} to remove all headers. Omit to keep. In SaaS, sensitive header names (see /enrichment/mapping/api/create) are rejected; keys are at most 1,024 characters and values at most 4,096.

timeout
integer | null

New whole-request timeout in seconds (1–3). Omit to keep.

Required range: 1 <= x <= 3
retry_count
integer | null

New retry count (0–1). Omit to keep.

Required range: 0 <= x <= 1
team_id
integer<int64> | null

New owning team ID from POST /team/list; 0 removes the team. Omit to keep.

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

No payload. Depending on the operation, data is {} or omitted from the envelope; rely only on the HTTP 200 status and the absence of error.