Import servers from Terraform output into an environment
const url = 'https://example.com/api/environments/example/servers/import-terraform';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"servers":[{"name":"example","private_ip":"example","public_ip":"example","tags":["example"],"services":[{"name":"example","container_name":"example","image_name":"example","image_tag":"latest","compose_path":"example","health_check_url":"example"}]}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/environments/example/servers/import-terraform \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "servers": [ { "name": "example", "private_ip": "example", "public_ip": "example", "tags": [ "example" ], "services": [ { "name": "example", "container_name": "example", "image_name": "example", "image_tag": "latest", "compose_path": "example", "health_check_url": "example" } ] } ] }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”object
object
object
Responses
Section titled “Responses”Bad request — malformed input or failed validation.
object
Stable, machine-readable error code. Always present on the wire.
Human-readable error message. Always present on the wire.
Field name when the error is tied to a specific input (e.g. validation).
Optional, human-friendly hint for resolving the error.
Server-assigned request ID; quote this when reporting issues.
Example
{ "code": "READONLY_FIELD", "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.", "field": "exposedPorts", "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.", "requestId": "req_01H0…"}Unauthorized — missing or invalid bearer token.
object
Stable, machine-readable error code. Always present on the wire.
Human-readable error message. Always present on the wire.
Field name when the error is tied to a specific input (e.g. validation).
Optional, human-friendly hint for resolving the error.
Server-assigned request ID; quote this when reporting issues.
Example
{ "code": "READONLY_FIELD", "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.", "field": "exposedPorts", "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.", "requestId": "req_01H0…"}Internal server error.
object
Stable, machine-readable error code. Always present on the wire.
Human-readable error message. Always present on the wire.
Field name when the error is tied to a specific input (e.g. validation).
Optional, human-friendly hint for resolving the error.
Server-assigned request ID; quote this when reporting issues.
Example
{ "code": "READONLY_FIELD", "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.", "field": "exposedPorts", "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.", "requestId": "req_01H0…"}