Skip to content

Create circuit

POST
/api/circuits
 
curl --request POST \
  --url http://localhost:3000/api/circuits \
  --header 'Content-Type: application/json' \
  --cookie session=<session> \
  --data '{ "name": "example", "cid": "example", "providerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "typeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "status": "example", "installDate": "example", "commitRate": 1, "description": "example" }'

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required
string
cid
required
string
providerId
string format: uuid
typeId
string format: uuid
status
string
installDate
string
commitRate
integer
description
string
Example generated
{
  "name": "example",
  "cid": "example",
  "providerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "typeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "status": "example",
  "installDate": "example",
  "commitRate": 1,
  "description": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Circuit created

Media type application/json
object
data
object
id
required
string format: uuid
name
required
string
cid
string
nullable
providerId
string format: uuid
nullable
typeId
string format: uuid
nullable
status
string
nullable
installDate
string
nullable
commitRate
integer
nullable
description
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example generated
{
  "data": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "cid": "example",
    "providerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "typeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "status": "example",
    "installDate": "example",
    "commitRate": 1,
    "description": "example",
    "createdAt": "2026-04-15T12:00:00Z",
    "updatedAt": "2026-04-15T12:00:00Z"
  }
}

400

Section titled “400 ”

Validation error

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}

401

Section titled “401 ”

Not authenticated

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}