Skip to main content
POST
/
components
Create Component
curl --request POST \
  --url http://localhost:8001/api/components \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "link": "<string>",
  "order": 1,
  "enabled": true,
  "component_group_id": 1
}
'
import requests

url = "http://localhost:8001/api/components"

payload = {
    "name": "<string>",
    "description": "<string>",
    "link": "<string>",
    "order": 1,
    "enabled": True,
    "component_group_id": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    link: '<string>',
    order: 1,
    enabled: true,
    component_group_id: 1
  })
};

fetch('http://localhost:8001/api/components', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8001",
  CURLOPT_URL => "http://localhost:8001/api/components",
  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([
    'name' => '<string>',
    'description' => '<string>',
    'link' => '<string>',
    'order' => 1,
    'enabled' => true,
    'component_group_id' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "http://localhost:8001/api/components"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"link\": \"<string>\",\n  \"order\": 1,\n  \"enabled\": true,\n  \"component_group_id\": 1\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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("http://localhost:8001/api/components")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"link\": \"<string>\",\n  \"order\": 1,\n  \"enabled\": true,\n  \"component_group_id\": 1\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:8001/api/components")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"link\": \"<string>\",\n  \"order\": 1,\n  \"enabled\": true,\n  \"component_group_id\": 1\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "<string>",
    "type": "components",
    "attributes": {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "link": "<string>",
      "order": 123,
      "status": {
        "value": 123
      },
      "enabled": true,
      "meta": [
        "<unknown>"
      ],
      "created": {
        "human": "<string>",
        "string": "<string>"
      },
      "updated": {
        "human": "<string>",
        "string": "<string>"
      },
      "pivot": {
        "component_status": {
          "human": "<string>",
          "value": "<string>"
        }
      }
    },
    "relationships": {
      "group": {
        "data": {
          "type": "componentGroups",
          "id": "<string>"
        }
      },
      "incidents": {
        "data": [
          {
            "type": "incidents",
            "id": "<string>"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "componentGroups",
      "attributes": {
        "id": 123,
        "name": "<string>",
        "order": 123,
        "created": {
          "human": "<string>",
          "string": "<string>"
        },
        "updated": {
          "human": "<string>",
          "string": "<string>"
        }
      },
      "relationships": {
        "components": {
          "data": [
            {
              "type": "components",
              "id": "<string>"
            }
          ]
        }
      }
    }
  ]
}
{
  "message": "<string>"
}
{
  "message": "<string>"
}
{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization
string
header
required

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

Body

application/json

CreateComponentRequestData

name
string
required
Maximum string length: 255
description
string | null
status
enum<integer> | null
Available options:
1,
2,
3,
4,
5,
6
order
integer | null
Required range: x >= 0
enabled
boolean
default:true
component_group_id
integer | null
Required range: x >= 0

Response

Component

data
Component · object
required
included
(ComponentGroup · object | Incident · object)[]