Skip to content

metalcloud-cli endpoint update

Update an existing endpoint

Update an existing endpoint in MetalSoft.

You can update the endpoint by specifying new values for its name, label, or external ID using flags, or by providing a configuration file or piped JSON/YAML with —config-source. When using —config-source, the file or piped content must contain the fields to update in JSON or YAML format.

Arguments: endpoint_id The unique identifier of the endpoint to update (required)

Optional flags: —name string New name for the endpoint —label string New label for the endpoint —external-id string New external ID for the endpoint —config-source string Source of configuration (file path or ‘pipe’)

Flag dependencies:

  • Flags are mutually exclusive with —config-source
  • At least one flag must be provided to update the endpoint
  • Only the fields provided will be updated

Examples: metalcloud-cli endpoint update 123 —name “new-name” metalcloud-cli endpoint update 123 —label “New Label” —external-id “new-ext-001” metalcloud-cli endpoint update 123 —config-source ./update.json cat update.yaml | metalcloud-cli endpoint update 123 —config-source pipe

metalcloud-cli endpoint update endpoint_id [flags]
--config-source string Source of the endpoint configuration to update. Can be 'pipe' or path to a JSON file.
--external-id string The new external ID of the endpoint.
-h, --help help for update
--label string The new label of the endpoint.
--name string The new name of the endpoint.
-k, --api_key string MetalCloud API key
-c, --config string Config file path
-d, --debug Set to enable debug logging
-e, --endpoint string MetalCloud API endpoint
-f, --format string Output format. Supported values are 'text','csv','md','json','yaml'. (default "text")
-i, --insecure_skip_verify Set to allow insecure transport
-l, --log_file string Log file path
-v, --verbosity string Log level verbosity (default "INFO")

Auto generated by spf13/cobra on 11-Aug-2025

Section titled “Auto generated by spf13/cobra on 11-Aug-2025”