4.1 KiB
Return to top
Update
=============================================================================================
PATCH
/servers/{uuid}
Update Server.
Authorizations
bearerAuth
Go to Keys & Tokens / API tokens and create a new token. Use the token as the bearer token.
Type
HTTP (bearer)
Parameters
Path Parameters
uuid*
Server UUID
Type
string
Required
Request Body
application/json
SchemaJSON
JSON
{
"name": "string",
"description": "string",
"ip": "string",
"port": 0,
"user": "string",
"private_key_uuid": "string",
"is_build_server": true,
"instant_validate": true,
"proxy_type": "string",
"concurrent_builds": 0,
"dynamic_timeout": 0,
"deployment_queue_limit": 0,
"server_disk_usage_notification_threshold": 0,
"server_disk_usage_check_frequency": "string"
}
Responses
201400401404422
Server updated.
Content-Type
application/json
SchemaJSON
JSON
{
"id": 0,
"uuid": "string",
"name": "string",
"description": "string",
"ip": "string",
"user": "string",
"port": 0,
"proxy": {
},
"proxy_type": "string",
"high_disk_usage_notification_sent": true,
"unreachable_notification_sent": true,
"unreachable_count": 0,
"validation_logs": "string",
"log_drain_notification_sent": true,
"swarm_cluster": "string",
"settings": {
"id": 0,
"concurrent_builds": 0,
"deployment_queue_limit": 0,
"dynamic_timeout": 0,
"force_disabled": true,
"force_server_cleanup": true,
"is_build_server": true,
"is_cloudflare_tunnel": true,
"is_jump_server": true,
"is_logdrain_axiom_enabled": true,
"is_logdrain_custom_enabled": true,
"is_logdrain_highlight_enabled": true,
"is_logdrain_newrelic_enabled": true,
"is_metrics_enabled": true,
"is_reachable": true,
"is_sentinel_enabled": true,
"is_swarm_manager": true,
"is_swarm_worker": true,
"is_terminal_enabled": true,
"is_usable": true,
"logdrain_axiom_api_key": "string",
"logdrain_axiom_dataset_name": "string",
"logdrain_custom_config": "string",
"logdrain_custom_config_parser": "string",
"logdrain_highlight_project_id": "string",
"logdrain_newrelic_base_uri": "string",
"logdrain_newrelic_license_key": "string",
"sentinel_metrics_history_days": 0,
"sentinel_metrics_refresh_rate_seconds": 0,
"sentinel_token": "string",
"docker_cleanup_frequency": "string",
"docker_cleanup_threshold": 0,
"server_id": 0,
"wildcard_domain": "string",
"created_at": "string",
"updated_at": "string",
"delete_unused_volumes": true,
"delete_unused_networks": true
}
}
PATCH
/servers/{uuid}
Playground
Authorization
bearerAuth
Variables
Key
Value
uuid*
Body
Try it out
Samples
Powered by VitePress OpenAPI