Sign in

v1

latestOpenAPI 3.0.2All Rights Reserved2026-07-2467611.6 MB
AgentServer

AgentServer

patch/agents/{agentId}/servers/{publicId}

Path parameters

agentIdstring required
publicIdstring required

Headers

Api-Version2 required

Version of the API to use

Api-Applicationstring required

Get your Application ID via support@ixon.cloud

Api-Companystring required

PublicId of the company

Api-Brandingstring

Domain that provides the branding

Request body

serviceGroupstring nullable
namestring
portinteger
usernamestring nullable
passwordstring nullable
authDomainstring nullable
landingPagestring
connectionQuality'low' | 'normal' | 'high' nullable
readOnlyboolean nullable
vncRightClickOnTouchHoldboolean
vncEncoding'copyrect' | 'corre' | 'hextile' | 'raw' | 'rre' | 'tight' | 'ultra' | 'ultrazip' | 'zlib' | 'zlibhex' | 'zrle' | 'zywrle' nullable
useSslboolean
visibleInMobileAppboolean
visibleOnWebboolean
httpAuthenticationType'ntlm' | 'basic' | 'digest' nullable
flagsstring[]
recordSessionsboolean nullable
requireAccessApprovalboolean
customobject

Response

Success response

statusstring required
typestring required
dataobject nullable required