Skip to navigation

Update cloud VM access settings

Adds or removes SSH keys, resets the Linux user password, or changes SSH password authentication on a cloud VM without rebooting it. Asynchronous: the response carries operation_id; poll GET /compute/operations/{operation_id} until status is succeeded, failed, cancelled or timed_out. If your client times out, read the status; never resubmit the request. Requires scope: vm.write.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# VM_ID: Virtual machine ID
curl -X PATCH "https://api.ibee.ai/v1/compute/cloud-vms/$VM_ID/actions/access?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN" \
-H "X-Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"ssh_key_mode": "add", "ssh_keys": []}'

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

vm_idstringRequired
Virtual machine ID.

Headers

X-Idempotency-KeystringRequired
Unique key used to safely retry write operations.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Request

This endpoint expects an object.
ssh_key_modeenum or nullOptional
  • add: install the given keys.
  • remove: remove the given keys.
Allowed values:
ssh_keyslist of stringsOptionalDefaults to []
Inline public SSH keys to add or remove.
ssh_key_idslist of stringsOptionalDefaults to []
Secret Store SSH key IDs to add or remove.
new_passwordstring or nullOptional>=8 characters

New password for admin_username.

password_auth_enabledboolean or nullOptional

Enable (true) or disable (false) SSH password authentication.

confirm_remove_last_ssh_keybooleanOptionalDefaults to false

Must be true to remove the VM’s last remaining SSH key.

Response

Access update accepted.
operation_idstring
ID of the queued operation.
vm_idstring
ID of the VM the operation acts on.
statusstring

Always accepted.

submitted_atdatetime

When the operation was accepted (ISO 8601).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
422
Unprocessable Entity Error
423
Locked Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error