JSONRPC Endpoint

Traffic Server API clients can use different languages to connect and interact with the JSONRPC 2.0 node directly. The goal of this section is to provide some tips on how to work with it. To begin with, you should be familiar with the JSONRPC 2.0 protocol, you can check here JSONRPC 2.0 Protocol and also JSONRPC .

IPC Node

You can directly connect to the Unix Domain Socket used for the JSONRPC 2.0 node, the location of the sockets will depend purely on how did you configure the server, please check Configuration for information regarding configuration.

Socket connectivity

JSONRPC 2.0 server will close the connection once the server processed the incoming requests, so clients should be aware of this and if sending multiple requests they should reconnect to the node once the response arrives. The protocol allows you to send a bunch of requests together, this is called batch messages so it's recommended to send them all instead of having a connection open and sending requests one by one. This being a local socket opening and closing the connection should not be a big concern.

Using traffic_ctl

traffic_ctl can also be used to directly send raw JSONRPC 2.0 messages to the server's node, traffic_ctl provides several options to achieve this, please check traffic_ctl_rpc.

Error responses

The server will indicate in case of any error processing the call, check JSON RPC errors for more details.