Rename a server
Changes the display name of a server. The name cannot be empty. Other fields of the server do not change.
/api/v1/servers/{id}tse_sessionAPI key · cookierequiredidstringrequiredapplication/jsonnamestringOK
cleaning_upbooleanrequiredcleanup_errorstringcleanup_kindstringdeploy_refusalcleanup_pendingbooleanrequiredcleanup_sincestringcreated_atstringrequireddatabase_servicesDatabaseServiceAssignmentResponse[]requiredShow propertiesHide properties
DatabaseServiceAssignmentResponsedatabase_service_idstringrequireddatabase_service_namestringrequiredrolestringrequireddemobooleanrequiredenroll_statestringrequiredpendingenrolledremovedheadscale_node_idstringhealthServerHealthResponseShow propertiesHide properties
checked_atstring<date-time>The time of the last reading. Absent when there is none. When it is 15 minutes old or older, status is error.
notesServerHealthNoteResponse[]requiredThe current note of each component that the console checked on the server. Empty when the server has no reading for 15 minutes, and while the console cannot reach the mesh: the notes are then old.
Show propertiesHide properties
ServerHealthNoteResponsecausestringWhy the note is not healthy: unreachable (no mesh path), unhealthy (the component says so), or unverified (the check failed).
unreachableunhealthyunverifiedcomponentstringrequiredreachabilitypatronietcdpgbouncerhaproxyreservemessagestringsincestring<date-time>requiredThe time the status of the note last changed.
statusstringrequiredhealthywarningerrorunknownreasonstringrequiredsincestring<date-time>The time the status last changed. Absent when the server has no reading, and while the console cannot reach the mesh.
statusstringrequiredhealthywarningerrorunknownhoststringrequiredidstringrequiredin_usebooleanrequiredlivesync_sessionsServerLivesyncResponse[]requiredShow propertiesHide properties
ServerLivesyncResponseidstringrequirednamestringrequirednamestringrequiredoverlay_ipstringrequiredportinteger<int64>requiredreachablebooleanTrue when the fresh reachability note of the server says that the console reaches it over the mesh, false when it says not. Absent when there is no fresh note, and while the console cannot reach the mesh. The mesh status reads the same note.
rebuild_pendingbooleanrequiredretry_cleanup_refusalstringslotsServerSlotResponse[]requiredShow propertiesHide properties
ServerSlotResponsekindstringrequireddatabase_servicedcs_clustermember_namestringrequiredowner_namestringrequiredssh_userstringrequiredstatestringrequiredin_usefreeneeds_cleanupError
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message