---
title: "AgentList"
method: PATCH
path: "/agents"
tags: ["AgentList"]
---

# AgentList

`PATCH /agents`

## Headers

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

## Request body

- object[]
  - `publicId` string, required
  - `name` string
  - `location` object, nullable
    - `name` string
    - `latitude` string
    - `longitude` string
  - `timeZone` string, nullable
  - `custom` object
  - `description` string, nullable
  - `useStunnel` boolean
  - `replaceMacAddress` string, nullable
  - `reRegistration` boolean
  - `fixedVpnAddress` string, nullable
  - `preferLocationOverGeoip` boolean
  - `card` object, nullable
    - `publicId` string
  - `vpnAudience` object
    - `publicId` string
  - `vpnRequireAccessApproval` boolean
  - `vpnVisibleInMobileApp` boolean
  - `vpnVisibleOnWeb` boolean
  - `dataAudience` object, nullable
    - `publicId` string
  - `rateLimiting` object
    - `configMqttCommandReset` boolean, nullable
    - `configMqttDataReset` boolean, nullable
    - `configOpenvpnReset` boolean, nullable
  - `vpnProtocol` 'udp' | 'tcp'

## 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/versions/7875dc33d41f/schema)