All URIs are relative to /

Method	HTTP request	Description
AddArchiveRule	Post /config/archive/rule	Add Workload Archiving rule
AddExternalUser	Post /config/mft/externaluser	Add and external user
AddExternalUserOrUserGroupToMFTFolder	Post /config/mft/virtualfolder/{folderName}/user/{userOrGroup}	Add external user or user groups to virtual folder external users list.
AddGateway	Post /config/mft/gateway	add gateway.
AddHostToHostgroup	Post /config/server/{server}/hostgroup/{hostgroup}/agent	add agent to hostgroup
AddHubToCluster	Post /config/mft/cluster/hub/{agentname}	add hub to cluster.
AddMFTFolder	Post /config/mft/virtualfolder	Add virtual folder
AddMftUserGroup	Post /config/mft/usergroup	Add user group.
AddPgpTemplate	Post /config/server/{server}/agent/{agent}/mft/pgptemplate/{templateName}	Add PGP Template
AddRemoteHost	Post /config/server/{server}/remotehost	add remote host to Server
AddRole	Post /config/authorization/role	Add Authorization Role
AddRoleToLdapGroup	Post /config/authorization/ldap/{ldapgroup}/role/{role}	Add a role to LDAP group
AddRoleToUser	Post /config/authorization/user/{user}/role/{role}	Add a role to user
AddSecret	Post /config/secret	Add a new secret
AddServer	Post /config/server	add server to the system
AddUser	Post /config/authorization/user	Add user
AddZosTemplate	Post /config/server/{server}/agent/{agent}/mft/zostemplate/{templateName}	Add z/OS Template
AuthorizeMftSshCluster	Post /config/server/{server}/agent/{agent}/mft/ssh/cluster/{clusterName}	Authorize SSH Cluster
AuthorizeMftSshHost	Post /config/server/{server}/agent/{agent}/mft/ssh/host/{hostname}	Authorize SSH Host
AuthorizeSshKnownRemotehost	Post /config/server/{server}/remotehost/{remotehost}/authorize	Authorize
ChangeUserPassword	Post /config/user/{user}/password/adminUpdate	Change user password
CreateAgentCertificateSigningRequest	Post /config/server/{server}/agent/{agent}/csr	Create certificate signing request (CSR).
CreateRunAsUser	Post /config/server/{server}/runasuser	Add a new Run-as user
DeleteAgent	Delete /config/server/{server}/agent/{agent}	delete an agent from Server
DeleteArchiveRule	Delete /config/archive/rule/{ruleName}	Delete Workload Archiving rule
DeleteAuthorizationRole	Delete /config/authorization/role/{role}	Delete Authorization Role
DeleteExternalUser	Delete /config/mft/externaluser/{username}	Delete an external user
DeleteExternalUserOrUserGroupFromMFTFolder	Delete /config/mft/virtualfolder/{folderName}/user/{userOrGroup}	Remove an external user or user group from an existing virtual folder in MFT.
DeleteHostFromGroup	Delete /config/server/{server}/hostgroup/{hostgroup}/agent/{host}	delete an agent from a hostgroup
DeleteHostGroup	Delete /config/server/{server}/hostgroup/{hostgroup}	delete host group
DeleteMFTFolder	Delete /config/mft/virtualfolder/{folderName}	Delete a virtual folder.
DeleteMftUserGroup	Delete /config/mft/usergroup/{name}	Delete user group.
DeletePgpTemplate	Delete /config/server/{server}/agent/{agent}/mft/pgptemplate/{templateName}	Delete PGP Template
DeleteRemoteHost	Delete /config/server/{server}/remotehost/{remotehost}	delete a remote host from Server
DeleteRoleFromLdapGroup	Delete /config/authorization/ldap/{ldapgroup}/role/{role}	Delete a role from LDAP group
DeleteRunAsUser	Delete /config/server/{server}/runasuser/{agent}/{user}	delete Run-as user
DeleteSecret	Delete /config/secret/{name}	Delete an existing secret
DeleteUser	Delete /config/authorization/user/{user}	Delete user
DeleteZosTemplate	Delete /config/server/{server}/agent/{agent}/mft/zostemplate/{templateName}	Delete z/OS Template
DeployAgentCertificate	Post /config/server/{server}/agent/{agent}/crt	Deploy certificate (CRT).
DisableAgent	Post /config/server/{server}/agent/{agent}/disable	disable agent from the Server
EnableAgent	Post /config/server/{server}/agent/{agent}/enable	enable agent from the Server
Failover	Put /config/server/{server}/failover	Perform Manual Failover on a specified Server
GenerateMftRsaSshKey	Post /config/server/{server}/agent/{agent}/mft/ssh/key	Generate RSA SSH Key
GetAgentCertificateExpirationDate	Get /config/server/{server}/agent/{agent}/crt/expiration	Get certificate expiration date.
GetAgentParameters	Get /config/server/{server}/agent/{agent}/params	get agent parameters
GetAgents	Get /config/server/{server}/agents	get Server agents
GetAllArchiveRules	Get /config/archive/rules	Get all Workload Archiving rules
GetAllAuthorizationRoles	Get /config/authorization/roles	Get Authorization Roles
GetAllLdapGroups	Get /config/authorization/ldaps	Get All LDAP groups
GetAllRolesAssociatedWithLdap	Get /config/authorization/ldap/{ldapgroup}/roles	Get Authorization Roles associated with an LDAP group
GetAllUsers	Get /config/authorization/users	Get users
GetArchiveStatistics	Get /config/archive/statistics	Get Workload Archiving statistics
GetExternalUserAuthorizedFolders	Get /config/mft/externaluser/{name}/virtualfolders	Get MFT external user authorized folders
GetExternalUsers	Get /config/mft/externalusers	Get MFT external users that match the search criteria.
GetFtsSettings	Get /config/server/{server}/agent/{agent}/mft/fts/settings	Get File Transfer Server (FTS) configuration data.
GetHostgroups	Get /config/server/{server}/hostgroups	get Server hostgroups
GetHostsInGroup	Get /config/server/{server}/hostgroup/{hostgroup}/agents	get hostgroup agents
GetHubStatusDetails	Get /config/mft/hub/{nodeId}/status	Get hub status.
GetMFTFolders	Get /config/mft/virtualfolders	Get MFT virtual folders that match the search criteria.
GetMftConfiguration	Get /config/server/{server}/agent/{agent}/mft/configuration	Get MFT Configuration
GetMftGateways	Get /config/mft/gateways	Get MFT gateways
GetMftUserGroups	Get /config/mft/usergroups	Get all user groups that match the search criteria.
GetPgpTemplates	Get /config/server/{server}/agent/{agent}/mft/pgptemplates	Get PGP Templates
GetRemoteHostProperties	Get /config/server/{server}/remotehost/{remotehost}	get a remote host configuration from Server
GetRemoteHosts	Get /config/server/{server}/remotehosts	get Server remote hosts
GetRole	Get /config/authorization/role/{role}	Get Authorization Role
GetRoleAssociates	Get /config/authorization/role/{role}/associates	Get all authorization entities associated with role
GetRunAsUser	Get /config/server/{server}/runasuser/{agent}/{user}	Get Run-as user
GetRunAsUsersList	Get /config/server/{server}/runasusers	Get Run-as user list that match the requested search criteria.
GetServerParameters	Get /config/server/{server}/params	get Server parameters
GetServers	Get /config/servers	get all the Servers name and hostname in the system
GetUser	Get /config/authorization/user/{user}	Get user
GetUserEffectiveRights	Get /config/authorization/user/effectiveRights	Get user real effective authorizations
GetZosTemplates	Get /config/server/{server}/agent/{agent}/mft/zostemplates	Get z/OS Templates
ListSecrets	Get /config/secrets	Get list of secret names
PingAgent	Post /config/server/{server}/agent/{agent}/ping	ping to the agent in the Server
RecycleItem	Post /config/item/{id}/recycle	recycle item
RemoveControlmServer	Delete /config/server/{server}	Delete Server
RemoveGateway	Delete /config/mft/gateway/{gatewayName}	remove gateway.
RemoveHubFromCluster	Delete /config/mft/cluster/hub/{agentname}	remove hub from cluster.
RemoveRoleFromUser	Delete /config/authorization/user/{user}/role/{role}	Remove a role from a user
SendArchiveCleanupRequest	Delete /config/archive/cleanup	Deletes data (jobs including outputs and logs) from the Workload Archiving database.
SetAgentParameter	Post /config/server/{server}/agent/{agent}/param/{name}	set agent parameter
SetSystemParam	Post /config/em/param/{name}	set value of a an em system parameter
Setasprimary	Put /config/server/{server}/setasprimary	Set secondary server as Primary on a specified Server
TestRunAsUser	Post /config/server/{server}/runasuser/{agent}/{user}/test	Test existed Run-as user
UpdateArchiveRule	Post /config/archive/rule/{ruleName}	Edit Workload Archiving rule
UpdateExternalUser	Post /config/mft/externaluser/{username}	Update an external user
UpdateFtsSettings	Post /config/server/{server}/agent/{agent}/mft/fts/settings	Update File Transfer Server (FTS) configuration data.
UpdateHostsInHostgroup	Post /config/server/{server}/hostgroup/{hostgroup}	update agents in hostgroup.
UpdateMFTFolder	Post /config/mft/virtualfolder/{folderName}	Update an existing virtual folder in MFT.
UpdateMftConfiguration	Post /config/server/{server}/agent/{agent}/mft/configuration	Update MFT Configuration
UpdateMftUserGroup	Post /config/mft/usergroup/{name}	Update user group.
UpdatePgpTemplate	Put /config/server/{server}/agent/{agent}/mft/pgptemplate/{templateName}	Update PGP Template
UpdateRole	Post /config/authorization/role/{role}	Update Authorization Role
UpdateRunAsUser	Post /config/server/{server}/runasuser/{agent}/{user}	Update Run-as user
UpdateSecret	Post /config/secret/{name}	Update an existing secret
UpdateUser	Post /config/authorization/user/{user}	Update user
UpdateZosTemplate	Put /config/server/{server}/agent/{agent}/mft/zostemplate/{templateName}	Update z/OS Template

