Users

Server

Unikraft Cloud user accounts are used to manage resources, grant permissions and control usage quotas when interacting with the Unikraft Cloud API.

Get Current User Quotas

GET

https://api.sfo.unikraft.cloud

/v1/users/quotas

List quota usage and limits of your user account.

Get Current User Quotas › Responses

200

The request has succeeded.

The response message for getting the quota of a user given their UUID.

Users.QuotasResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

object

The response data for this request.

Common.ResponseError[]

A list of errors which may have occurred during the request.

GET/v1/users/quotas

curl https://api.sfo.unikraft.cloud/v1/users/quotas \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "status": "success",
  "message": "message",
  "data": {
    "quotas": [
      {
        "status": "success",
        "message": "message",
        "error": 0,
        "uuid": "00000000-0000-0000-0000-000000000000",
        "used": {
          "instances": 0,
          "live_instances": 0,
          "live_vcpus": 0,
          "live_memory_mb": 0,
          "service_groups": 0,
          "services": 0,
          "volumes": 0,
          "total_volume_mb": 0
        },
        "hard": {
          "instances": 0,
          "live_instances": 0,
          "live_vcpus": 0,
          "live_memory_mb": 0,
          "service_groups": 0,
          "services": 0,
          "volumes": 0,
          "total_volume_mb": 0
        },
        "limits": {
          "min_memory_mb": 16,
          "max_memory_mb": 2048,
          "min_volume_mb": 1,
          "max_volume_mb": 1024,
          "min_autoscale_size": 1,
          "max_autoscale_size": 16,
          "min_vcpus": 2,
          "max_vcpus": 4
        }
      }
    ]
  },
  "errors": [
    {
      "status": 0
    }
  ],
  "op_time_us": 0
}

json

application/json

Resume Users

PUT

https://api.sfo.unikraft.cloud

/v1/users/resume

Resume suspended user accounts by UUID(s). Removes the suspension and restores the instances that the suspension brought to rest. Requires the root permission.

Resume Users › Request Body

Users.ResumeUsersRequestItem[]

A single request item to resume a user account.

Users.ResumeUsersRequestItem

uuid

string · uuid · required

The UUID of the user.

Resume Users › Responses

200

The request has succeeded.

The response message for resuming one or more user account(s) given their UUID(s).

Users.ResumeUsersResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

object

The response data for this request.

Common.ResponseError[]

A list of errors which may have occurred during the request.

PUT/v1/users/resume

curl https://api.sfo.unikraft.cloud/v1/users/resume \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '[
  {
    "uuid": "00000000-0000-0000-0000-000000000000"
  }
]'

Example Request Body

[
  {
    "uuid": "00000000-0000-0000-0000-000000000000"
  }
]

json

Example Responses

{
  "status": "success",
  "message": "message",
  "data": {
    "users": [
      {
        "status": "success",
        "message": "message",
        "error": 0,
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "node": "node",
        "suspended": true,
        "instances": [
          {
            "status": "success",
            "message": "message",
            "error": 0,
            "uuid": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "node": "node",
            "state": "stopped",
            "previous_state": "stopped",
            "on_resume": "standby"
          }
        ]
      }
    ]
  },
  "errors": [
    {
      "status": 0
    }
  ],
  "op_time_us": 0
}

json

application/json

Suspend Users

PUT

https://api.sfo.unikraft.cloud

/v1/users/suspend

Suspend user accounts by UUID(s). A suspended user keeps read access to its resources but cannot create, modify, start, stop, or delete them. Its scheduled operations fail, autoscaling of its service groups stops, and autokill of its instances pauses. Requires the root permission; root users cannot be suspended.

Suspend Users › Request Body

Users.SuspendUsersRequestItem[]

A single request item to suspend a user account.

Users.SuspendUsersRequestItem

uuid

string · uuid · required

The UUID of the user.

suspend_instances

boolean

Whether to also bring all instances of the user to rest. Autostart is disabled, running instances are suspended (or stopped if they cannot be suspended, or if they only return to standby and are not stateful), and pending restarts are cancelled. Instances that are draining, stopping, or in a start-stop cycle finish that transition first. Booting instances are brought to rest once they are running. Without this flag only the account is suspended and its instances are left as they are.

Example: true

Suspend Users › Responses

200

The request has succeeded.

The response message for suspending one or more user account(s) given their UUID(s).

Users.SuspendUsersResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

object

The response data for this request.

Common.ResponseError[]

A list of errors which may have occurred during the request.

PUT/v1/users/suspend

curl https://api.sfo.unikraft.cloud/v1/users/suspend \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "suspend_instances": true
  }
]'

Example Request Body

[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "suspend_instances": true
  }
]

json

Example Responses

{
  "status": "success",
  "message": "message",
  "data": {
    "users": [
      {
        "status": "success",
        "message": "message",
        "error": 0,
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "node": "node",
        "suspended": true,
        "instances": [
          {
            "status": "success",
            "message": "message",
            "error": 0,
            "uuid": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "node": "node",
            "state": "stopped",
            "previous_state": "stopped",
            "on_resume": "standby"
          }
        ]
      }
    ]
  },
  "errors": [
    {
      "status": 0
    }
  ],
  "op_time_us": 0
}

