Русский

English

Русский

English

Тема

GET /sandboxes/{sandboxID} ​

Sandbox

Get a sandbox by id

Параметры ​

  • sandboxID · string · путь · обязательно

Ответы ​

200 ​

Successfully returned the sandbox

Content-Type: application/json

Схема: SandboxDetail

  • templateID · string · обязательно

    Identifier of the template from which is the sandbox created

  • alias · string · необязательно

    Alias of the template

  • sandboxID · string · обязательно

    Identifier of the sandbox

  • startedAt · string · обязательно

    Time when the sandbox was started

    Формат: date-time

  • endAt · string · обязательно

    Time when the sandbox will expire

    Формат: date-time

  • envdVersion · EnvdVersion · обязательно

    Version of the envd running in the sandbox

  • allowInternetAccess · boolean | null · необязательно

    Whether internet access was explicitly enabled or disabled for the sandbox. Null means it was not explicitly set.

  • domain · string | null · необязательно

    Base domain where the sandbox traffic is accessible

  • cpuCount · CPUCount · обязательно

    CPU cores for the sandbox

    Формат: int32

    Минимум: 1

  • memoryMB · MemoryMB · обязательно

    Memory for the sandbox in MiB

    Формат: int32

    Минимум: 128

  • diskSizeMB · DiskSizeMB · обязательно

    Disk size for the sandbox in MiB

    Формат: int32

    Минимум: 0

  • metadata · SandboxMetadata · необязательно

  • metadata.* · string · additional property

    Metadata of the sandbox

  • state · SandboxState · обязательно

    State of the sandbox

    Допустимые значения для SandboxState: running | paused

  • network · SandboxNetworkConfig · необязательно

  • network.allowPublicTraffic · boolean · необязательно

    Specify if the sandbox URLs should be accessible only with authentication.

    По умолчанию: true

  • network.allowOut · array<string> · необязательно

    List of allowed destinations for egress traffic. Each entry can be a CIDR block (e.g. "8.8.8.8/32"), a bare IP address (e.g. "8.8.8.8"), or a domain name (e.g. "example.com", "*.example.com"). Allowed entries always take precedence over denied entries.

  • network.denyOut · array<string> · необязательно

    List of denied CIDR blocks or IP addresses for egress traffic. Domain names are not supported for deny rules.

  • network.maskRequestHost · string · необязательно

    Specify host mask which will be used for all sandbox requests

  • network.rules · object · необязательно

    Per-domain transform rules applied to matching egress HTTP/HTTPS requests. Keys are domains (e.g. "api.example.com", "example.com"). A domain listed here is not automatically allowed - use allowOut to permit the traffic.

  • network.rules.* · array<SandboxNetworkRule> · additional property

  • network.rules.*.transform · SandboxNetworkTransform · необязательно

    Transformations applied to matching egress requests before forwarding.

  • network.rules.*.transform.headers · object · необязательно

    HTTP headers to inject or override in matching requests. An existing header with the same name is replaced. Values are plain strings; secret resolution happens client-side before sending to the API.

  • network.rules.*.transform.headers.* · string · additional property

  • lifecycle · SandboxLifecycle · необязательно

    Sandbox lifecycle policy returned by sandbox info.

  • lifecycle.autoResume · boolean · обязательно

    Whether the sandbox can auto-resume.

  • lifecycle.onTimeout · SandboxOnTimeout · обязательно

    Action taken when the sandbox times out.

    Допустимые значения для SandboxOnTimeout: kill | pause

404 ​

Not found

Content-Type: application/json

Схема: Error

  • code · integer · обязательно

    Error code

    Формат: int32

  • message · string · обязательно

    Error

401 ​

Authentication error

Content-Type: application/json

Схема: Error

  • code · integer · обязательно

    Error code

    Формат: int32

  • message · string · обязательно

    Error

500 ​

Server error

Content-Type: application/json

Схема: Error

  • code · integer · обязательно

    Error code

    Формат: int32

  • message · string · обязательно

    Error