Servers

Update a server

Updates an existing server's configuration. If the server uses external authentication and is not yet authenticated, a redirect to the OAuth URL is returned.

patch/projects/{project_id}/servers/{id}

Request

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

Path parameters

project_idstring required

The identifier or permalink of the project

idstring required

The identifier of the server

Request body

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.