unikraft-cloud-plugin-sandbox-api

The generated client for the Unikraft Cloud sandbox plugin API. openapi-gen generates it from the plugin's OpenAPI specification, so do not edit it by hand.

This package is the raw ("plumbing") layer. Each method carries the name of its operationId and returns the response envelope exactly as the specification describes it. If you want the idiomatic layer, use unikraft-cloud, which wraps this package and resolves the instance for you.

Install

pip install unikraft-cloud-plugin-sandbox-api

The package depends on pydantic and typing_extensions only. Each generated class takes a Transport, an object with request(), request_no_content(), request_bytes() and stream(). The ApiClient of unikraft-cloud 0.2.0 or later is one. If you want to use it as the transport, install the SDK.

Usage

The plugin runs inside a single instance and answers on that instance's plugin route, so base_url is the full plugin endpoint rather than a metro root.

import os

from unikraft_cloud.core.http import ApiClient, ApiClientConfig
from unikraft_cloud_plugin_sandbox_api import SandboxPluginApi

uuid = "..."  # The instance the plugin is attached to.
api = SandboxPluginApi(
    ApiClient(
        ApiClientConfig(
            base_url=f"https://api.fra.unikraft.cloud/v1/instances/{uuid}/plugins/sandbox",
            token=os.environ["UKC_TOKEN"],
        )
    )
)

The last path segment is whatever name the plugin was attached under in the instance's plugins array, so it is not necessarily sandbox. To let the SDK build that URL for you, use unikraft-cloud instead.

Exports

Everything below is importable from unikraft_cloud_plugin_sandbox_api.

A CallOptions key that is absent leaves the transport's default in place, so timeout=None lifts the timeout for one call and no timeout at all keeps the client's.

SandboxPluginApi groups one client per resource:

• api.commands: the commands resource
• api.fs: the fs resource