Servers

Create a server

Creates a new server in the project. The protocol_type determines which additional connection parameters are required: SSH needs hostname and username, FTP needs hostname, username, and password, S3 needs bucket_name, access_key_id, and secret_access_key. For managed_vps, pass region, size, and os_image at the top level. For static_hosting, pass hosted_website_attributes at the top level. For custom_action, pass commands and a Docker image inside server: either docker_image, or docker_image_source curated with curated_template_id.

post/projects/{project_id}/servers

Request

  • Base URL: https://sg.deployhq.com
  • URL: https://sg.deployhq.com/projects/{project_id}/servers
  • Auth: HTTP basic

Path parameters

project_idstring required

The identifier or permalink of the project

Request body

regionstring
sizestring
os_imagestring
key_pair_identifierstring

Response

Success

idinteger
identifierstring
namestring
protocol_typestring
server_pathstring
last_revisionstring nullable
preferred_branchstring
branchstring
notify_emailstring
server_group_identifierstring nullable
auto_deployboolean
environmentstring
enabledboolean
agentstring nullable
atomicboolean
atomic_strategystring
atomic_retentioninteger
use_compressionboolean
use_accelerated_transferboolean
use_parallel_uploadboolean
root_pathstring
positioninteger
created_atstring
updated_atstring
connection_checked_atstring nullable
connection_error_messagestring nullable
hostnamestring
usernamestring
portinteger
use_ssh_keysboolean
host_keystring
unlink_before_uploadboolean

Changes

No recorded changes to this operation across all 1 revision of this API.