Enable and access the DataStax Agent API
Enable and access the interactive Swagger UI console for the DataStax Agent API.
Explore the console to learn about the agent APIs available for scripting purposes, or to use directly with a curl command.
-
Edit the
address.yamlfile. The location of this file depends on the type of installation:-
Package installations:
/var/lib/datastax-agent/conf/address.yaml -
Tarball installations:
INSTALL_DIRECTORY/conf/address.yaml
-
-
Set the
swagger_enabledoption totrue. -
Navigate to the UI:
http(s)://AGENT_IP:API_PORT/uiUse
httpsorhttpas appropriate for your environment. ReplaceAGENT_IPwith the IP address of the particular agent. Replace theAPI_PORTwith the port configured for your environment. Typically, theAPI_PORTis61621. -
Configure the API port using the
api_portoption inaddress.yamlor[agents]api_port incluster_name.conf.The location of the
cluster_name.conffile depends on the type of installation:-
Package installations:
/etc/opscenter/clusters/cluster_name.conf -
Tarball installations:
INSTALL_DIRECTORY/conf/clusters/cluster_name.conf
-