Consul-Terraform-Sync API Overview
Consul-Terraform-Sync (CTS) provides an HTTP API interface for querying CTS instances and running and managing tasks.
The API is served at the default port
8558 or a different port if set with
All API routes are prefixed with
/v1/. This documentation is for v1 of the API, which is the only version currently.
Each call to a CTS API endpoint returns a
request_id field. The field is a string generated by the API. Example:
The API sends a response code in the 200 range if the call is successful. If the call is unsuccessful, the API sends an error message that includes additional information when possible. Refer to Error Messages for additional information.