curl --request POST \
--url 'https://api.flashcat.cloud/field/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"field_name": "severity_class",
"display_name": "Severity Class",
"description": "Business severity tier.",
"field_type": "single_select",
"value_type": "string",
"options": [
"Critical",
"High",
"Medium",
"Low"
],
"default_value": "Medium"
}
'import requests
url = "https://api.flashcat.cloud/field/create?app_key="
payload = {
"field_name": "severity_class",
"display_name": "Severity Class",
"description": "Business severity tier.",
"field_type": "single_select",
"value_type": "string",
"options": ["Critical", "High", "Medium", "Low"],
"default_value": "Medium"
}
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({
field_name: 'severity_class',
display_name: 'Severity Class',
description: 'Business severity tier.',
field_type: 'single_select',
value_type: 'string',
options: ['Critical', 'High', 'Medium', 'Low'],
default_value: 'Medium'
})
};
fetch('https://api.flashcat.cloud/field/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/field/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([
'field_name' => 'severity_class',
'display_name' => 'Severity Class',
'description' => 'Business severity tier.',
'field_type' => 'single_select',
'value_type' => 'string',
'options' => [
'Critical',
'High',
'Medium',
'Low'
],
'default_value' => 'Medium'
]),
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/field/create?app_key="
payload := strings.NewReader("{\n \"field_name\": \"severity_class\",\n \"display_name\": \"Severity Class\",\n \"description\": \"Business severity tier.\",\n \"field_type\": \"single_select\",\n \"value_type\": \"string\",\n \"options\": [\n \"Critical\",\n \"High\",\n \"Medium\",\n \"Low\"\n ],\n \"default_value\": \"Medium\"\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/field/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"field_name\": \"severity_class\",\n \"display_name\": \"Severity Class\",\n \"description\": \"Business severity tier.\",\n \"field_type\": \"single_select\",\n \"value_type\": \"string\",\n \"options\": [\n \"Critical\",\n \"High\",\n \"Medium\",\n \"Low\"\n ],\n \"default_value\": \"Medium\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/field/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 \"field_name\": \"severity_class\",\n \"display_name\": \"Severity Class\",\n \"description\": \"Business severity tier.\",\n \"field_type\": \"single_select\",\n \"value_type\": \"string\",\n \"options\": [\n \"Critical\",\n \"High\",\n \"Medium\",\n \"Low\"\n ],\n \"default_value\": \"Medium\"\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"field_id": "66e9d3a4f7c2b04a1c8a91b3",
"field_name": "severity_class"
}
}{
"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 field
Create a new incident custom field on the account.
curl --request POST \
--url 'https://api.flashcat.cloud/field/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"field_name": "severity_class",
"display_name": "Severity Class",
"description": "Business severity tier.",
"field_type": "single_select",
"value_type": "string",
"options": [
"Critical",
"High",
"Medium",
"Low"
],
"default_value": "Medium"
}
'import requests
url = "https://api.flashcat.cloud/field/create?app_key="
payload = {
"field_name": "severity_class",
"display_name": "Severity Class",
"description": "Business severity tier.",
"field_type": "single_select",
"value_type": "string",
"options": ["Critical", "High", "Medium", "Low"],
"default_value": "Medium"
}
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({
field_name: 'severity_class',
display_name: 'Severity Class',
description: 'Business severity tier.',
field_type: 'single_select',
value_type: 'string',
options: ['Critical', 'High', 'Medium', 'Low'],
default_value: 'Medium'
})
};
fetch('https://api.flashcat.cloud/field/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/field/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([
'field_name' => 'severity_class',
'display_name' => 'Severity Class',
'description' => 'Business severity tier.',
'field_type' => 'single_select',
'value_type' => 'string',
'options' => [
'Critical',
'High',
'Medium',
'Low'
],
'default_value' => 'Medium'
]),
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/field/create?app_key="
payload := strings.NewReader("{\n \"field_name\": \"severity_class\",\n \"display_name\": \"Severity Class\",\n \"description\": \"Business severity tier.\",\n \"field_type\": \"single_select\",\n \"value_type\": \"string\",\n \"options\": [\n \"Critical\",\n \"High\",\n \"Medium\",\n \"Low\"\n ],\n \"default_value\": \"Medium\"\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/field/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"field_name\": \"severity_class\",\n \"display_name\": \"Severity Class\",\n \"description\": \"Business severity tier.\",\n \"field_type\": \"single_select\",\n \"value_type\": \"string\",\n \"options\": [\n \"Critical\",\n \"High\",\n \"Medium\",\n \"Low\"\n ],\n \"default_value\": \"Medium\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/field/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 \"field_name\": \"severity_class\",\n \"display_name\": \"Severity Class\",\n \"description\": \"Business severity tier.\",\n \"field_type\": \"single_select\",\n \"value_type\": \"string\",\n \"options\": [\n \"Critical\",\n \"High\",\n \"Medium\",\n \"Low\"\n ],\n \"default_value\": \"Medium\"\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"field_id": "66e9d3a4f7c2b04a1c8a91b3",
"field_name": "severity_class"
}
}{
"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 | Incidents Manage (on-call) |
Usage
- Maximum 15 custom fields per account.
field_namemust match^[a-zA-Z_][a-zA-Z0-9_]{0,39}$and is immutable after creation;display_namemust also be unique within the account.- Type-specific rules:
checkboxrequiresvalue_type=booland nooptions;single_select/multi_selectrequirevalue_type=stringand a non-empty uniqueoptionslist;textrequiresvalue_type=stringand nooptions. - Response contains only
field_idandfield_name; use/field/infoto fetch the full object. - Audited — changes are recorded in the audit log.
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
Machine name. Must start with a letter or underscore; 1–40 chars of [a-zA-Z0-9_]. Immutable after creation.
39^[a-zA-Z_][a-zA-Z0-9_]{0,39}$Human-readable name. Must be unique within the account.
39Field input type. Immutable after creation.
checkbox, multi_select, single_select, text Stored value type. checkbox requires bool; single_select/multi_select/text require string. Immutable after creation.
string, bool, float Optional free-text description.
499Required and non-empty for single_select/multi_select (unique strings, each 1–200 chars). Must be omitted or empty for checkbox/text.
Optional default value. Type must match field_type: bool for checkbox; one of options for single_select; subset of options for multi_select; string ≤3000 chars for text.
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?