---
title: "AgentDataSource"
method: PATCH
path: "/agents/{agentId}/data-sources/{publicId}"
tags: ["AgentDataSource"]
---

# AgentDataSource

`PATCH /agents/{agentId}/data-sources/{publicId}`

## Path parameters

- `agentId` string, required
- `publicId` string, required

## Headers

- `Api-Version` 2, required
- `Api-Application` string, required
- `Api-Company` string, required
- `Api-Branding` string

## Request body

- object
  - `continueLoggingOnError` boolean, nullable
  - `device` object
    - `publicId` string
  - `gracePeriod` integer, nullable
  - `name` string
  - `slug` string
  - `disabled` boolean
  - `protocol` union, required
    - object
      - `publicId` 'custom', required
      - `password` string, required
    - object
      - `publicId` 'modbus', required
      - `slave` integer, nullable
      - `format` 'ABCD' | 'BADC' | 'CDAB' | 'DCBA', nullable
      - `readMode` 'single_value' | 'consecutive_values' | 'gapped_values', nullable
    - object
      - `publicId` 'siemens-step7', required
      - `pdu` integer, nullable
      - `rack` integer, nullable
      - `slot` integer, nullable
    - object
      - `publicId` 'opc-ua', required
      - `authenticationType` 'anonymous' | 'username' | 'certificate', required
      - `username` string, nullable
      - `password` string, nullable
      - `securityMode` 'sign' | 'signandencrypt', nullable
      - `securityPolicy` 'basic256sha256' | 'aes128_sha256_rsaoaep' | 'aes256_sha256_rsapss', nullable
    - object
      - `publicId` 'ethernet-ip', required
      - `cpu` 'compactlogix' | 'micro800' | 'micrologix' | 'micrologix800' | 'omron', required
      - `rack` integer, nullable
      - `slot` integer, nullable
    - object
      - `publicId` 'host', required
    - object
      - `publicId` 'bacnet-ip', required
      - `deviceId` integer, nullable
    - object
      - `publicId` 'mc-protocol', required
      - `cpu` 'FX5U' | 'IQR' | 'L' | 'Q' | 'QNUCPU', nullable
      - `protocol` 'TCP' | 'UDP', nullable
      - `networkNo` integer, nullable
      - `pcNo` string, nullable
      - `requestDestIoNr` string, nullable
      - `requestDestModuleStatNr` integer, nullable
      - `authenticationType` 'none' | 'password', nullable
      - `password` string, nullable
      - `reconnectDelay` integer, nullable
      - `maxBlocks` integer, nullable
      - `maxPoints` integer, nullable
  - `port` integer, nullable
  - `pullDelay` integer, nullable
  - `mqttTopic` string, nullable
  - `mqttBrokerClient` object, nullable
    - `publicId` string

## Response `200`

Success response

- object
  - `status` string, required
  - `type` string, required
  - `data` object, nullable, required

## Other responses

- `4XX` — 4XX error response

---

[API](https://skmtc.net/ixon/apis/ixon-api.md) · [All operations](https://skmtc.net/ixon/apis/ixon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ixon/ixon-api/revisions/7875dc33d41f/schema)