Config service

The config service allows you to configure the Control-M environment:

• Configuring the major components of the Control-M environment
• Configuring Authorizations
• Configuring Job Archiving
• Configuring file transfers to and from external users
• Configuring Secrets

Configuring the major components of the Control-M environment

Using the Config service, you can access, update, and add configuration data for the major components of the Control-M environment. For example, you can list available Control-M/Servers, add Control-M/Agents, manage remote hosts and host groups, manage "run as" users, and set several Control-M/EM parameters.

config server::add

Add a Control-M/Server to a Control-M environment (the Control-M/Server will be registered on the Control-M/Enterprise Manager).

To verify the Control-M/Server is up and running, run the config servers::get command to check the status of the Control-M/Server.

ctm config server::add <host> <ctm> <id> [port]

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

host=`hostname`
id=123
ctm=myserver
port=2369
 
curl -X POST $endpoint/config/server/ -H 'accept: application/json' -H 'authorization: Bearer &token' -H 'content-type: 
application/json' -d '{"host": "host": "$host","id": "$id","ctm": "$ctm","port": $port}'

config server::delete

Deletes a Control-M/Server from the Control-M environment (the Control-M/Server will be un-registered from the Control-M/Enterprise Manager).

ctm config server::delete <ctm> 

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

endpoint=https://<controlm>:8443/automation-api
token=
ctm= 
curl -X DELETE -H "Authorization: Bearer $token" "$endpoint/config/server/$ctm"

config servers::get

Returns a list of Control-M/Servers. 

CLI Syntax

ctm config servers::get

REST API Syntax

See REST API reference.

Example using  curl:

curl -H "Authorization: Bearer $token" "$endpoint/config/servers"

Response

The following example shows the parameters in the config servers::get response. In this example, the operational state of the Control-M/Server is up and connected.

  {
    "name": "controlm",
    "host": "myhost",
    "state": "Up",
    "message": "Connected",
    "version": "9.0.20.000"
  }

Where:

config server::failover

The failover command enables you to perform a manual failover of a Control-M/Server to a secondary host, provided that High Avilability (HA) is set up for this server.

For more information, see the section about High Availability in the Control-M Administrator Guide in the Control-M Online Help.

CLI Syntax

ctm config server::failover <ctm> 

Where <ctm> is the name of the Control-M/Server.

If annotation is enabled for the High availability category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
curl -H "Authorization: Bearer $token" -X PUT "$endpoint/config/server/$ctm/failover" 

config server::setasprimary

The setasprimary command enables you to set a secondary server as the primary Control-M/Server.

Use this command only after performing a successful manual failover on the server that functioned as the primary server until now. You must have High Availability (HA) set up for these servers.

For more information, see the section about High Availability in the Control-M Administrator Guide in the Control-M Online Help.

CLI Syntax

ctm config server::setasprimary <ctm> 

Where <ctm> is the name of the Control-M/Server.

If annotation is enabled for the High availability category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
curl -H "Authorization: Bearer $token" -X PUT "$endpoint/config/server/$ctm/setasprimary" 

config server:remotehost::add

The remotehost add command enables you to add a remote host to a Control-M/Server. 

CLI Syntax

ctm config server:remotehost::add <ctm> <remotehost> [port] [-f <configuration file>]

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

The following is a list of the additional parameters that can be used in the configuration file:

{
    "remotehost" : "xx", 
    "port" : 22,
    "agents": [
        "<local>"
    ],
    "encryptAlgorithm": "BLOWFISH",
    "compression": "false",
    "authorize": "true"
}

Where:

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
remotehost=myhost
agent=realAgent
curl -H "Authorization: Bearer $token" -H "Content-Type: application/json" -X POST 
-d "{\"agents\": [ \"$agent\" ], \"compression\": true, \"encryptAlgorithm\": \"BLOWFISH\"}" 
"$endpoint/config/server/$ctm/remotehost/$remotehost?port=22"

config server:remotehost::authorize

The remotehost authorize command enables you to add the machine to the SSH remote host authorization list (if this was not already done when the machine was added to the Control-M/Server).

CLI Syntax

ctm config server:remotehost::authorize <ctm> <remotehost>

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
remotehost=myhost
curl -H "Authorization: Bearer %token%" -H "Content-Type: application/json" -X POST 
"%endpoint%/config/server/$ctm/remotehost/$remotehost/authorize"

config server:remotehost::delete

Deletes a remote host from the Control-M/Server. 

CLI Syntax

ctm config server:remotehost::delete <ctm> <remotehost>

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
remotehost=myhost
curl -H "Authorization: Bearer $token" -X DELETE "$endpoint/config/server/$ctm/remotehost/$remotehost"

config server:remotehosts::get

Returns a list of all remote hosts registered to the Control-M/Server. 

CLI Syntax

ctm config server:remotehosts::get <ctm>

Where:

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm 
curl -H "Authorization: Bearer $token" "$endpoint/config/server/$ctm/remotehosts"

config server:remotehost::get

Returns the remote host configuration properties from the Control-M/Server. 

CLI Syntax

ctm config server:remotehost::get <ctm> <remotehost>

Where:

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
remotehost=myhost
curl -H "Authorization: Bearer $token" "$endpoint/config/server/$ctm/remotehost/$remotehost"

config server:agent::add

Adds a Control-M/Agent to a specific Control-M/Server. This allows the Control-M/Server to run jobs on this host where the Agent is installed. Also, it verifies the connectivity between the Control-M/Server and the Control-M/Agent.

CLI Syntax