AddArchiveRule

SuccessData AddArchiveRule(ctx, body) Add Workload Archiving rule

Add a new Workload Archiving rule

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	ArchiveRule	archive rule details to add

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddExternalUser

SuccessData AddExternalUser(ctx, body) Add and external user

Add and external user for b2b

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	ExternalUserData	External user data

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddExternalUserOrUserGroupToMFTFolder

SuccessData AddExternalUserOrUserGroupToMFTFolder(ctx, folderName, userOrGroup) Add external user or user groups to virtual folder external users list.

Add external user user groups to virtual folder external users list.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
folderName	string	Name of folder
userOrGroup	string	The user name or group name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddGateway

SuccessData AddGateway(ctx, body) add gateway.

add gateway.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	GatewayData	gateway data

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddHostToHostgroup

AgentsInGroupSuccessData AddHostToHostgroup(ctx, body, server, hostgroup) add agent to hostgroup

Add an agent to hostgroup. Create the the hostgroup if it does not exist.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	AgentInHostgroup	The hostname of the new agent
server	string	The Server the hostgroup belongs to.
hostgroup	string	The hostgroup name

Return type

AgentsInGroupSuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddHubToCluster

SuccessData AddHubToCluster(ctx, agentname) add hub to cluster.

add hub to cluster.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
agentname	string	Agent name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddMFTFolder

SuccessData AddMFTFolder(ctx, body) Add virtual folder

Add virtual folder

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	FolderPropertiesData	virtual folder data

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddMftUserGroup

SuccessData AddMftUserGroup(ctx, body) Add user group.

Add user group.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	UserGroupPropertiesData	User group object properites

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddPgpTemplate

SuccessData AddPgpTemplate(ctx, body, server, agent, templateName) Add PGP Template

Add PGP Template

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	PgpTemplateData	PGP Template Data
server	string	The Server
agent	string	The Agent
templateName	string	The PGP Template Name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddRemoteHost

SuccessData AddRemoteHost(ctx, server, optional) add remote host to Server

Add a remote host to Server.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server the remote host is going to be added to.
optional	*ConfigApiAddRemoteHostOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiAddRemoteHostOpts struct

Name	Type	Description	Notes

body | optional.Interface of AddRemoteHostParams| The non default, advanced configuration data |

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddRole

SuccessData AddRole(ctx, roleFile) Add Authorization Role

Add Authorization Role

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
roleFile	os.Fileos.File

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddRoleToLdapGroup

SuccessData AddRoleToLdapGroup(ctx, ldapgroup, role) Add a role to LDAP group

Add a role to LDAP group so any user belong to the LDAP group will get all permissions defined in the role

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ldapgroup	string	Name of LDAP group
role	string	Name of role

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddRoleToUser

SuccessData AddRoleToUser(ctx, user, role) Add a role to user

Add a role to user so that user will inherit role authorization

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
user	string	Name of user
role	string	Name of role

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddSecret

SuccessData AddSecret(ctx, body) Add a new secret

Add a new secret to the secrets vault.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	SecretKeyValue	The new secret value

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddServer

SuccessData AddServer(ctx, body) add server to the system

Add a Server. This command setting up new server in the system

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	AddServerParams

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddUser

SuccessData AddUser(ctx, userFile) Add user

Add user

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userFile	os.Fileos.File

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddZosTemplate

SuccessData AddZosTemplate(ctx, body, server, agent, templateName) Add z/OS Template

Add z/OS Template

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	ZosTemplateData	z/OS Template Data
server	string	The Server
agent	string	The Agent
templateName	string	The z/OS Template Name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AuthorizeMftSshCluster

SuccessData AuthorizeMftSshCluster(ctx, body, server, agent, clusterName) Authorize SSH Cluster

