POST clients/ID and POST clients

The web method POST clients/ID sends a command that affects a specific client. The broader form, POST clients, sends a command to a collection of clients.

Targeting Clients

  • To target a specific client, supply the client ID as the ID in the URI.
  • To target a collection of clients, omit the ID from the URI.
  • To target a narrower collection of clients, omit the ID from the URI, and supply filtering arguments.
    This example filters the clients to those that run on a specific host computer, and disables only those clients: 
    POST clients?host=reed {"cmd":"disable"}

    For details, see Filters for Client Status Methods.

Input Data

Supply the command in JSON format, for example: 
{"cmd":"setloglevel","args":[{"level":"warn"}]}

Commands

Command Description
{"cmd":"setloglevel", "args":[{"level": "element:level"}]} Set the client's log level.

For details, see "Tuning the Log Level" in TIBCO FTL Development.

{"cmd":"disable"} Disable the client.

For background information, see Conditions for Disabling Clients.

{"cmd":"purge"} Purge clients that have timed out.

For background information, see Client Status.

Example Requests

curl -X POST http://host:port/api/v1/clients/ID -d json_cmd