ctm config server:agent::add <ctm> <host> <port> [tag] [-f <configuration file>]

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

The following is a list of the additional parameters that can be used in the configuration file:

{    
	"persistentConnection": true,
    "sslState": "Enabled",
    "tag": "abc_12345"
} 

Where:

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
host=myhost
port=7006

curl -H "Authorization: Bearer $token" -H "Content-Type: application/json" 
-X POST -d "{\"host\":\"$host\",\"port\":\"$port\",\"tag\":\"abc_12345\",\"sslState\":\"Default\"}" 
"$endpoint/config/server/$ctm/agent"

config server:agent::delete

Deletes a Control-M/Agent from the Control-M/Server database. This removes the Control-M/Agent from a Control-M/Server without shutting the Agent down.

CLI Syntax

ctm config server:agent::delete <ctm> <agent>

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
agent=myhost
curl -H "Authorization: Bearer $token" -X DELETE "$endpoint/config/server/$ctm/agent/$agent"

config server:agent:params::get

Get system parameters of a Control-M/ Agent registered to a Control-M/Server. Returns a list of Agent-related system parameters. Each entry is a pair which consists of parameter name and value. 

CLI Syntax

ctm config server:agent:params::get <ctm> <agent>

Where:

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
agent=host
curl -H "Authorization: Bearer $token" "$endpoint/config/server/$ctm/agent/$agent/params"

config server:agent:param::set

Set the value of a specific Agent-related system parameter.

CLI Syntax

ctm config server:agent:param::set <ctm> <agent> <name> <value>

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
agent=quickstart
name=LIMIT_LOG_VERSIONS
value=10
curl -H "Authorization: Bearer $token" -H "Content-Type: application/json" -X POST -d "{\"value\":\"$value\"}" "$endpoint/config/server/$ctm/agent/$agent/param/$name"

config server:agent::ping

Checks if the Control-M/Agent is available.

ctm config server:agent::ping <ctm> <agent> [-f <configuration file>]

Where:

The following is a list of the additional parameters that can be used in the configuration file:

{     "discover": true,"timeout":60}

Where:

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
agent=quickstart
curl -X POST -H "Authorization: Bearer $token"  -H "Content-Type: application/json" -d "{\"discover\": false, \"timeout\":60}" "$endpoint/config/server/$ctm/agent/$agent/ping"

config server:agents::get

Returns a list of all Control-M/Agents registered to the Control-M/Server and the state of each agent. You can optionally filter the list for Agents that match a specific pattern.

The states supported are:   

• Available

• Unavailable

• Disabled

• Discovering

CLI Syntax

ctm config server:agents::get <ctm> ["<agent_pattern>"]

Where:

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm 
curl -H "Authorization: Bearer $token" "$endpoint/config/server/$ctm/agents?agent=Agent*1*"

config server:agent::disable

Disables Control-M/Agent from Control-M/Server. New jobs cannot run on the Control-M/Agent.

CLI Syntax

ctm config server:agent::disable <ctm> <agent>

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

curl -X POST -H "Authorization: Bearer $token" "$endpoint/config/server/$ctm/agent/$agent/disable"

config server:agent::enable

Enables jobs to run on the Control-M/Agent. 

CLI Syntax

ctm config server:agent::enable <ctm> <agent>

Where:

REST API Syntax

See REST API reference.

Example using  curl:

curl -X POST -H "Authorization: Bearer $token" "$endpoint/config/server/$ctm/agent/$agent/enable"

config server:agent:crt:expiration::get

9.0.20.000 Returns the expiration date of an SSL certificate from an SSL-configured Control-M/Agent. The date is returned exactly as it appears in the certificate.

This feature is offered in an environment with Control-M 9.0.20 or later.

For information about using this API command in a script to automate certificate updates, see Automating SSL certificate updates on Control-M/Agents.

CLI Syntax

ctm config server:agent:crt:expiration::get <ctm> <agent>

Where:

REST API Syntax

See REST API reference.

Example using  curl:

curl -H "Authorization: Bearer $token" "$endpoint/config/server/$ctm/agent/$agent/crt/expiration"

config server:agent:csr::create

9.0.20.000 Creates a Certificate Signing Request (CSR) for an SSL-configured Control-M/Agent. 

This feature is offered in an environment with Control-M 9.0.20 or later.

For information about using this API command in a script to automate certificate updates, see Automating SSL certificate updates on Control-M/Agents.

CLI Syntax

ctm config server:agent:csr::create <ctm> <agent> -f <configuration file>

Where:

{
        "organization": "example_organization",
        "organizationUnit": "example_unit",
        "cityLocality": "example_city",
        "stateProvince": "example_state",
        "country": "CO",
        "emailAddress": "admin@example.com"
}

Tip: To save the CSR output (a block of encoded text) in a file, you can append the following to the end of the CLI command:  > fileName

REST API Syntax

See REST API reference.

Example using  curl:

curl -X POST -H "Authorization: Bearer $token" -H "Content-Type: application/json" 
--data "@examples\configuration.json"  "$endpoint/config/server/$ctm/agent/$agent/csr"

Tip: To save the output in a CSR file, you can append the following to the end of the command:

-o $file_path$file_name

config server:agent:crt::deploy

9.0.20.000 Deploy a signed certificate to an SSL-configured Control-M/Agent. The new certificate that you deploy replaces the existing certificate.

Note: For the new certificate to take effect after the deployment, recycle the Control-M/Agent. If the new certificate was signed by a new CA, ensure that this CA is recognized also by the Control-M/Server.

This feature is offered in an environment with Control-M 9.0.20 or later.