Authorize SSH Cluster

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	ClusterAuthorizationData	File with content of hostnames and ports
server	string	The Server
agent	string	The Agent
clusterName	string	Ssh Cluster Name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AuthorizeMftSshHost

SuccessData AuthorizeMftSshHost(ctx, server, agent, hostname, optional) Authorize SSH Host

Authorize SSH Host for SFTP account

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server
agent	string	The Agent
hostname	string	Ssh Hostname
optional	*ConfigApiAuthorizeMftSshHostOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiAuthorizeMftSshHostOpts struct

Name	Type	Description	Notes

port | optional.String| Ssh port for the relevant host |

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AuthorizeSshKnownRemotehost

SuccessData AuthorizeSshKnownRemotehost(ctx, server, remotehost) Authorize

Authorized known ssh remote host.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server the remote host is connected to.
remotehost	string	The name of the remote host.

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ChangeUserPassword

SuccessData ChangeUserPassword(ctx, user, optional) Change user password

Change user password

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
user	string	user name
optional	*ConfigApiChangeUserPasswordOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiChangeUserPasswordOpts struct

Name	Type	Description	Notes

body | optional.Interface of UserPassword| The new password. |

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateAgentCertificateSigningRequest

string CreateAgentCertificateSigningRequest(ctx, body, server, agent) Create certificate signing request (CSR).

Create certificate signing request (CSR) on SSL configured Agent.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	CertificateSigningRequestData	Certificate Signing Request (CSR) data
server	string	The Server.
agent	string	The Agent.

Return type

string

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateRunAsUser

SuccessData CreateRunAsUser(ctx, body, server) Add a new Run-as user

Add a new Run-as user to server.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	RunAsUserData	Run as user data
server	string	The Server.

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteAgent

SuccessData DeleteAgent(ctx, server, agent) delete an agent from Server

Delete an agent from a Server. This will not shut the agent down. It only disconnects and removes it from the list.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server the agent is connected to.
agent	string	The name of the agent to delete.

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteArchiveRule

SuccessData DeleteArchiveRule(ctx, ruleName, deleteRuleDataFlag) Delete Workload Archiving rule

Deletes Workload Archiving rule by name. It is required to send deleteRuleData flag to specify if rule need to be deleted with all the collected data or deleteRuleWithoutData otherwise.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ruleName	string	Rule name to delete
deleteRuleDataFlag	string	Remove rule with collected data or without. REQUIRED.

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteAuthorizationRole

SuccessData DeleteAuthorizationRole(ctx, role) Delete Authorization Role

Delete Authorization Role

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
role	string	The Role name.

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteExternalUser

SuccessData DeleteExternalUser(ctx, username) Delete an external user

Delete an existing external user in MFT

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
username	string	The name of the external user to delete

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteExternalUserOrUserGroupFromMFTFolder

SuccessData DeleteExternalUserOrUserGroupFromMFTFolder(ctx, folderName, userOrGroup) Remove an external user or user group from an existing virtual folder in MFT.

Remove an external user or user group from an existing virtual folder in MFT.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
folderName	string	Name of folder
userOrGroup	string	The user name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteHostFromGroup

AgentsInGroupSuccessData DeleteHostFromGroup(ctx, server, hostgroup, host) delete an agent from a hostgroup

Delete an agent from the specified hostgroup. If the group is empty it will also be deleted.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server the hostgroup belongs to.
hostgroup	string	The hostgroup name
host	string	The agent to be deleted

Return type

AgentsInGroupSuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteHostGroup

SuccessData DeleteHostGroup(ctx, server, hostgroup) delete host group

delete host group

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server the agent is connected to.
hostgroup	string	The hostgroup name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMFTFolder

SuccessData DeleteMFTFolder(ctx, folderName) Delete a virtual folder.

Delete an existing virtual folder in MFT.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
folderName	string	Name of folder

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMftUserGroup

SuccessData DeleteMftUserGroup(ctx, name) Delete user group.

Delete user group.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string	User group name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeletePgpTemplate

SuccessData DeletePgpTemplate(ctx, server, agent, templateName) Delete PGP Template

Delete PGP Template

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server
agent	string	The Agent
templateName	string	The PGP Template Name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteRemoteHost

SuccessData DeleteRemoteHost(ctx, server, remotehost) delete a remote host from Server

Delete a remote host from a Server.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server the remote host is connected to.
remotehost	string	The name of the remote host to delete.

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteRoleFromLdapGroup

SuccessData DeleteRoleFromLdapGroup(ctx, ldapgroup, role) Delete a role from LDAP group

Delete a role from LDAP group

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ldapgroup	string	Name of LDAP group
role	string	Name of role

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteRunAsUser

SuccessData DeleteRunAsUser(ctx, server, agent, user) delete Run-as user

