Create site

curl --request POST \
  --url https://api.example.com/api/v1/sites/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "organisation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "annotations": {},
  "tags": [
    "<string>"
  ],
  "inventory_only": true
}
'

import requests

url = "https://api.example.com/api/v1/sites/"

payload = {
    "name": "<string>",
    "slug": "<string>",
    "organisation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "annotations": {},
    "tags": ["<string>"],
    "inventory_only": True
}
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>',
    slug: '<string>',
    organisation: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    annotations: {},
    tags: ['<string>'],
    inventory_only: true
  })
};

fetch('https://api.example.com/api/v1/sites/', 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.example.com/api/v1/sites/",
  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>',
    'slug' => '<string>',
    'organisation' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'annotations' => [
        
    ],
    'tags' => [
        '<string>'
    ],
    'inventory_only' => true
  ]),
  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 := "https://api.example.com/api/v1/sites/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"organisation\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"annotations\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"inventory_only\": true\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("https://api.example.com/api/v1/sites/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"organisation\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"annotations\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"inventory_only\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/sites/")

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/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"organisation\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"annotations\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"inventory_only\": true\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_name": "<string>",
  "links": {
    "self": "<string>",
    "collection": "<string>",
    "organisation": "<string>",
    "locations": "<string>",
    "racks": "<string>",
    "devices": "<string>",
    "jobs": "<string>"
  },
  "counts": {
    "total": 123,
    "inventory_only_devices": 123,
    "customer_ready": {
      "true": 123,
      "false": 123
    },
    "inventory_status": {
      "planned": 123,
      "staged": 123,
      "active": 123,
      "failed": 123,
      "offline": 123,
      "rma": 123,
      "returned": 123,
      "decommissioning": 123,
      "decommissioned": 123,
      "inventory": 123,
      "unknown": 123
    },
    "operational_status": {
      "unknown": 123,
      "quarantine": 123,
      "validation": 123,
      "available": 123,
      "in_use": 123,
      "delegated": 123,
      "pending_handover": 123,
      "drained": 123,
      "failed": 123
    },
    "health_status": {
      "unknown": 123,
      "healthy": 123,
      "degraded": 123,
      "critical": 123
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "slug": "<string>",
  "organisation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "annotations": {},
  "tags": [
    "<string>"
  ],
  "country": "AF",
  "inventory_only": true
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

POST

api

sites

Create site

curl --request POST \
  --url https://api.example.com/api/v1/sites/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "organisation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "annotations": {},
  "tags": [
    "<string>"
  ],
  "inventory_only": true
}
'

import requests

url = "https://api.example.com/api/v1/sites/"

payload = {
    "name": "<string>",
    "slug": "<string>",
    "organisation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "annotations": {},
    "tags": ["<string>"],
    "inventory_only": True
}
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>',
    slug: '<string>',
    organisation: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    annotations: {},
    tags: ['<string>'],
    inventory_only: true
  })
};

fetch('https://api.example.com/api/v1/sites/', 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.example.com/api/v1/sites/",
  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>',
    'slug' => '<string>',
    'organisation' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'annotations' => [
        
    ],
    'tags' => [
        '<string>'
    ],
    'inventory_only' => true
  ]),
  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 := "https://api.example.com/api/v1/sites/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"organisation\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"annotations\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"inventory_only\": true\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("https://api.example.com/api/v1/sites/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"organisation\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"annotations\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"inventory_only\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/sites/")

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/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"organisation\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"annotations\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"inventory_only\": true\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_name": "<string>",
  "links": {
    "self": "<string>",
    "collection": "<string>",
    "organisation": "<string>",
    "locations": "<string>",
    "racks": "<string>",
    "devices": "<string>",
    "jobs": "<string>"
  },
  "counts": {
    "total": 123,
    "inventory_only_devices": 123,
    "customer_ready": {
      "true": 123,
      "false": 123
    },
    "inventory_status": {
      "planned": 123,
      "staged": 123,
      "active": 123,
      "failed": 123,
      "offline": 123,
      "rma": 123,
      "returned": 123,
      "decommissioning": 123,
      "decommissioned": 123,
      "inventory": 123,
      "unknown": 123
    },
    "operational_status": {
      "unknown": 123,
      "quarantine": 123,
      "validation": 123,
      "available": 123,
      "in_use": 123,
      "delegated": 123,
      "pending_handover": 123,
      "drained": 123,
      "failed": 123
    },
    "health_status": {
      "unknown": 123,
      "healthy": 123,
      "degraded": 123,
      "critical": 123
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "slug": "<string>",
  "organisation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "annotations": {},
  "tags": [
    "<string>"
  ],
  "country": "AF",
  "inventory_only": true
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

Serializer for Site model.

name

string

required

Maximum string length: 255

slug

string

required

Maximum string length: 50

Pattern: ^[-a-zA-Z0-9_]+$

organisation

string<uuid>

required

annotations

object

Key-value annotations. Keys must start with a lowercase letter and contain only lowercase alphanumeric segments joined by hyphens or underscores (e.g. 'org-id', 'gpu_ready').

Show child attributes

Response

Serializer for Site model.

string<uuid>

required

read-only

organisation_name

string

required

read-only

links

object

required

Serializer for site links.

Show child attributes

counts

object

required

Schema for the nested counts field on Site responses.

Every bucket bar inventory_only_devices is scoped to FM-managed devices (see device_status_count_aggregations), so an inventory_only site legitimately reports zero across them however many inventory rows it holds — inventory_only_devices is where those rows are counted. Filter the site list by inventory_only to list the same universe a given bucket measures.

Show child attributes

created_at

string<date-time>

required

read-only

updated_at

string<date-time>

required

read-only

name

string

required

Maximum string length: 255

slug

string

required

Maximum string length: 50

Pattern: ^[-a-zA-Z0-9_]+$

organisation

string<uuid>

required

annotations

object

Key-value annotations. Keys must start with a lowercase letter and contain only lowercase alphanumeric segments joined by hyphens or underscores (e.g. 'org-id', 'gpu_ready').

Show child attributes

Start Here

Operator Guide

Developer Guide

Relationships

Deployment Guide

Archived

API Reference

Create site

Authorizations

Body

Response