json

application/json

Get User Quotas by UUID

GET

https://api.sfo.unikraft.cloud

/v1/users/{uuid}/quotas

List quota usage and limits of a user account by UUID.

Get User Quotas by UUID › path Parameters

uuid

string · uuid · required

Get User Quotas by UUID › Responses

200

The request has succeeded.

The response message for getting the quota of a user given their UUID.

Users.QuotasResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

object

The response data for this request.

Common.ResponseError[]

A list of errors which may have occurred during the request.

GET/v1/users/{uuid}/quotas

curl https://api.sfo.unikraft.cloud/v1/users/:uuid/quotas \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "status": "success",
  "message": "message",
  "data": {
    "quotas": [
      {
        "status": "success",
        "message": "message",
        "error": 0,
        "uuid": "00000000-0000-0000-0000-000000000000",
        "used": {
          "instances": 0,
          "live_instances": 0,
          "live_vcpus": 0,
          "live_memory_mb": 0,
          "service_groups": 0,
          "services": 0,
          "volumes": 0,
          "total_volume_mb": 0
        },
        "hard": {
          "instances": 0,
          "live_instances": 0,
          "live_vcpus": 0,
          "live_memory_mb": 0,
          "service_groups": 0,
          "services": 0,
          "volumes": 0,
          "total_volume_mb": 0
        },
        "limits": {
          "min_memory_mb": 16,
          "max_memory_mb": 2048,
          "min_volume_mb": 1,
          "max_volume_mb": 1024,
          "min_autoscale_size": 1,
          "max_autoscale_size": 16,
          "min_vcpus": 2,
          "max_vcpus": 4
        }
      }
    ]
  },
  "errors": [
    {
      "status": 0
    }
  ],
  "op_time_us": 0
}

json

application/json

Resume User by UUID

PUT

https://api.sfo.unikraft.cloud

/v1/users/{uuid}/resume

Resume a suspended user account by UUID. Removes the suspension and restores the instances that the suspension brought to rest. Requires the root permission.

Resume User by UUID › path Parameters

uuid

string · uuid · required

Resume User by UUID › Responses

200

The request has succeeded.

The response message for resuming one or more user account(s) given their UUID(s).

Users.ResumeUsersResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

object

The response data for this request.

Common.ResponseError[]

A list of errors which may have occurred during the request.

PUT/v1/users/{uuid}/resume

curl https://api.sfo.unikraft.cloud/v1/users/:uuid/resume \
  --request PUT \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "status": "success",
  "message": "message",
  "data": {
    "users": [
      {
        "status": "success",
        "message": "message",
        "error": 0,
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "node": "node",
        "suspended": true,
        "instances": [
          {
            "status": "success",
            "message": "message",
            "error": 0,
            "uuid": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "node": "node",
            "state": "stopped",
            "previous_state": "stopped",
            "on_resume": "standby"
          }
        ]
      }
    ]
  },
  "errors": [
    {
      "status": 0
    }
  ],
  "op_time_us": 0
}

json

application/json

Suspend User by UUID

PUT

https://api.sfo.unikraft.cloud

/v1/users/{uuid}/suspend

Suspend a user account by UUID. A suspended user keeps read access to its resources but cannot create, modify, start, stop, or delete them. Its scheduled operations fail, autoscaling of its service groups stops, and autokill of its instances pauses. Requires the root permission; root users cannot be suspended.

Suspend User by UUID › path Parameters

uuid

string · uuid · required

Suspend User by UUID › Request Body optional

Parameters for suspending a user account.

Users.SuspendUserByUUIDRequestBody

suspend_instances

boolean

Example: true

Suspend User by UUID › Responses

200

The request has succeeded.

The response message for suspending one or more user account(s) given their UUID(s).

Users.SuspendUsersResponse

status

string · enum · required

The status of the response.

Enum values:

success

error

partial_success

op_time_us

integer · uint64 · required

The operation time in microseconds.

message

string

An optional message providing additional information about the status.

object

The response data for this request.

Common.ResponseError[]

A list of errors which may have occurred during the request.

PUT/v1/users/{uuid}/suspend

curl https://api.sfo.unikraft.cloud/v1/users/:uuid/suspend \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "suspend_instances": true
}'

Example Request Body

{
  "suspend_instances": true
}

json

Example Responses

{
  "status": "success",
  "message": "message",
  "data": {
    "users": [
      {
        "status": "success",
        "message": "message",
        "error": 0,
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "node": "node",
        "suspended": true,
        "instances": [
          {
            "status": "success",
            "message": "message",
            "error": 0,
            "uuid": "00000000-0000-0000-0000-000000000000",
            "name": "name",
            "node": "node",
            "state": "stopped",
            "previous_state": "stopped",
            "on_resume": "standby"
          }
        ]
      }
    ]
  },
  "errors": [
    {
      "status": 0
    }
  ],
  "op_time_us": 0
}

json

application/json

Node Images