Delete Run-as user from server

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server.
agent	string	The Agent
user	string	The user name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteSecret

SuccessData DeleteSecret(ctx, name) Delete an existing secret

Delete an existing secret from the secrets vault.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string	The name of the secret to update

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteUser

SuccessData DeleteUser(ctx, user) Delete user

Delete user

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
user	string	The user name.

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteZosTemplate

SuccessData DeleteZosTemplate(ctx, server, agent, templateName) Delete z/OS Template

Delete z/OS Template

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server
agent	string	The Agent
templateName	string	The z/OS Template Name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeployAgentCertificate

SuccessData DeployAgentCertificate(ctx, crtFile, caChainFile, server, agent) Deploy certificate (CRT).

Deploy certificate (CRT) on SSL configured Agent.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
crtFile	os.Fileos.File
caChainFile	os.Fileos.File
server	string	The Server.
agent	string	The Agent.

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DisableAgent

SuccessData DisableAgent(ctx, server, agent) disable agent from the Server

Disable an Agent.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server the agent is connected too.
agent	string	The Agent to be disabled.

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnableAgent

SuccessData EnableAgent(ctx, server, agent) enable agent from the Server

Enable an Agent. This command does not install or configure the agent. It only enable existing agent in the system.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server the agent is connected too.
agent	string	The Agent to be enabled.

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Failover

SuccessData Failover(ctx, server) Perform Manual Failover on a specified Server

Perform Manual Failover on a specified Server

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GenerateMftRsaSshKey

SuccessData GenerateMftRsaSshKey(ctx, body, server, agent) Generate RSA SSH Key

Generate RSA SSH Key pair for SFTP account authentication

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	SshKeyProperties	Ssh Key pair properites
server	string	The Server
agent	string	The Agent

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAgentCertificateExpirationDate

AgentCertificateExpirationData GetAgentCertificateExpirationDate(ctx, server, agent) Get certificate expiration date.

Get the certificate expiration date of SSL configured Agent.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server.
agent	string	The Agent.

Return type

AgentCertificateExpirationData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAgentParameters

[]KeyValue GetAgentParameters(ctx, server, agent, optional) get agent parameters

Get all the parameters of the specified Agent.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server the agent is connected to.
agent	string	The name of the agent to query.
optional	*ConfigApiGetAgentParametersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiGetAgentParametersOpts struct

Name	Type	Description	Notes

extendedData | optional.Bool| True to return more agent parameters. HIDDEN |

Return type

[]KeyValue

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAgents

AgentDetailsList GetAgents(ctx, server, optional) get Server agents

Get all the agents of the specified Server.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server to query. Optionally you can filter agent name of host or alias of the Agent
optional	*ConfigApiGetAgentsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiGetAgentsOpts struct

Name	Type	Description	Notes

agent | optional.String| Optionally case insensitive agent name filter of host or alias of the Agent. `ctm server:agents::get Server AgentName` returns all agents which names start with `agentname` |

Return type

AgentDetailsList

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllArchiveRules

ArchiveRulesList GetAllArchiveRules(ctx, ) Get all Workload Archiving rules

Get all the Archiving rules

Required Parameters

This endpoint does not need any parameter.

Return type

ArchiveRulesList

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllAuthorizationRoles

[]RoleHeader GetAllAuthorizationRoles(ctx, optional) Get Authorization Roles

Get Authorization Roles

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*ConfigApiGetAllAuthorizationRolesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiGetAllAuthorizationRolesOpts struct

Name	Type	Description	Notes
role	optional.String	The Role name.
description	optional.String	The Role description.

Return type

[]RoleHeader

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllLdapGroups

[]string GetAllLdapGroups(ctx, optional) Get All LDAP groups

Get All LDAP groups

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*ConfigApiGetAllLdapGroupsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiGetAllLdapGroupsOpts struct

Name	Type	Description	Notes
ldap	optional.String	The ldap name.

Return type

[]string

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllRolesAssociatedWithLdap

[]string GetAllRolesAssociatedWithLdap(ctx, ldapgroup, optional) Get Authorization Roles associated with an LDAP group

Get Authorization Roles associated with an LDAP group

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ldapgroup	string	Name of Ldap group
optional	*ConfigApiGetAllRolesAssociatedWithLdapOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiGetAllRolesAssociatedWithLdapOpts struct

Name	Type	Description	Notes

role | optional.String| The Role name. |

Return type

[]string

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllUsers

[]UserHeader GetAllUsers(ctx, optional) Get users

Get users

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*ConfigApiGetAllUsersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiGetAllUsersOpts struct

Name	Type	Description
name	optional.String	The user name.
fullName	optional.String	The user full name.
description	optional.String	The user description.

Return type

