创建自定义字段
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."
}
}标签增强
创建自定义字段
为账号新建一个故障自定义字段。
POST
/
field
/
create
创建自定义字段
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."
}
}调用限制
| 项 | 值 |
|---|---|
| 速率限制 | 每账户 1,000 次/分钟;50 次/秒 |
| 权限 | 故障可管理 (on-call) |
使用说明
- 每个账号最多 15 个自定义字段。
field_name必须匹配^[a-zA-Z_][a-zA-Z0-9_]{0,39}$,创建后不可更改;display_name在账号内须唯一。- 类型规则:
checkbox仅支持value_type=bool且无options;single_select/multi_select要求value_type=string且options非空且元素唯一;text仅支持value_type=string且无options。 - 响应仅包含
field_id与field_name,如需完整对象请调用/field/info。 - 该接口会被审计日志记录。
授权
在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。
请求体
application/json
机器名。必须以字母或下划线开头,长度 1–40,由 [a-zA-Z0-9_] 组成;创建后不可更改。
Maximum string length:
39Pattern:
^[a-zA-Z_][a-zA-Z0-9_]{0,39}$展示名,账号内须唯一。
Maximum string length:
39字段类型,创建后不可更改。
可用选项:
checkbox, multi_select, single_select, text 取值类型。checkbox 须为 bool;其他类型须为 string。创建后不可更改。
可用选项:
string, bool, float 可选描述。
Maximum string length:
499single_select/multi_select 必填且非空,元素唯一、每个 1–200 字符;checkbox/text 必须省略或为空。
可选默认值,类型须与 field_type 匹配:checkbox 为 bool;single_select 为 options 中之一;multi_select 为 options 的子集;text 为不超过 3000 字符的字符串。
此页面对您有帮助吗?
⌘I