For information about using this API command in a script to automate certificate updates, see Automating SSL certificate updates on Control-M/Agents.

CLI Syntax

ctm config server:agent:crt::deploy <ctm> <agent> <crt_filepath> <ca_chain_filepath>

Where:

REST API Syntax

See REST API reference.

Example using  curl:

curl -X POST -H "Authorization: Bearer $token" -F "crtFile=@examples/crt.pem" 
-F "caChainFile=@examples/ca_chain.pem" "$endpoint/config/server/$ctm/agent/$agent/crt"

config server:hostgroups::get

Returns a list of host groups defined in the Control-M/Server. Each entry is a host group name.

CLI Syntax

ctm config server:hostgroups::get <ctm>

Where:

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm 
curl -H "Authorization: Bearer $token" "$endpoint/config/server/$ctm/hostgroups"

config server:hostgroup:agents::get

Returns a list of agents of a host group. Each entry is the logical name of an Agent.

CLI Syntax

ctm config server:hostgroup:agents::get <ctm> <hostgroup>

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
hostgroup=HostGroup1 
curl -H "Authorization: Bearer $token" "$endpoint/config/server/$ctm/hostgroup/$hostgroup/agents"

config server:hostgroup:agent::add

Adds a Control-M/Agent to a host group and creates the host group if it does not exist.

CLI Syntax

ctm config server:hostgroup:agent::add <ctm> <hostgroup> <host> [-f <configuration file>]

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

The following is a list of the additional parameters that can be used in the configuration file:

{  
   "host":"agent3",
   "hostgroupAgentParticipation":{  
      "event":"agent3Cond",
      "orderDate":"AnyDate"
   }
}

Where:

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
hostgroup=mygroup 
host=myhost
curl -H "Authorization: Bearer $token" -H "Content-Type: application/json" -X POST -d  "{\"host\":  \"$host\",  \"hostgroupAgentParticipation\":{ \"event\": \"agent3Cond\", \"orderDate\": \"AnyDate\"}}" "$endpoint/config/server/$ctm/hostgroup/$hostgroup/agent"

config server:hostgroup:agent::delete

Removes a Control-M/Agent from a hostgroup. If the group is empty after the deletion, it is also deleted.

CLI Syntax

ctm config server:hostgroup:agent::delete <ctm> <hostgroup> <host>

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
hostgroup=mygroup 
host=myhost
curl -H "Authorization: Bearer $token" -X DELETE "$endpoint/config/server/$ctm/hostgroup/$hostgroup/agent/$host"

config server:runasuser::add

Adds a new user to the list of users that are available for running jobs on an Agent. Whenever you define a job, you can choose a "run as" user from the list of predefined users.

CLI Syntax

ctm config server:runasuser::add <ctm> <agent> <user> [password] [-f <configuration file>]

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

Content of configuration file

The following example configuration file contains a password in plain text.

{
  "password": "pass1"
} 

The following example configuration file contains the name of a predefined secret instead of a password.

{
  "password": "Secret:topSecretPassword"
} 

The following example configuration file contains key authentication details for an SSH connection. In this example, the passphrase is specified as a predefined secret. 

{
  "key": {
    "keyname": "keyName",
    "passphrase": "Secret:topSecretPassphrase"
  }
}

REST API Syntax

See REST API reference.

In the following curl example, note that the path to the configuration file is prefixed with an @ character.

ctm=controlm
curl -H "Authorization: Bearer $token" 
-H "Content-Type: application/json" --data "@runasUserDefinition.json" 
-X POST "$endpoint/config/server/$ctm/runasuser"

When using a REST API command to add a "run as" user, the configuration file must contain full user credentials, including the Agent and user name, as shown in the following example. In this example, authentication details are for an SSH connection to a remote host (based on a key and passphrase).

{
  "user": "user1",
  "agent": "All",
  "key": {
    "keyname": "keyName",
    "passphrase": "passphrase1"
  }
}

config server:runasuser::get

Retrieves the details of a specific "run as" user. You can use this command to verify that a certain user exists in the list of defined users. Each "run as" user is uniquely identified by its combination of agent and user name.

CLI Syntax

ctm config server:runasuser::get <ctm> <agent> <user>

Where:

REST API Syntax

See REST API reference.

Example using curl:

ctm=controlm
curl -H "Authorization: Bearer $token" 
$endpoint/config/server/$ctm/runasuser/realAgent/user1

config server:runasuser::update

Updates the authentication parameters of an existing "run as" user. Each "run as" user is uniquely identified by its combination of agent and user name.

CLI Syntax

ctm config server:runasuser::update <ctm> <agent> <user> [password] [-f <configuration file>]

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

The REST API command specifies the Agent and user, and the configuration file contains only the authentication details (either a password or a key and passphrase). In the following curl example, note that the path to the configuration file is prefixed with an @ character. 

ctm=controlm
curl -H "Authorization: Bearer $token" 
-H "Content-Type: application/json" --data "@runasUserDefinition.json" 
-X POST "$endpoint/config/server/$ctm/runasuser/realAgent/user1"

config server:runasuser::delete

Deletes a "run as" user from the list of users that are available for running jobs on an Agent. Each "run as" user is uniquely identified by its combination of agent and user name.

CLI Syntax

ctm config server:runasuser::delete <ctm> <agent> <user>

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
curl -H "Authorization: Bearer $token" 
-X DELETE $endpoint/config/server/$ctm/runasuser/realAgent/user1

config server:runasuser::test

Tests the connection for a "run as" user that you specify. You can use this command in the following ways:

