Terraform
/ping endpoint reference
This endpoint provides a simple health check to verify that the Terraform Enterprise system is operational. Authentication is required to use this endpoint.
GET /api/v1/ping
Sample request
curl \
--header "Authorization: Bearer $TOKEN" \
--request GET \
https://tfe.example.com:8443/api/v1/ping
Response codes
Status | Response | Reason |
---|---|---|
200 | pong | The system is operational |
403 | JSON API error object | Not authorized to access this endpoint |
429 | JSON API error object | Too many requests |
500 | JSON API error object | Internal server error |
System API Overview
Terraform Enterprise Only: The System API is exclusive to Terraform Enterprise. It enables access to deployment configuration and data.
This API is distinct from the regular Admin API and the Backup and Restore API, with its own authentication mechanism.
Authentication
System API requests must be authenticated with a bearer token generated specifically for this API using the tfectl admin api-token generate
command. For more information on the token creation, and management, refer to the tfectl documentation.
Use the HTTP Header Authorization
with the value Bearer <token>
.
Rate Limiting
All System API endpoints are rate limited to 1 request per second per authentication token.
Port Configuration
By default, the System API is accessible on HTTPS port 8443
. This port can be configured through the TFE_ADMIN_HTTPS_PORT
environment variable in your deployment configuration.
Refer to Network settings in the configuration reference for more information about network configuration.
Versioning
The System API is versioned under the /api/v1
prefix and is separate from the main Terraform Enterprise API.
For example, if the API endpoint documentation defines the path /ping
then the full path is /api/v1/ping
.