> ## Documentation Index > Fetch the complete documentation index at: https://docs.kodelabs.com/llms.txt > Use this file to discover all available pages before exploring further. # Ingest devices through a connector > Adds devices to a KODE API connector, or updates devices you added before. The work runs as a background job. > [!NOTE] > > The request is checked first and then runs as a job. A `202` response means the job started, not that the devices exist yet. Read the job with [Get a job](https://docs.kodelabs.com/products/kode-api/api-reference/buildings/get-a-job.md) until `status` is `COMPLETED`, then read the devices back. A job has no result for each item. Send 1 to 1,000 items in one request. Each item needs three members: | Member | Meaning | | - | - | | `deviceExternalId` | Your own stable identifier for the device. KODE uses it to recognize the device on later requests. | | `deviceExternalPath` | The path of the device in your system. | | `deviceName` | The name shown in KODE OS. | You can also send `deviceLocation`, a text description of where the device is. * Only KODE API connectors accept ingestion. A connector of another type returns `400`. * Send a `deviceExternalId` that exists already and the API updates the name and the location of that device. It does not create a second device. * The devices are created in the building and the connector in the path. A `buildingId` in the body is ignored. * Ingest devices before you ingest their points. See [Ingest points through a connector](https://docs.kodelabs.com/products/kode-api/api-reference/connectors/ingest-points-through-a-connector.md). ## OpenAPI ````yaml /openapi/kode-api.yaml post /api/v1/buildings/{buildingId}/connectors/{connectorId}/ingest/devices openapi: 3.1.0 info: title: KODE API version: 1.0.0 summary: Programmatic access to KODE OS resources and operations. description: > Use the KODE API to work with buildings, data sources, connectors, devices, points, virtual devices, timeseries data, schedules, the ontology, templating, mass writes, spaces, space assignments, tenants, meters, users, actions, and AssetOps work orders. license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.kodelabs.com/kodeos description: KODE API security: - bearerAuth: [] tags: - name: Authentication description: OAuth 2.0 discovery, token, and revocation endpoints. - name: Buildings description: Buildings and their areas. - name: Data sources description: Data sources connected to a building. - name: Devices description: Devices and their points. - name: Points description: Point queries and point writes. - name: Timeseries description: Current and historical point values. - name: Actions description: Actions exposed by building data sources. - name: Work orders description: AssetOps work orders, lookups, comments, and attachments. - name: Connectors description: KODE API connectors and the devices and points ingested through them. - name: Schedules description: Schedules discovered on building data sources. - name: Templating description: Apply ontology templates to groups of points. - name: Virtual devices description: Virtual devices that group points from other devices. - name: Ontology description: Canonical types, fields, units, and connections of the KODE ontology. - name: Users description: Users of the organization and their app access. - name: Mass write description: Write values to many points across buildings, and follow each run. - name: Spaces description: Levels and space units of a building, and the meters located in them. - name: Space assignments description: Assign tenants to leasable spaces of a building for a period. - name: Tenants description: Tenants of a building, the people or companies that lease its spaces. - name: Meters description: >- Meters of a building, their space assignments, parent and child links, and readings. paths: /api/v1/buildings/{buildingId}/connectors/{connectorId}/ingest/devices: post: tags: - Connectors summary: Ingest devices through a connector description: >- Adds devices to a KODE API connector, or updates devices you added before. The work runs as a background job. operationId: ingestConnectorDevices parameters: - $ref: '#/components/parameters/BuildingId' - name: connectorId in: path required: true schema: type: string description: >- ID of a KODE API connector, from `_id` in [Create a KODE API connector](/products/kode-api/api-reference/connectors/create-a-kode-api-connector). requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchIngestDevices' required: true responses: '202': description: The job that was started, with status `PROCESSING`. content: application/json: schema: $ref: '#/components/schemas/JobPublic' '400': description: >- `items` is missing, `null`, empty, or holds more than 1,000 items. An item lacks `deviceExternalId`, `deviceExternalPath`, or `deviceName`, or the connector is not a KODE API connector. '401': $ref: '#/components/responses/Unauthorized' '403': description: >- The building does not exist, is not available to your service account, or has no `api` product enabled. Your service account also needs the **Ingest connector devices** action. '404': description: No connector with this id exists in this building. '429': $ref: '#/components/responses/TooManyRequests' components: parameters: BuildingId: name: buildingId in: path required: true description: Building identifier from List buildings. schema: type: string example: 67c960faffaa42223163099e schemas: BatchIngestDevices: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/Item1' maxItems: 1000 minItems: 1 JobPublic: type: object properties: _id: type: string organizationId: type: string createdAt: $ref: '#/components/schemas/Date' type: string readOnly: true updatedAt: $ref: '#/components/schemas/Date' type: string readOnly: true name: type: string description: type: string status: $ref: '#/components/schemas/JobStatus1' errorMessage: type: string Item1: type: object required: - deviceExternalId - deviceExternalPath - deviceName properties: deviceExternalId: type: string pattern: \S deviceExternalPath: type: string pattern: \S deviceName: type: string pattern: \S deviceLocation: type: string Date: type: string description: >- Date and time in UTC, with a numeric offset and no colon, for example `2026-10-28T13:51:31+0000`. examples: - 2026-10-28T13:51:31+0000 JobStatus1: type: string enum: - PENDING - PROCESSING - PROCESSED - COMPLETED - FAILED - CANCELED responses: Unauthorized: description: The access token is missing, invalid, or expired. Request a new token. TooManyRequests: description: >- A rate-limit window is exhausted. Wait, then retry with increasing delays. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Paste an access token from [Create an access token](/products/kode-api/api-reference/authentication/create-an-access-token). Tokens expire, so request a new one if you receive `401`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.