• Specify the Agent and user name in the command line, but do not specify authentication credentials. This is especially useful for verifying the validity of the credentials of a defined "run as" user before updating the user's authentication parameters.
• Specify also the password in the command line or specify authentication details in a configuration file. This is especially useful for verifying the validity and connectivity of a user before adding the user to the list of "run as" users.
  

CLI Syntax

ctm config server:runasuser::test <ctm> <agent> <user> [password] [-f <configuration file>]

Where:

REST API Syntax

See REST API reference.

Examples using curl:

• Example for testing an existing user:

  ctm=controlm
  curl -H "Authorization: Bearer $token" 
  -H "Content-Type: application/json" --data "{}"  
  -X POST $endpoint/config/server/$ctm/runasuser/realAgent/user1/test

  For this test, a configuration file is not necessary, because authentication details are not required.

• Example for testing a user that has not yet been added:

  ctm=controlm
  curl -H "Authorization: Bearer $token" 										
  -H "Content-Type: application/json" --data "@runasUserDefinition.json"
  -X POST "$endpoint/config/server/$ctm/runasuser/realAgent/user1/test  

  For this test, the REST API command specifies the Agent and user, and the configuration file contains only the authentication details (either a password or a key and passphrase). T he path to the configuration file is prefixed with an @ character.

config server:runasusers::get

Retrieves details about all "run as" users that match a specified search criteria.

CLI Syntax

ctm config server:runasusers::get <ctm> [-s <query string>] 

Where:

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm
curl -H "Authorization: Bearer $token" "$endpoint/config/server/$ctm/runasusers?agent=agent1&user=user1"

config server:params::get

Returns a list of parameters of a Control-M/Server. The following fields are returned:

• name
• value
• defaultValue

CLI Syntax

ctm config server:params::get <ctm>

Where:

REST API Syntax

See REST API reference.

Example using  curl:

ctm=controlm 
curl -H "Authorization: Bearer $token" "$endpoint/config/server/$ctm/params"

config em:param::set

Set the value of a Control-M/Enterprise Manager system parameter. Supports only a select group of system parameters. The user can set this value only if they have permissions to that specific environment.

CLI Syntax

ctm config em:param::set <paramName> <value>

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

paramName=api_key
value=true
curl -H "Authorization: Bearer $token" -X POST -d "{\"value\":\"$value\"}" "$endpoint/config/em/param/$paramName"

config item::recycle

9.0.19.120 Recycles a specific Control-M component. Use this command to restart a component to solve server issues. Currently, this command supports only the recycling of Control-M/Agents.

CLI Syntax

ctm config item::recycle <id>

Where:

REST API Syntax

See REST API reference.

Example using  curl:

id="CTMS:Agent:controlm:myAgent"
curl -H "Authorization: Bearer $token" -X POST "$endpoint/config/item/$id/recycle"

_{Back to top}

Configuring Authorizations

Config authorization enables you to manage the authorizations of users, roles, and LDAP groups, limiting their access to various Control-M entities and actions.

Configuration of authorizations is available in a Control-M environment with Control-M/Enterprise Manager version 9.0.19.000 or later.

The following table summarizes the actions that you can take for each authorization entity:

config authorization:role::add

Creates a new role based on role settings that you define through a role data file.

CLI Syntax

ctm config authorization:role::add <roleFile>

Where <roleFile> is the full path and name of a .json payload file that contains role definitions, as described in Role data for authorization configuration.

If annotation is enabled for the Account management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using curl:

curl -H "Authorization: Bearer $token" -F "roleFile=@roleDefinition.json"
-X POST $endpoint/config/authorization/role

config authorization:role::get

Retrieves the details of an existing role, as defined in the role data file.

Note: Only parameters that are set to non-default values are retrieved and displayed in the output.

CLI Syntax

ctm config authorization:role::get <role>

Where <role> is the name of the role.

REST API Syntax

See REST API reference.

Example using curl:

roleName=myRole
curl -H "Authorization: Bearer $token" 
"$endpoint/config/authorization/role/$roleName"

config authorization:role::update

Updates the definitions of an existing role based on role settings that you define through a role data file.

CLI Syntax

ctm config authorization:role::update <role> <roleFile>

Where:

If annotation is enabled for the Account management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using curl:

roleName=myRole
curl -H "Authorization: Bearer $token" -F "roleFile=@roleDefinition.json" 
-X POST "$endpoint/config/authorization/role/$roleName"

config authorization:role::delete

Deletes an existing role and disassociates all users who were associated with the role.

CLI Syntax

ctm config authorization:role::delete <role>

Where <role> is the name of the role.

If annotation is enabled for the Account management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using curl:

roleName=myRole
curl -H "Authorization: Bearer $token" -X DELETE "$endpoint/config/authorization/role/$roleName"

config authorization:roles::get

Retrieves a list of names of configured roles.

CLI Syntax

ctm config authorization:roles::get [-s <search query>]

The optional -s switch can be used to filter for roles by role name or description (or both). The format for the query string is "field1=criteria1&field2=criteria2", according to the following guidelines:

REST API Syntax

See REST API reference.

Example using curl:

roleName=Adm*
curl -H "Authorization: Bearer $token"
$endpoint/config/authorization/roles?role=$roleName

config authorization:user::add

Creates a new user based on user settings that you define through a user data file.

CLI Syntax

ctm config authorization:user::add <userFile>

Where <userFile> is the full path and name of a .json payload file that contains user definitions, as described in User data for authorization configuration .

If annotation is enabled for the Account management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using curl:

