Config APIs
APIs for configuration
Operations
GET
Get Admin Users Or Groups Permissions
Gets permission information for logged in or other admin user or group.
GET
Get Preferences
Gets Horizon Console preferences for the logged in administrator.
PUT
Update Preferences
Updates the Horizon Console preferences for the logged in administrator.
GET
List App Volumes Managers
Lists the configured app volumes managers.
POST
Add App Volumes Manager
Add the app volumes manager
POST
Unassign Farms
Unassign Farms to App Volumes Manager
POST
Validate AVM Certificate
Validates App Volumes manager certificate.
DELETE
Delete App Volumes Manager
deletes the given app volumes manager
GET
Get App Volumes Manager
Retrieves information about an app volumes manager.
PUT
Update App Volumes Manager
Updates the given app volumes manager.
POST
Assign Farms
Assign Farms to App Volumes Manager
POST
Override Certificate
Override the given app volumes manager certificate.
POST
Push Certificates
Push cluster certificates to App Volumes Manager
GET
Get CEIP Info
Get the CEIP Information.
PUT
Update CEIP Info
Update the CEIP Information.
GET
List Connection Servers
Lists the connection servers.
POST
Back Up
Initiates immediate back up of Connection Servers
DELETE
Delete Certificate
Deletes both Machine and Cluster SSL certificates of connection server.
POST
Disable Connection Servers
Disables the given list of connection server ids.
POST
Enable Connection Servers
Enables the given list of connection server ids.
POST
Export Certificate
Exports the in-use certificate of connection server
POST
Generate CSR
Generate Certificate Signing Request(CSR).
POST
Import Certificate
Imports both Machine and Cluster SSL certificate to connection server's certificate store.
POST
Recover Certificates
Recover the deleted certificates.
GET
List Certificate Infos
Retrieves the certificate details.
GET
Get Security Configuration Info
Retrieves the security configuration of connection server and secure gateway
GET
Get Connection Server
Retrieves information about a connection server.
PUT
Update Connection Server
Updates the settings of the given Connection Server.
GET
Get Environment
Retrieves the environment settings.
GET
Get Event Database
Returns information about event database configured.
PUT
Update Event Database
Updates event database configuration.
POST
Clear Event Database
Deletes event database configuration.
GET
List Federation Access Groups
Lists all federation access groups.
POST
Create Federation Access Group
Creates federation access group.
DELETE
Delete Federation Access Group
Deletes a federation access group.
GET
Get Federation Access Group
Retrieves a federation access group.
DELETE
Delete Gateway Access User Or Group
Deletes a specified gateway access user or group in the environment.
GET
List Gateway Access User Or Group
Lists gateway access users or group in the environment.
POST
Create Gateway Access User Or Group
Creates a specified gateway access user or group in the environment.
GET
List Gateways
Lists the registered gateways.
POST
Register Gateway
Register gateway.
DELETE
Unregister Gateway
Unregister gateway.
GET
Get Gateway
Retrieves information about a registered gateway.
GET
Get Global Policies
Returns the global policies in the environment.
PUT
Update Global Policies
Updates the global policies in the environment.
GET
List GSSAPI Authenticators
Lists the configured GSSAPI Authenticators.
POST
Create GSSAPI Authenticator
Creates a GSSAPI authenticator.
DELETE
Delete GSSAPI Authenticator
Deletes a GSSAPI Authenticator.
GET
Get GSSAPI Authenticator
Retrieves information about a GSSAPI Authenticator.
PUT
Update GSSAPI Authenticator
Updates a GSSAPI Authenticator.
GET
List IC Domain Accounts
Lists instant clone domain accounts of the environment.
POST
Create IC Domain Account
Creates instant clone domain account.
DELETE
Delete IC Domain Account
Deletes instant clone domain account.
GET
Get IC Domain Account
Gets instant clone domain account.
PUT
Update IC Domain Account
Updates instant clone domain account.
GET
Get AD Sites Info
Get all the available AD sites for the instant clone domain account.
GET
List IM Assets
Lists image management assets.
POST
Create IM Asset
Creates image management asset.
POST
Create IM Assets
Creates one or more image management assets. Each of the index of result in the response, correspond to the index of the original asset.
DELETE
Delete IM Asset
Deletes image management asset.
GET
Get IM Asset
Gets image management asset.
PUT
Update IM Asset
Updates image management asset.
GET
List IM Streams
Lists image management streams.
POST
Create IM Stream
Creates image management stream.
POST
Create IM Streams
Creates one or more image management streams. Each of the index of result in the response, correspond to the index of the original stream.
DELETE
Delete IM Stream
Deletes image management stream.
GET
Get IM Stream
Gets image management stream.
PUT
Update IM Stream
Updates image management stream.
GET
List IM Tags
Lists image management tags.
POST
Create IM Tag
Creates image management tag.
POST
Create IM Tags
Creates one or more image management tags. Each of the index of result in the response, correspond to the index of the original tag.
DELETE
Delete IM Tag
Deletes image management tag.
GET
Get IM Tag
Gets image management tag.
PUT
Update IM Tag
Updates image management tag.
GET
List IM Versions
Lists image management versions.
POST
Create IM Version
Creates image management version.
POST
Create IM Versions
Creates one or more image management versions. Each of the index of result in the response, correspond to the index of the original version.
DELETE
Delete IM Version
Deletes image management version.
GET
Get IM Version
Gets image management version.
PUT
Update IM Version
Updates image management version.
GET
List JWT Authenticators
Lists the configured JWT authenticators.
POST
Create JWT Authenticator
Creates a JWT authenticator.
DELETE
Delete JWT Authenticator
Deletes the given JWT authenticator.
GET
Get JWT Authenticator
Retrieves information about the given JWT authenticator.
PUT
Update JWT Authenticator
Updates the given JWT authenticator.
GET
List Licenses
Lists all licenses.
POST
Reset Highest Usage Metrics
The highest historical number of concurrent connections will be reset to the current number.
POST
Reset Named User Metrics
The highest historical number of named users will be reset to zero.
POST
Set License Mode
Set the License Mode
GET
List Local Access Groups
Lists all local access groups.
POST
Create Local Access Group
Creates local access group.
DELETE
Delete Local Access Group
Deletes a local access group.
GET
Get Local Access Group
Retrieves a local access group.
POST
Collect
Sends the log collection request for the set of targets
GET
Get Log Levels
Fetches feature wise log level information for a component.
PUT
Set Log Levels
Updates feature specific log level for a component.
GET
List Log Collector Tasks
Lists Log Collector task information
POST
Clean
A finish acknowledgement to notify the connection server for cleanup of collect complete log bundles or to terminate the collect operation if is in progress of collecting logs bundle.
POST
Generate Download UR Ls
Retrieves Download URL for each of specified log collector task.
POST
Purge
Purges the log collection bundle for the provided list of targets.
GET
List Message Clients
Lists the message clients in the environment.
POST
Create Message Client
Creates a Message Client.
DELETE
Delete Message Client
Deletes a message client.
GET
Get Message Client
Retrieves a message client.
PUT
Update Message Client
Updates message client.
DELETE
Delete Permissions
Deletes permissions in bulk.
GET
List Permissions
Lists all permissions.
POST
Create Permissions
Creates permissions in bulk.
GET
Get Permission
Retrieves a permission.
GET
Get Pre Logon Settings
Gets the pre logon settings.
GET
List Selectable Privileges
Lists all selectable privileges.
GET
List RADIUS Authenticators
Lists the configured RADIUS Authenticators.
POST
Create RADIUS Authenticator
Creates a RADIUS Authenticator.
DELETE
Delete RADIUS Authenticator
Deletes the given RADIUS Authenticator.
GET
Get RADIUS Authenticator
Retrieves information about a RADIUS Authenticator.
PUT
Update RADIUS Authenticator
Updates the given RADIUS Authenticator.
POST
Register RCX Client
Registers the RCX client
DELETE
Unregister RCX Client
Unregisters the given RCX Client
PUT
Update RCX Client
Updates the given RCX client.
GET
List RCX Servers
Lists RCX servers of the cluster.
GET
List Roles
Lists all roles.
POST
Create Role
Creates a role.
DELETE
Delete Role
Deletes a role.
GET
Get Role
Retrieves a role.
PUT
Update Role
Updates a role.
GET
List SAML Authenticators
Lists the configured SAML authenticators.
POST
Create SAML Authenticator
Creates a SAML authenticator.
POST
Validate SAML Certificate
Validates SAML Authenticator certificate.
DELETE
Delete SAML Authenticator
Deletes a SAML Authenticator.
GET
Get SAML Authenticator
Retrieves information about a SAML authenticator.
PUT
Update SAML Authenticator
Updates a SAML Authenticator.
GET
List Secondary Credentials
List the configured Secondary Credentials for given user.
POST
Create Secondary Credential
Creates secondary credential.
DELETE
Delete Secondary Credential
Deletes a secondary credential.
GET
Get Secondary Credentials
Get the configured secondary credentials for given id.
POST
Updatepassword
Update password.
GET
Get Settings
Retrieves the configuration settings.
PUT
Update Settings
Updates the configuration settings.
GET
Get Agent Restriction Settings
Retrieves the agent restriction settings.
PUT
Update Agent Restriction Settings
Updates the agent restriction settings.
GET
Get Client Settings
Retrieves the client settings.
PUT
Update Client Settings
Updates the client settings.
GET
Get Feature Settings
Retrieves the feature settings.
PUT
Update Feature Settings
Updates the feature settings.
GET
Get General Settings
Retrieves the general settings.
PUT
Update General Settings
Updates the general settings.
GET
Get Security Settings
Retrieves the security settings.
PUT
Update Security Settings
Updates the security settings.
GET
Get Syslog
Gets Syslog information
PUT
Update Syslog
Updates Syslog configuration.
GET
List True SSO Connectors
Lists the TrueSSO Connectors.
POST
Create True SSO Connector
Creates a TrueSSO Connector.
GET
List Enrollment Servers
Lists the paired TrueSSO Enrollment Servers.
GET
Get Enrollment Server
Retrieves information about a paired TrueSSO Enrollment Server.
DELETE
Delete True SSO Connector
Deletes a TrueSSO Connector.
GET
Get True SSO Connector
Retrieves information about a requested TrueSSO Connector.
PUT
Update True SSO Connector
Updates a TrueSSO Connector.
GET
List Unauthenticated Access Users
Lists unauthenticated access users in the environment.
POST
Create Unauthenticated Access User
Creates a specified unauthenticated access user in the environment.
DELETE
Delete Unauthenticated Access User
Deletes a specified unauthenticated access user in the environment.
GET
Get Unauthenticated Access User
Retrieves a specified unauthenticated access user in the environment.
GET
List Users Or Groups Global Summary
Lists global summary info of users or groups.
GET
Get Users Or Groups Global Summary
Gets global summary info related to AD User or Group.
GET
List Users Or Groups Local Summary
Lists local summary info of users or groups.
POST
Get Storage Details
Gets Storage Details Information.
GET
List VC Info
Lists Virtual Centers configured in the environment.
POST
Validate Virtual Center Certificate
Validates Virtual Center certificate.
POST
Mark Datastores For Archival
Sets archival datastore paths for the vCenter.
GET
Get Preferences V2
Gets Horizon Console preferences for the logged in administrator.
PUT
Update Preferences V2
Updates the Horizon Console preferences for the logged in administrator.
GET
List App Volumes Managers V2
Lists the configured app volumes managers.
POST
Add App Volumes Manager V2
Add the app volumes manager.
DELETE
Delete App Volumes Manager V2
Deletes the given app volumes manager.
GET
Get App Volumes Manager V2
Retrieves information about an app volumes manager.
PUT
Update App Volumes Manager V2
Updates the given app volumes manager.
GET
List Connection Servers V2
Lists the connection servers.
GET
List Certificate Infos V2
Retrieves the certificate details.
GET
Get Connection Server V2
Retrieves information about a connection server.
PUT
Update Connection Server V2
Updates the settings of the given Connection Server.
GET
Get Environment V2
Retrieves the environment settings.
GET
List Federation Access Groups V2
Lists all federation access groups.
GET
Get Federation Access Group V2
Retrieves a federation access group.
GET
List Licenses V2
Lists all licenses.
POST
Set License Key
Set the License Key
GET
List Local Access Groups V2
Lists all local access groups.
GET
Get Local Access Group V2
Retrieves a local access group.
DELETE
Delete Permissions V2
Deletes permissions in bulk.
GET
List Permissions V2
Lists all permissions.
POST
Create Permissions V2
Creates permissions in bulk.
GET
Get Permission V2
Retrieves a permission.
GET
Get Settings V2
Retrieves the configuration settings.
PUT
Update Settings V2
Updates the configuration settings.
GET
Get Feature Settings V2
Retrieves the feature settings.
PUT
Update Feature Settings V2
Updates the feature settings.
GET
Get General Settings V2
Retrieves the general settings.
PUT
Update General Settings V2
Updates the general settings.
GET
Get Security Settings V2
Retrieves the security settings.
GET
List Users Or Groups Local Summary V2
Lists local summary info of users or groups.
GET
Get Users Or Group Local Summary V2
Gets local summary info related to AD User or Group.
GET
List VC Info V2
Lists Virtual Centers configured in the environment.
GET
Get Settings V3
Retrieves the configuration settings.
PUT
Update Settings V3
Updates the configuration settings.
GET
Get General Settings V3
Retrieves the general settings.
PUT
Update General Settings V3
Updates the general settings.
GET
Get Security Settings V3
Retrieves the security settings.
PUT
Update Security Settings V3
Updates the security settings.
GET
List Users Or Groups Local Summary V3
Lists local summary info of users or groups.
GET
Get Users Or Group Local Summary V3
Gets local summary info related to AD User or Group.
GET
List VC Info V3
Lists Virtual Centers configured in the environment.
POST
Create Virtual Center
Creates a virtual center
DELETE
Remove Virtual Center
Removes a Virtual Center from the server
GET
Get Virtual Center
Gets Virtual Center Information.
PUT
Update Virtual Center
Updates virtual center.
GET
Get Settings V4
Retrieves the configuration settings.
PUT
Update Settings V4
Updates the configuration settings.
GET
Get General Settings V4
Retrieves the general settings.
PUT
Update General Settings V4
Updates the general settings.
GET
Get Security Settings V4
Retrieves the security settings.
PUT
Update Security Settings V4
Updates the security settings.
GET
List Users Or Groups Local Summary V4
Lists local summary info of users or groups.
GET
Get Users Or Group Local Summary V4
Gets local summary info related to AD User or Group.
GET
List VC Info V4
Lists Virtual Centers configured in the environment.
POST
Create Virtual Center V4
Creates a virtual center
GET
Get Virtual Center V4
Gets Virtual Center Information.
PUT
Update Virtual Center V4
Updates virtual center.
GET
Get Settings V5
Retrieves the configuration settings.
PUT
Update Settings V5
Updates the configuration settings.
GET
Get General Settings V5
Retrieves the general settings.
PUT
Update General Settings V5
Updates the general settings.
GET
Get Security Settings V5
Retrieves the security settings.
PUT
Update Security Settings V5
Updates the security settings.
GET
List VC Info V5
Lists Virtual Centers configured in the environment.
POST
Create Virtual Center V5
Creates a virtual center
DELETE
Remove Virtual Center V5
Removes a Virtual Center from the server
GET
Get Virtual Center V5
Gets Virtual Center Information.
PUT
Update Virtual Center V5
Updates virtual center.
GET
Get Settings V6
Retrieves the configuration settings.
PUT
Update Settings V6
Updates the configuration settings.
GET
List VC Info V6
Lists Virtual Centers configured in the environment.