Change the host-level configuration of a Cycle server: its nickname, its tags (the labels containers target through constraints.node.tags), what it allows (pool: containers with no tags; services: environment service containers; overcommit: CPU shares beyond the hardware, by overcommit_multiple), its base volume size (the space reserved for images; grows only, never shrinks), whether it accepts SSH and SFTP connections (SFTP is required for container volumes with remote access), whether gateway services may run on it, and the shared file systems it exposes to containers. Shared file systems come in two kinds, each under an identifier: a shared DIRECTORY on the host, and a shared MOUNT that attaches an external file system (NFS, EFS, ...) with a type, mount options, and source. Containers mount an identifier via shared_file_systems on deploy_application or reconfigure_container; this tool is the server half only.
Nickname, tags, and allow apply immediately in one update with no job; tags are a complete replacement set, allow merges the passed flags over the current ones. Cycle applies features and shared file systems as two separate jobs, each replacing that whole group: the tool reads the current values, lays the fields you pass over them, and submits the full result, so anything you don't pass keeps its value. Shared file system directories and mounts are added (or replace an existing identifier); remove drops identifiers. Mount type, options, and source go to the host's mount verbatim, and a source the host cannot reach fails that job. Reconfiguring does not restart the server.
Always call with preview:true first: it returns the server's current tags, allow flags, features and shared file systems, the field-by-field change list, the containers across the hub whose placement constraints reference a tag being removed ('constrained_by'), and for every identifier being removed or replaced the containers that mount it ('mounted_by'). With nothing to change, preview is a read of the server's configuration. Confirm with the user, then call again without preview. Steps run the update (nickname, tags, allow) first, then features, then shared file systems, and stop at the first failure; read 'steps' rather than assuming all-or-nothing.
Connector
Destructive
API key