Open topic with navigation

# POST clients/<ID> and POST clients

This web method 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":"sendlogs", "args":[{"mode": "<mode>"}]}` | Instruct the client to enable or disable sending its logs to the FTL server. The initial mode for all clients is `off`. Values: `on` The client sends its log messages to the FTL server. `off` The client does not send its log messages to the FTL server. (The client still outputs log messages to its log output target.) For more information, see Catalog of Metrics .
`{"cmd":"setmonmode", "args":[{"mode": "<mode>"}]}` | Set the client's monitoring mode. Values: `dynamic_monitor_info_on` The client gathers metrics related to message content matching, and generates monitoring data submessages with types 90009 and 90010. For more information, see Catalog of Metrics . `dynamic_monitor_info_off` The client does not gather metrics related to content matching, and does not generate monitoring data submessages with types 90009 and 90010.
`{"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>

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO FTL® - Enterprise Edition

Copyright © 2009-2024. Cloud Software Group, Inc. All Rights Reserved.