Create new circuit

1 minute(s) read

Prev Next

Post

/circuits/

Operation is used to create new circuit. Available from product version 3.2.6.

Security

API Key: Token

Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

circuit to be created

object

areaCode

string

Circuit area code

comments

string

Circuit comments. Available from product version 3.2.8.

contractLength

integer

Circuit contract length

contractNumber

string

Circuit contract number

customer

integer

Circuit customer id

directLength

number (float)

Circuit direct length

identifier

string

Circuit identifier

identifierAlt

string

Circuit alternative identifier

importance

integer

Circuit importance id

installationAddresses

Array of string

Circuit installations addresses

string (url)

length

number (float)

Circuit length

orderNumber

string

Circuit order number

organisation

integer

Circuit organisation id

redundancy

integer

Circuit redundancy id

sections

Array of string

Circuit sections

string (url)

Responses

201

created circuit data

object

areaCode

string

Circuit area code

comments

string

Circuit comments. Available from product version 3.2.8.

contractLength

integer

Circuit contract length

contractNumber

string

Circuit contract number

createdAt

string (date-time)

Creation timestamp (date and time). Available from product version v2026.1.

createdBy

string

Creator username

createdTs

string (date)

Creation date (date only, existing field)

customer

integer

Circuit customer id

directLength

number (float)

Circuit direct length

integer

Primary key

identifier

string

Circuit identifier

identifierAlt

string

Circuit alternative identifier

importance

integer

Circuit importance id

installationAddresses

Array of string

Circuit installations addresses

string (url)

length

number (float)

Circuit length

orderNumber

string

Circuit order number

organisation

integer

Circuit organisation id

redundancy

integer

Circuit redundancy id

sections

Array of string

Circuit sections

string (url)

updatedAt

string (date-time)

Last update timestamp (date and time). Available from product version v2026.1.

updatedBy

string

Last updater username

updatedTs

string (date)

Last update date (date only, existing field)

400

There was an error in request. Usually field validation failed.

object

Fields which failed validation

property*

Array of string additionalProperties

List of validation errors for this fieldname

string

Validation error

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}

object

details

string

Detailed description of error