Update GPU VM access settings

PATCH

/compute/gpu-vms/:vm_id/actions/access

Adds or removes SSH keys, resets the Linux user password, or changes SSH password authentication without rebooting the VM. Requires scope: vm.write.

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.

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.

requested_bystringOptionalDefaults to api

admin_usernamestring or nullOptional

Linux account to update. Defaults to the VM admin user.

ssh_key_modeenum or nullOptional

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.

ssh_key_secret_refslist of objectsOptionalDefaults to []

new_passwordstring or nullOptional>=8 characters

password_auth_enabledboolean or nullOptional

confirm_remove_last_ssh_keybooleanOptionalDefaults to false

Response

Access update accepted.

operation_idstring

vm_idstring

statusstring

submitted_atdatetime

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

$	curl -X PATCH "https://api.ibee.ai/v1/compute/gpu-vms/vm_id/actions/access?workspace_id=710995" \
>	-H "X-Idempotency-Key: X-Idempotency-Key" \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"operation_id": "op_123",
3	"vm_id": "vm_abc123",
4	"status": "accepted",
5	"submitted_at": "2024-01-15T09:30:00Z"
6	}