curl -H "Authorization: Bearer $token" -F "userFile=@userDefinition.json"
-X POST $endpoint/config/authorization/user

config authorization:user::get

Retrieves the details of an existing user, as defined in the user data file.

Note:

• Only parameters that are set to non-default values are retrieved and displayed in the output.
• For security reasons, the user's password is returned as KEEP_EXISTING. When you use the output from this command to prepare a user data file (a .json file) for the Update command, you can keep this value in the user data file.

CLI Syntax

ctm config authorization:user::get <user>

Where <user> is the name of the user.

REST API Syntax

See REST API reference.

Example using curl:

userName=myUser
curl -H "Authorization: Bearer $token" 
"$endpoint/config/authorization/user/$userName"

config authorization:user::update

Updates the definitions of an existing user based on user settings that you define through a user data file.

CLI Syntax

ctm config authorization:user::update <user> <userFile>

Where:

If annotation is enabled for the Account management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using curl:

userName=myuser
curl -H "Authorization: Bearer $token" -F "userFile=@userDefinition.json" 
-X POST "$endpoint/config/authorization/user/$userName"

config authorization:user::delete

Deletes an existing user and disassociates it from all roles with which it was associated.

CLI Syntax

ctm config authorization:user::delete <user>

Where <user> is the name of the user.

If annotation is enabled for the Account management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using curl:

userName=myuser
curl -H "Authorization: Bearer $token" -X DELETE "$endpoint/config/authorization/user/$userName"

config authorization:users::get

Retrieves a list of names of configured users.

CLI Syntax

ctm config authorization:users::get [-s <search query>]

The optional -s switch can be used to filter for users by user name, full name of user, or description (or any combination of these fields). The format for the query string is "field1=criteria1&field2=criteria2", according to the following guidelines:

REST API Syntax

See REST API reference.

Example using curl:

userName=emuser*
curl -H "Authorization: Bearer $token"
$endpoint/config/authorization/users?name=$userName

config authorization:user:role::add

Assigns a role to a user.

CLI Syntax

ctm config authorization:user:role::add <user> <role>

Where:

REST API Syntax

See REST API reference.

Example using curl:

userName=myuser
roleName=myRole
curl -H "Authorization: Bearer $token" -H "Content-Type: application/json" 
-X POST "$endpoint/config/authorization/user/$userName/role/$roleName"

config authorization:user:role::delete

Removes a role from a user.

CLI Syntax

ctm config authorization:user:role::delete <user> <role>

Where:

REST API Syntax

See REST API reference.

Example using curl:

userName=myuser
roleName=myRole
curl -H "Authorization: Bearer $token" -H "Content-Type: application/json" 
-X DELETE "$endpoint/config/authorization/user/$userName/role/$roleName"

config user:password::adminUpdate

Changes the password for a user.

CLI Syntax

ctm config user:password::adminUpdate <user> [newPassword] [-p]

Where:

The newPassword parameter is optional because you can, alternatively, use the -p (or -prompt) option through the CLI. With this option, you do not need to enter the password in the command. Instead, you are prompted for the password (twice) after you enter the command. Note that if you use both the newPassword parameter and the -p option, the password that you enter through the command prompt overrides the password that you specify in the command.

REST API Syntax

See REST API reference.

When using a REST API command, you must provide the password (or secret) in a payload .json file. In the following curl example, note that the path to the payload file is prefixed with an @ character.

userName=myuser
curl -H "Authorization: Bearer $token" -H "Content-Type: application/json" 
-d "@c:\tmp\data.json" -X POST "$endpoint/config/user/$userName/password/adminUpdate"

Here is an example of the contents of a payload .json file, with the password specified as a predefined secret :

{
   "newPassword":"Secret:secretKey"
}

config authorization:ldap:role::add

Adds a role to an LDAP group, so that any user in the LDAP group will inherit the permissions and authorizations defined for the role.

CLI Syntax

ctm config authorization:ldap:role::add <ldapGroup> <role>

Where:

REST API Syntax

See REST API reference.

Example using curl:

roleName=myRole
ldapGroup=myGroup
curl -H "Authorization: Bearer $token" -H "Content-Type: application/json" 
-X POST "$endpoint/config/authorization/ldap/$ldapGroup/role/$roleName"

config authorization:ldap:role::delete

Deletes a role from an LDAP group.

CLI Syntax

ctm config authorization:ldap:role::delete <ldapGroup> <role>

Where:

REST API Syntax

See REST API reference.

Example using curl:

roleName=myRole
ldapGroup=myGroup
curl -H "Authorization: Bearer $token" -H "Content-Type: application/json" 
-X DELETE "$endpoint/config/authorization/ldap/$ldapGroup/role/$roleName"

config authorization:ldap:roles::get

Retrieves a list of roles that are associated with a specific LDAP group.

CLI Syntax

ctm config authorization:ldap:roles::get <ldapGroup> [-s "role=<query pattern>"]

Where:

REST API Syntax

See REST API reference.

Example using curl:

roleName=myRole
ldapGroup=myGroup
curl -H "Authorization: Bearer $token"
$endpoint/config/authorization/ldap/$ldapGroup/roles?role=$roleName

config authorization:role:associates

Retrieves a list of all users and LDAP groups to which a specific role is associated.

CLI Syntax

ctm config authorization:role:associates <role>

Where <role> is the name of the role.

REST API Syntax

See REST API reference.

Example using curl:

roleName=myRole
curl -H "Authorization: Bearer $token"
$endpoint/config/authorization/role/$roleName/associates

Configuring Job Archiving