[]UserHeader

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetArchiveStatistics

RulesStatisticListSummary GetArchiveStatistics(ctx, ) Get Workload Archiving statistics

Get list of statistical information for each Archiving rule and total information about the number of jobs that have been archived, data size of all job logs and outputs that have been archived, size of the Workload Archiving database including all tables and indexes and percentage of disk space used on the Workload Archiving server

Required Parameters

This endpoint does not need any parameter.

Return type

RulesStatisticListSummary

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExternalUserAuthorizedFolders

[]string GetExternalUserAuthorizedFolders(ctx, name) Get MFT external user authorized folders

Get MFT external user authorized folders

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string	The external user name.

Return type

[]string

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExternalUsers

[]ExternalUserData GetExternalUsers(ctx, optional) Get MFT external users that match the search criteria.

Get MFT external users that match the search criteria.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*ConfigApiGetExternalUsersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiGetExternalUsersOpts struct

Name	Type	Description
name	optional.String	The user name.
email	optional.String	The user email.
description	optional.String	The user description.
company	optional.String	The user company.
phoneNumber	optional.String	The user phoneNumber.

Return type

[]ExternalUserData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetFtsSettings

FtsSettingsData GetFtsSettings(ctx, server, agent) Get File Transfer Server (FTS) configuration data.

Get File Transfer Server (FTS) configuration data.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server
agent	string	The Agent

Return type

FtsSettingsData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetHostgroups

[]string GetHostgroups(ctx, server) get Server hostgroups

Get all the hostgroups of the specified Server.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server the hostgroups belong to.

Return type

[]string

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetHostsInGroup

[]AgentInGroupParams GetHostsInGroup(ctx, server, hostgroup) get hostgroup agents

Get the agents that compose the specified hostgroup

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server the hostgroup belongs to.
hostgroup	string	The hostgroup name

Return type

[]AgentInGroupParams

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetHubStatusDetails

string GetHubStatusDetails(ctx, nodeId) Get hub status.

Get hub status.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
nodeId	string	Node ID of the hub

Return type

string

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMFTFolders

[]FolderPropertiesData GetMFTFolders(ctx, optional) Get MFT virtual folders that match the search criteria.

Get MFT virtual folders that match the search criteria.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*ConfigApiGetMFTFoldersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiGetMFTFoldersOpts struct

Name	Type	Description	Notes
name	optional.String	The virtual folder name.

Return type

[]FolderPropertiesData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMftConfiguration

MftConfigurationData GetMftConfiguration(ctx, server, agent) Get MFT Configuration

Get MFT Configuration

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server
agent	string	The Agent

Return type

MftConfigurationData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMftGateways

[]GatewayData GetMftGateways(ctx, ) Get MFT gateways

Get MFT gateways

Required Parameters

This endpoint does not need any parameter.

Return type

[]GatewayData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMftUserGroups

[]UserGroupPropertiesData GetMftUserGroups(ctx, optional) Get all user groups that match the search criteria.

Get all user groups that match the search criteria.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*ConfigApiGetMftUserGroupsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiGetMftUserGroupsOpts struct

Name	Type	Description
name	optional.String	The user group name.
externalUsers	optional.String	external users.
ldapGroups	optional.String	ldap groups.

Return type

[]UserGroupPropertiesData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPgpTemplates

[]PgpTemplateData GetPgpTemplates(ctx, server, agent, optional) Get PGP Templates

Get PGP Templates

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server
agent	string	The Agent
optional	*ConfigApiGetPgpTemplatesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiGetPgpTemplatesOpts struct

Name	Type	Description	Notes

name | optional.String| The PGP Template Name |

Return type

[]PgpTemplateData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRemoteHostProperties

AddRemoteHostParams GetRemoteHostProperties(ctx, server, remotehost) get a remote host configuration from Server

Get the remote host configuration properties from the Server

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server the remote host is connected to.
remotehost	string	The name of the remote host.

Return type

AddRemoteHostParams

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRemoteHosts

[]string GetRemoteHosts(ctx, server) get Server remote hosts

Get all the remote hosts of the specified Server.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server to query.

Return type

[]string

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRole

RoleData GetRole(ctx, role) Get Authorization Role

Get Authorization Role

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
role	string	The Role name.

Return type

RoleData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRoleAssociates

[]AssociateData GetRoleAssociates(ctx, role) Get all authorization entities associated with role

Get all authorization entities associated with role

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
role	string	role name.

Return type

[]AssociateData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRunAsUser

RunAsUserData GetRunAsUser(ctx, server, agent, user) Get Run-as user

Get Run-as user details from server.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server.
agent	string	The Agent
user	string	The user name

Return type

RunAsUserData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRunAsUsersList

[]RunAsUserData GetRunAsUsersList(ctx, server, optional) Get Run-as user list that match the requested search criteria.

Get Run-as user list that match the requested search criteria from server.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server.
optional	*ConfigApiGetRunAsUsersListOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiGetRunAsUsersListOpts struct

Name	Type	Description	Notes

Return type

[]RunAsUserData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetServerParameters

[]KeyValue GetServerParameters(ctx, server) get Server parameters

Get all the parameters of the specified Server.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server to query.

Return type

[]KeyValue

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetServers

[]CtmDetails GetServers(ctx, ) get all the Servers name and hostname in the system

Get the names and hostnames of all Servers in the system.

Required Parameters

This endpoint does not need any parameter.

Return type

[]CtmDetails

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUser

UserData GetUser(ctx, user) Get user

Get user

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
user	string	The user name.

Return type

UserData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUserEffectiveRights

RoleData GetUserEffectiveRights(ctx, ) Get user real effective authorizations

Get user real effective authorizations by all his roles

Required Parameters

This endpoint does not need any parameter.

Return type

RoleData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetZosTemplates

[]ZosTemplateData GetZosTemplates(ctx, server, agent, optional) Get z/OS Templates

Get z/OS Templates

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server
agent	string	The Agent
optional	*ConfigApiGetZosTemplatesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiGetZosTemplatesOpts struct

Name	Type	Description	Notes

name | optional.String| The z/OS Template Name |

Return type

[]ZosTemplateData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListSecrets

[]string ListSecrets(ctx, ) Get list of secret names

Get the list of names of all the secrets in the vault

Required Parameters

This endpoint does not need any parameter.

Return type

[]string

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PingAgent

SuccessData PingAgent(ctx, server, agent, optional) ping to the agent in the Server

Ping an Agent.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server.
agent	string	The Agent.
optional	*ConfigApiPingAgentOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiPingAgentOpts struct

Name	Type	Description	Notes

body | optional.Interface of PingAgentParams| |

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RecycleItem

SuccessData RecycleItem(ctx, id) recycle item

Recycle an item

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	item data

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveControlmServer

SuccessData RemoveControlmServer(ctx, server) Delete Server

Delete Server

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	Server host name.

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveGateway

SuccessData RemoveGateway(ctx, gatewayName) remove gateway.

remove gateway.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
gatewayName	string	gateway name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveHubFromCluster

SuccessData RemoveHubFromCluster(ctx, agentname) remove hub from cluster.

remove hub from cluster.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
agentname	string	Agent name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveRoleFromUser

SuccessData RemoveRoleFromUser(ctx, user, role) Remove a role from a user

Remove a role from a user

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
user	string	Name of user
role	string	Name of role

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SendArchiveCleanupRequest

SuccessData SendArchiveCleanupRequest(ctx, optional) Deletes data (jobs including outputs and logs) from the Workload Archiving database.

Deletes data (jobs including outputs and logs) by search criteria from the Workload Archiving database.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*ConfigApiSendArchiveCleanupRequestOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiSendArchiveCleanupRequestOpts struct

Name	Type	Description
application	optional.String	Job's application.
applicationExceptions	optional.String	Cleanup should skip job's application that are mentioned in exceptions
subApplication	optional.String	Job's sub application
subApplicationExceptions	optional.String	Job's sub application exception
ctm	optional.String	server name
server	optional.String	Server name
ctmExceptions	optional.String	server exceptions
serverExceptions	optional.String	Server exceptions
folder	optional.String	Job's folder.
folderExceptions	optional.String	Job's folder exceptions
jobname	optional.String	Job's name
jobnameExceptions	optional.String	Job's name exceptions
library	optional.String	Job's library
libraryExceptions	optional.String	Job's library exceptions
ruleName	optional.String	Job's archive rule
jobStatus	optional.String	The job's end status.

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetAgentParameter

KeyValue SetAgentParameter(ctx, body, server, agent, name) set agent parameter

Set the value of the specified parameter in the specified agent.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	Value	The new parameter value.
server	string	The Server the agent is connected to.
agent	string	The name of the agent to update.
name	string	The parameter name.

Return type

KeyValue

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetSystemParam

SuccessData SetSystemParam(ctx, body, name) set value of a an em system parameter

Set value of an enterprise management system parameter

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	Value	Param new value
name	string	Parameter name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Setasprimary

SuccessData Setasprimary(ctx, server) Set secondary server as Primary on a specified Server

Set secondary server as Primary on a specified Server

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TestRunAsUser

SuccessData TestRunAsUser(ctx, server, agent, user, optional) Test existed Run-as user

Test existing Run-as user in server.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
server	string	The Server.
agent	string	The Agent
user	string	The user name
optional	*ConfigApiTestRunAsUserOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiTestRunAsUserOpts struct

