Skip to main content
POST
Delete mapping API

Restrictions

Usage

  • The mapping API is soft-deleted (status becomes deleted) and enrichment rules stop calling it.
  • If an integration’s enrichment rule uses it (mapping_type = api), the call returns HTTP 400 ReferenceExist with data.refs listing up to 20 integrations (kind = integration).
  • An unknown api_id returns InvalidParameter.
  • 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).

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.