9.0.20.000 Config archive enables you to manage the setup of Job Archiving, as provided by the Control-M Workload Archiving add-on. Config archive enables you to manage the rules in Workload Archiving policies, as well as to delete accumulated data from the Workload Archiving server. This feature is offered in an environment with Control-M 9.0.20 or later.

For information about searching and retrieving archived data after performing the setup, see Archive service.

config archive:rules::get

Retrieves details of all defined Workload Archiving policy rules.

The output is returned in JSON format. You can use this output as a template for your own Archive Rule files when creating new rules or editing existing rules. For more information about the syntax of Workload Archiving policy rules, see Job Archiving configuration.

CLI Syntax

ctm config archive:rules::get

REST API Syntax

See REST API reference.

Example using curl:

curl -H "Authorization: Bearer $token" $endpoint/config/archive/rules

config archive:statistics::get

Retrieves statistics regarding job archiving for all defined Workload Archiving policy rules.

CLI Syntax

ctm config archive:statistics::get

REST API Syntax

See REST API reference.

Example using curl:

curl -H "Authorization: Bearer $token" $endpoint/config/archive/statistics

Response

The following example shows the job archiving statistics that are returned when only one rule is defined:

{
  "rulesStatisticList": {
    "ruleStatistics": [
      {
        "ruleName": "Collect all DS jobs",
        "retention": 1,
        "retentionType": "Year",
        "oldestItem": "2019-01-28 12:29:01 PM",
        "newestItem": "2019-02-08 07:00:11 AM",
        "totalJobs": 30,
        "dataSize": "1 MB"
      }
    ]
  },
  "summary": {
    "totalNumberOfJobs": 30,
    "totalDataSize": "1 MB",
    "actualDbSize": "9 MB",
    "diskUsage": "37%"
  }
}

config archive:rule::add

Creates a new Workload Archiving policy rule based on rule settings that you define through an Archive Rule file.

CLI Syntax

ctm config archive:rule::add -f <archiveRule>

Where <archiveRule> is the full path and name of a .json payload file that contains definitions for the rule, as described in Job Archiving configuration.

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using curl:

curl -H "Authorization: Bearer $token" 
-X POST -H "Content-Type: application/json" 
-d @ruleDefinition.json "$endpoint/config/archive/rule"

config archive:rule::update

Updates the definitions of an existing Workload Archiving policy rule based on rule settings that you define through an Archive Rule file.

CLI Syntax

ctm config archive:rule::update <ruleName> [-f <archiveRule>]

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using curl:

ruleName=rule5
curl -H "Authorization: Bearer $token"
-X POST -H "Content-Type: application/json" 
-d @ruleDefinition.json "$endpoint/config/archive/rule/$ruleName"

config archive:rule::delete

Deletes an existing Workload Archiving policy rule.

CLI Syntax

ctm config archive:rule::delete <ruleName> <deleteRuleDataFlag>

Where:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using curl:

ruleName=rule5
curl -H "Authorization: Bearer $token" -X DELETE "$endpoint/config/archive/rule/$ruleName?deleteRuleDataFlag=deleteRuleWithoutData"

config archive::cleanup

Enables you to delete job data (including job output and job logs) that has accumulated in the Workload Archiving server, based on search criteria that you specify.

CLI Syntax

ctm config archive::cleanup -s <search query>

-s  is used to run a search using the query string format "field1=criteria1&field2=criteria2&field3=criteria3".

The following fields are available for use in the search query:

If annotation is enabled for the Configuration management category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using curl:

curl -H "Authorization: Bearer $token" -X DELETE
"$endpoint/config/archive/cleanup?jobname=jobA*&jobnameExceptions=jobABC*&application=B*"

Configuring file transfers to and from external users

9.0.20.000 Config mft enables you to manage the setup of your integration with Control-M Managed File Transfer (MFT) Enterprise B2B, to enable file transfers to and from external users outside of your organization (such as business partners). This feature is offered in an environment with Control-M 9.0.20 or later.

Control-M MFT Enterprise B2B uses the following major objects in file transfers to and from external users:

• Hub
• Gateway
• Virtual folders
• External users
• User groups

The following table lists the actions that you can perform through Control-M Automation API to set up the required objects.

config mft:hub:status::get

Retrieves the current status of the MFT Enterprise B2B Hub, along with some basic information about the Hub (including details of the communication protocols used by the Hub and details regarding the associated gateways).

The Hub is the File Transfer Server that is installed with Control-M MFT, with added settings that enable it to manage external file transfers. In addition to the internal users that have access to the File Transfer Server, the Hub allows access also to external users.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:hub:status::get <nodeId>

Where <nodeId> is the ID of the host agent of the Hub.

REST API Syntax

See REST API reference.

Example using curl:

nodeId=abc-12-34
curl -H "Authorization: Bearer $token" $endpoint/config/mft/hub/$nodeId/status

config mft:cluster:hub::add

Adds a Hub to a cluster in a High Availability (HA) environment.

The Hub is the File Transfer Server that is installed with Control-M MFT, with added settings that enable it to manage external file transfers. In addition to the internal users that have access to the File Transfer Server, the Hub allows access also to external users.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:cluster:hub::add <agentname>

Where <agentname> is the name of the host that you want to add to the cluster, a host with a Control-M/Agent and Control-M MFT installed.

REST API Syntax

See REST API reference.

Example using curl:

agentname=myhost
curl -H "Authorization: Bearer $token" -X POST "$endpoint/config/mft/cluster/hub/$agentname"

config mft:cluster:hub::delete

Removes a Hub from a cluster in a High Availability (HA) environment.