Name	Type	Description	Notes

body | optional.Interface of RunAsUserDetailsData| Run as user details data |

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateArchiveRule

SuccessData UpdateArchiveRule(ctx, body, ruleName) Edit Workload Archiving rule

Edit Workload Archiving rule details

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	ArchiveRule	Edit Workload Archiving rule details
ruleName	string	Rule name to update

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateExternalUser

SuccessData UpdateExternalUser(ctx, body, username) Update an external user

Update an external user for b2b

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	ExternalUserData	External user data
username	string	The external user name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateFtsSettings

SuccessData UpdateFtsSettings(ctx, body, server, agent) Update File Transfer Server (FTS) configuration data.

Update File Transfer Server (FTS) configuration data.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	FtsSettingsData	File Transfer Server (FTS) configuration data
server	string	The Server
agent	string	The Agent

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateHostsInHostgroup

SuccessData UpdateHostsInHostgroup(ctx, body, server, hostgroup) update agents in hostgroup.

update agents in hostgroup.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	HostgroupProperties	Agent list to update in a hostgroup
server	string	The Server the agent is connected to.
hostgroup	string	The hostgroup name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateMFTFolder

SuccessData UpdateMFTFolder(ctx, body, folderName) Update an existing virtual folder in MFT.

Update an existing virtual folder in MFT.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	FolderPropertiesData	virtual folder data
folderName	string	Name of folder

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateMftConfiguration

SuccessData UpdateMftConfiguration(ctx, body, server, agent) Update MFT Configuration

Update MFT Configuration

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	MftConfigurationData	MFT Configuration Data
server	string	The Server
agent	string	The Agent

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateMftUserGroup

SuccessData UpdateMftUserGroup(ctx, body, name) Update user group.

Update user group.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	UserGroupDetailsData	User group details
name	string	User group name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdatePgpTemplate

SuccessData UpdatePgpTemplate(ctx, body, server, agent, templateName) Update PGP Template

Update PGP Template

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	PgpTemplateData	PGP Template Data
server	string	The Server
agent	string	The Agent
templateName	string	The PGP Template Name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateRole

SuccessData UpdateRole(ctx, roleFile, role) Update Authorization Role

Update Authorization Role

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
roleFile	os.Fileos.File
role	string	The Role name.

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateRunAsUser

SuccessData UpdateRunAsUser(ctx, body, server, agent, user) Update Run-as user

Update Run-as user details in server.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	RunAsUserDetailsData	Run as user details data
server	string	The Server.
agent	string	The Agent
user	string	The user name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateSecret

SuccessData UpdateSecret(ctx, name, optional) Update an existing secret

Update an existing secret in the secrets vault.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string	The name of the secret to update
optional	*ConfigApiUpdateSecretOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ConfigApiUpdateSecretOpts struct

Name	Type	Description	Notes

body | optional.Interface of SecretValue| The new value for the secret |

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateUser

SuccessData UpdateUser(ctx, userFile, user) Update user

Update user

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userFile	os.Fileos.File
user	string	The user name.

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateZosTemplate

SuccessData UpdateZosTemplate(ctx, body, server, agent, templateName) Update z/OS Template

Update z/OS Template

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	ZosTemplateData	z/OS Template Data
server	string	The Server
agent	string	The Agent
templateName	string	The z/OS Template Name

Return type

SuccessData

Authorization

Bearer

HTTP request headers

Content-Type: /
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ConfigApi.md

Latest commit

History

ConfigApi.md

File metadata and controls

{{classname}}

AddArchiveRule

Required Parameters

Return type

Authorization

HTTP request headers

AddExternalUser

Required Parameters

Return type

Authorization

HTTP request headers

AddExternalUserOrUserGroupToMFTFolder

Required Parameters

Return type

Authorization

HTTP request headers

AddGateway

Required Parameters

Return type

Authorization

HTTP request headers

AddHostToHostgroup

Required Parameters

Return type

Authorization

HTTP request headers

AddHubToCluster

Required Parameters

Return type

Authorization

HTTP request headers

AddMFTFolder

Required Parameters

Return type

Authorization

HTTP request headers

AddMftUserGroup

Required Parameters

Return type

Authorization

HTTP request headers

AddPgpTemplate

Required Parameters

Return type

Authorization

HTTP request headers

AddRemoteHost

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

AddRole

Required Parameters

Return type

Authorization

HTTP request headers

AddRoleToLdapGroup

Required Parameters

Return type

Authorization

HTTP request headers

AddRoleToUser

Required Parameters

Return type

Authorization

HTTP request headers

AddSecret

Required Parameters

Return type

Authorization

HTTP request headers

AddServer

Required Parameters