Delete mapping API

Delete a mapping API. Deletion is blocked if the API is referenced by any enrichment rule.

POST /enrichment/mapping/api/delete

Delete mapping API

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/enrichment/mapping/api/delete?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_id": "665f1a2b3c4d5e6f7a8b9c02"
}
'

import requests

url = "https://api.flashcat.cloud/enrichment/mapping/api/delete?app_key="

payload = { "api_id": "665f1a2b3c4d5e6f7a8b9c02" }
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({api_id: '665f1a2b3c4d5e6f7a8b9c02'})
};

fetch('https://api.flashcat.cloud/enrichment/mapping/api/delete?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/api/delete?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([
    'api_id' => '665f1a2b3c4d5e6f7a8b9c02'
  ]),
  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/api/delete?app_key="

	payload := strings.NewReader("{\n  \"api_id\": \"665f1a2b3c4d5e6f7a8b9c02\"\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/api/delete?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"api_id\": \"665f1a2b3c4d5e6f7a8b9c02\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/enrichment/mapping/api/delete?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  \"api_id\": \"665f1a2b3c4d5e6f7a8b9c02\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {}
}

{
  "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

• If the API is still referenced, the response returns HTTP 400 with a refs list.
• Only the API creator, account admin, or team member can delete the API.
• 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_id · string · required

Mapping API ID (MongoDB ObjectID hex).

Response

200

application/json

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

Empty response body. The server returns data: null on success.