Fleet

Set a collector's nickname; an empty name falls back to the host name

patch/api/{org_id}/fleet/collectors/{id}

Request

Path parameters

org_idstring required

Organization name

idstring required

Collector instance UID

Request body

namestring required

Response

The renamed collector

archstring nullable
configstring nullable
config_versioninteger nullable
delivery'assigned' | 'sent' | 'accepted' | 'running' | 'rejected'

Derived when read from the assignment and the collector's reports.

delivery_errorstring nullable
distributionstring nullable
enrolled_atinteger required

Epoch milliseconds.

hostnamestring nullable
idstring required
last_connected_fromstring nullable

The connection's client address, as ZO_HTTP_REAL_IP_SOURCE resolves it.

last_seeninteger required

Epoch milliseconds.

namestring required

The nickname, or the host name when none was set.

osstring nullable
outdatedboolean required
status'unknown' | 'online' | 'degraded' | 'offline' required

Derived when read from last_seen and the reported health, never stored.

token_idstring nullable
versionstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.