Skip to main content
POST
/
v1
/
form_fields
Creates a Form Field
curl --request POST \
  --url https://api.rootly.com/v1/form_fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "form_fields",
    "attributes": {
      "name": "<string>",
      "value_kind_catalog_id": "<string>",
      "description": "<string>",
      "shown": [
        "<string>"
      ],
      "required": [
        "<string>"
      ],
      "show_on_incident_details": true,
      "enabled": true,
      "default_values": [
        "<string>"
      ],
      "auto_set_by_catalog_property_id": "<string>"
    }
  }
}
'
import requests

url = "https://api.rootly.com/v1/form_fields"

payload = { "data": {
"type": "form_fields",
"attributes": {
"name": "<string>",
"value_kind_catalog_id": "<string>",
"description": "<string>",
"shown": ["<string>"],
"required": ["<string>"],
"show_on_incident_details": True,
"enabled": True,
"default_values": ["<string>"],
"auto_set_by_catalog_property_id": "<string>"
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'form_fields',
attributes: {
name: '<string>',
value_kind_catalog_id: '<string>',
description: '<string>',
shown: ['<string>'],
required: ['<string>'],
show_on_incident_details: true,
enabled: true,
default_values: ['<string>'],
auto_set_by_catalog_property_id: '<string>'
}
}
})
};

fetch('https://api.rootly.com/v1/form_fields', 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.rootly.com/v1/form_fields",
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([
'data' => [
'type' => 'form_fields',
'attributes' => [
'name' => '<string>',
'value_kind_catalog_id' => '<string>',
'description' => '<string>',
'shown' => [
'<string>'
],
'required' => [
'<string>'
],
'show_on_incident_details' => true,
'enabled' => true,
'default_values' => [
'<string>'
],
'auto_set_by_catalog_property_id' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/vnd.api+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.rootly.com/v1/form_fields"

payload := strings.NewReader("{\n \"data\": {\n \"type\": \"form_fields\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"value_kind_catalog_id\": \"<string>\",\n \"description\": \"<string>\",\n \"shown\": [\n \"<string>\"\n ],\n \"required\": [\n \"<string>\"\n ],\n \"show_on_incident_details\": true,\n \"enabled\": true,\n \"default_values\": [\n \"<string>\"\n ],\n \"auto_set_by_catalog_property_id\": \"<string>\"\n }\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/vnd.api+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.rootly.com/v1/form_fields")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"form_fields\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"value_kind_catalog_id\": \"<string>\",\n \"description\": \"<string>\",\n \"shown\": [\n \"<string>\"\n ],\n \"required\": [\n \"<string>\"\n ],\n \"show_on_incident_details\": true,\n \"enabled\": true,\n \"default_values\": [\n \"<string>\"\n ],\n \"auto_set_by_catalog_property_id\": \"<string>\"\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/form_fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"form_fields\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"value_kind_catalog_id\": \"<string>\",\n \"description\": \"<string>\",\n \"shown\": [\n \"<string>\"\n ],\n \"required\": [\n \"<string>\"\n ],\n \"show_on_incident_details\": true,\n \"enabled\": true,\n \"default_values\": [\n \"<string>\"\n ],\n \"auto_set_by_catalog_property_id\": \"<string>\"\n }\n }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "<string>",
    "type": "form_fields",
    "attributes": {
      "name": "<string>",
      "shown": [
        "<string>"
      ],
      "required": [
        "<string>"
      ],
      "default_values": [
        "<string>"
      ],
      "created_at": "<string>",
      "updated_at": "<string>",
      "value_kind_catalog_id": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "show_on_incident_details": true,
      "enabled": true,
      "auto_set_by_catalog_property_id": "<string>"
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}
{
"errors": [
{
"title": "<string>",
"status": "<string>",
"code": "<string>",
"detail": "<string>"
}
]
}
{
"errors": [
{
"title": "<string>",
"status": "<string>",
"code": "<string>",
"detail": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/vnd.api+json
data
object
required

Response

form_field created with auto_set_by_catalog_property_id

data
object
required
included
object[]