---
title: "Create a circuit"
method: POST
path: "/{org_slug}/circuits"
tags: ["Circuits"]
---

# Create a circuit

`POST /{org_slug}/circuits`

## Request

- Base URL: `https://api.obelinf.com`
- URL: `https://api.obelinf.com/{org_slug}/circuits`
- Auth: HTTP bearer

Create a circuit

## Path parameters

- `org_slug` string, required

## Request body

- object
  - `name` string, required
  - `site_a_id` string, required
  - `site_b_id` string, required
  - `slug` string, required
  - `bandwidth` number
  - `cid` string
  - `circuit_group_id` string
  - `description` string
  - `interface_a_id` string
  - `interface_b_id` string
  - `provider_id` string
  - `status` 'active' | 'decommissioned' | 'planned'
  - `type_id` string

## Response `201`

Created

- object
  - `circuit` object, required
    - `created_at` string, required
    - `id` string, required
    - `name` string, required
    - `site_a_id` string, required
    - `site_a_name` string, required
    - `site_b_id` string, required
    - `site_b_name` string, required
    - `slug` string, required
    - `status` 'active' | 'decommissioned' | 'planned', required
    - `updated_at` string, required
    - `bandwidth` number, nullable
    - `cid` string, nullable
    - `circuit_group_id` string, nullable
    - `description` string, nullable
    - `interface_a_device_name` string, nullable
    - `interface_a_id` string, nullable
    - `interface_a_name` string, nullable
    - `interface_b_device_name` string, nullable
    - `interface_b_id` string, nullable
    - `interface_b_name` string, nullable
    - `provider_id` string, nullable
    - `provider_name` string, nullable
    - `type_id` string, nullable
    - `type_name` string, nullable
  - `tags` object[], required
    - `id` string, required
    - `tag_id` string, required
    - `tag_name` string, required
    - `tag_color` string, nullable

## Other responses

- `400`: Validation Error
- `403`: Feature not available
- `404`: Not found
- `409`: Conflict

---

[API](https://skmtc.dev/obelinf/apis/obelinf-api.md) · [All operations](https://skmtc.dev/obelinf/apis/obelinf-api/llms.txt) · [OpenAPI document](https://skmtc.dev/obelinf/apis/obelinf-api/revisions/463fcf791828?raw)