CLI Syntax

ctm config mft:cluster:hub::delete <agentname>

Where <agentname> is the name of the host (with a Control-M/Agent) that you want to remove from the cluster.

REST API Syntax

See REST API reference.

Example using curl:

agentname=myhost
curl -H "Authorization: Bearer $token" -X DELETE "$endpoint/config/mft/cluster/hub/$agentname"

config mft:gateway::add

Adds a Control-M MFT Enterprise B2B Gateway.

The MFT Enterprise B2B Gateway is a proxy server that is installed on Linux in the DMZ. It listens for incoming connections from external user accounts defined in the MFT B2B Hub. The MFT Enterprise B2B Gateway communicates with the Hub, but does not store any transfer file data.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:gateway::add <gatewayHost> <port>

Where <gatewayHost> is the name of the gateway host, and <port> is the number of the port that the gateway listens to (default: 9443).

REST API Syntax

See REST API reference.

Example using curl:

curl -H "Authorization: Bearer $token" -X POST "$endpoint/config/mft/gateway/$gatewayHost/$port"

config mft:gateway::delete

Removes a Control-M MFT Enterprise B2B Gateway.

CLI Syntax

ctm config mft:gateway::delete <gatewayHost>

Where <gatewayHost> is the name of the host of the gateway that you want to delete.

REST API Syntax

See REST API reference.

Example using curl:

gatewayHost=myhost
curl -H "Authorization: Bearer $token" -X DELETE "$endpoint/config/mft/gateway/$gatewayHost"

config mft:gateways::get

Retrieves the details of all installed MFT Enterprise B2B Gateways. Details for each gateway include the gateway host, port, status (OK or ERROR), and a status message.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:gateways::get

REST API Syntax

See REST API reference.

Example using curl:

curl -H "Authorization: Bearer $token" "$endpoint/config/mft/gateways"

config mft:externaluser::add

Creates a new external user based on user definitions that you provide through the command or through an External User Data file.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:externaluser::add <user> <email> <companyName> [password] [-f ExternalUserData.json] [-p]

Where:

Specifying the password through the command is optional, because you have the following alternatives:

• Provide a password or predefined secret through the External User Data file.
• Use the -p (or -prompt) option through the CLI. With this option, you do not need to enter the password in the command. Instead, you are prompted for the password (twice) after you enter the command.
  Note: If you use both the password parameter and the -p option, the password that you enter through the command prompt overrides the password that you specify in the command.

REST API Syntax

See REST API reference.

Example using curl:

curl -H "Authorization: Bearer $token" -F "ExternalUserData=@externalUser1.json"
-X POST $endpoint/config/mft/externaluser

config mft:externaluser::update

Updates an existing external user based on user definitions that you provide through an External User Data file.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:externaluser::update <name> <-f ExternalUserData.json> [-p]

Where:

If you do not want to specify the user's password through the External User Data file, you can include the -p (or -prompt) option in the CLI command. With this option, you are prompted for the password (twice) after you enter the command.

REST API Syntax

See REST API reference.

Example using curl:

name=user3
curl -H "Authorization: Bearer $token" -F "ExternalUserData=@externalUser1.json"
-X POST "$endpoint/config/mft/externaluser/$name"

config mft:externaluser::delete

Deletes an existing external user.

CLI Syntax

ctm config mft:externaluser::delete <name>

Where <name> is the name of the external user.

REST API Syntax

See REST API reference.

Example using curl:

name=user5
curl -H "Authorization: Bearer $token" -X DELETE "$endpoint/config/mft/externaluser/$name"

config mft:externalusers::get

Retrieves details of defined external users.

The output is returned in JSON format. You can use this output as a template for your own External User Data files when creating new external users or editing existing external users. For more information about the syntax of user definitions, see External User Data file in Configuration reference for file transfers to or from external users.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:externalusers::get [-s <search query>]

The optional -s  is used to filter results by running a search using the query string format "field1=criteria1&field2=criteria2&field3=criteria3".

The following fields are available for use in the search query:

REST API Syntax

See REST API reference.

Examples using curl:

curl -H "Authorization: Bearer $token" $endpoint/config/mft/externalusers

curl -H "Authorization: Bearer $token" "$endpoint/config/mft/externalusers?name=a*&email=b*"

config mft:externaluser:virtualfolders::get

Retrieves a list of virtual folders that a specific external user is authorized to access.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:externaluser:virtualfolders::get <user>

Where <user> is the name of the external user.

REST API Syntax

See REST API reference.

Examples using curl:

user=user5
curl -H "Authorization: Bearer $token" $endpoint/config/mft/externaluser/$user/virtualfolders

config mft:virtualfolder::add

Creates a new virtual folder based on folder settings that you define through a Folder Properties file.

Virtual folders are used to transfer incoming and outgoing files between external and internal users. Authorizations applied at the folder level determine which external and internal users can access the folders. Folders can be configured to define a maximum retention period, and can generate email notifications to associated users when new files are available.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:virtualfolder::add <name> [-f folderPropertiesData.json]

Where:

REST API Syntax

See REST API reference.

Example using curl:

curl -H "Authorization: Bearer $token" -F "folderPropertiesData=@virtualFolder1.json"
-X POST $endpoint/config/mft/virtualfolder

config mft:virtualfolder::update

Updates an existing virtual folder based on folder settings that you define through a Folder Properties file.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:virtualfolder::update <name> [-f folderPropertiesData.json]

Where:

REST API Syntax

See REST API reference.

Example using curl:

name=folder3
curl -H "Authorization: Bearer $token" -F "folderPropertiesData=@virtualFolder1.json"
-X POST "$endpoint/config/mft/virtualfolder/$name"

config mft:virtualfolder::delete

Deletes an existing virtual folder.

CLI Syntax

ctm config mft:virtualfolder::delete <name>

Where <name> is the name of the virtual folder.

REST API Syntax

See REST API reference.

Example using curl:

name=folder5
curl -H "Authorization: Bearer $token" -X DELETE "$endpoint/config/mft/virtualfolder/$name"

config mft:virtualfolders::get

Retrieves details of defined virtual folders.

The output is returned in JSON format. You can use this output as a template for your own Folder Properties files when creating new virtual folders or editing existing virtual folders. For more information about the syntax of virtual folder definitions, see Folder Properties Data file in Configuration reference for file transfers to or from external users.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:virtualfolders::get [-s "name=<pattern>"]

The optional -s runs a search and filters the output based on folder name. For multiple values, use wildcards (* or ?) or commas.
For example: -s "name=a*"

REST API Syntax

See REST API reference.

Examples using curl:

curl -H "Authorization: Bearer $token" $endpoint/config/mft/users/virtualfolders

curl -H "Authorization: Bearer $token" "$endpoint/config/mft/users/virtualfolders?name=a*"

config mft:virtualfolder:user::add

Adds an external user or a user group to an existing virtual folder's list of authorized users and groups.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:virtualfolder:user::add <folder> <userOrGroup>

Where:

REST API Syntax

See REST API reference.

Example using curl:

name=folder5
userOrGroup=userA
curl -H "Authorization: Bearer $token" -X POST "$endpoint/config/mft/virtualfolder/$name/user/$userOrGroup"

config mft:virtualfolder:user::remove

Removes an external user or user group from an existing virtual folder's list of authorized users and groups.

CLI Syntax

ctm config mft:virtualfolder:user::remove <folder> <userOrGroup>

Where:

REST API Syntax

See REST API reference.

Example using curl:

name=folder5
userOrGroup=userA
curl -H "Authorization: Bearer $token" -X DELETE "$endpoint/config/mft/virtualfolder/$name/user/$userOrGroup"

config mft:usergroup::add

Creates a new group of users (external users or ldap users) based on group settings that you define through a User Group Properties file.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:usergroup::add <name> [-f UserGroupPropertiesData.json]

Where:

REST API Syntax

See REST API reference.

Example using curl:

curl -H "Authorization: Bearer $token" -F "UserGroupPropertiesData=@group1.json"
-X POST $endpoint/config/mft/usergroup

config mft:usergroup::update

Updates an existing group of users (external users or ldap users) based on group settings that you define through a User Group Properties file.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:usergroup::update <name> <-f UserGroupPropertiesData.json>

Where:

REST API Syntax

See REST API reference.

Example using curl:

name=group4
curl -H "Authorization: Bearer $token" -F "UserGroupPropertiesData=@group4.json"
-X POST "$endpoint/config/mft/usergroup/$name"

config mft:usergroup::delete

Deletes an existing group of users.

CLI Syntax

ctm config mft:usergroup::delete <name>

Where <name> is the name of the group.

REST API Syntax

See REST API reference.

Example using curl:

name=group6
curl -H "Authorization: Bearer $token" -X DELETE "$endpoint/config/mft/usergroup/$name"

config mft:usergroups::get

Retrieves details of defined groups.

The output is returned in JSON format. You can use this output as a template for your own User Group Properties files when creating new groups or editing existing groups. For more information about the syntax of group definitions, see User Group Properties Data file in Configuration reference for file transfers to or from external users.

To use this API command, you must be using Control-M MFT Enterprise B2B version 9.0.20 or later.

CLI Syntax

ctm config mft:usergroups::get [-s <search query>]

The optional -s  is used to filter results by running a search using the query string format "field1=criteria1&field2=criteria2&field3=criteria3".

The following fields are available for use in the search query:

REST API Syntax

See REST API reference.

Examples using curl:

curl -H "Authorization: Bearer $token" $endpoint/config/mft/usergroups

curl -H "Authorization: Bearer $token" "$endpoint/config/mft/usergroups?name=a*&externalUsers=b*"

_{Back to top}

Configuring Secrets

Config secrets allows you to add, delete, or update named secrets in the Control-M vault. The Control-M vault is a secured collection of name and value pairs of secrets.

To learn how to use Secrets in Code, see Secrets in Code.

config secret::add

Creates a pair which consists of named secret and value in the Control-M vault.

ctm config secret::add <name> <value>

If annotation is enabled for the Scheduling definitions category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

curl -H "Authorization: Bearer $token"  -X POST -d "{\"name\":\"$name\",\"value\":\"$value\"}" "$endpoint/config/secret"

config secret::delete

Deletes the pair of named secret and value from the Control-M vault.

ctm config secret::delete <name> 

If annotation is enabled for the Scheduling definitions category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

curl -H "Authorization: Bearer $token"  -X DELETE  "$endpoint/config/secret/$name"

config secret::update

Updates the value of the named secret in the Control-M vault.

ctm config secret::update <name> <value>

If annotation is enabled for the Scheduling definitions category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using  curl:

curl -H "Authorization: Bearer $token"  -X POST -d "{\"value\":\"$value\"}" "$endpoint/config/secret/$name"

config secrets::get

Returns a list of names of defined secrets.

ctm config secrets::get 

REST API Syntax

See REST API reference.

Example using  curl:

curl -H "Authorization: Bearer $token"  "$endpoint/config/secrets"

_{Back to top}