Skip to main content
POST
Create a KODE API connector
The only input is name. KODE sets integrationType to API_KODE. Keep the _id from the response. You use it as connectorId in every other connector request.
Names are free text. The API accepts a second connector with the same name in the same building, so call List connectors first if you want to reuse one. Unknown properties in the body are ignored.
A connector appears in KODE OS as a data source of the building. Its _id is the data source id that the data source endpoints use, for example in Ingest device and point data. The response does not include entities. Get a connector returns them.

Authorizations

Authorization
string
header
required

Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.

Path Parameters

buildingId
string
required

Building identifier from List buildings.

Body

application/json
name
string
required
Pattern: \S

Response

The created connector.

_id
string
organizationId
string
createdAt
string
read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

updatedAt
string
read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

name
string
integrationType
string
disabled
boolean
systemTypes
string[]
entities
enum<string>[]
Available options:
DEVICES,
SCHEDULES,
ASSETS