Get Sandbox

GET
/workspaces
/:workspace
/sandboxes
/:sandbox_id

Retrieves information about a specific sandbox.

Request

REQUIRED SCOPES

WORKSPACE, SANDBOX_INFO

URL PARAMETERS

workspacerequired string

The workspace name.

sandbox_idrequired string

The ID of the sandbox.

Last modified on Sep 10, 2025

Delete Sandbox Snapshot Get Sandbox YAML

Example:

CURL
curl -X GET "https://api.buddy.works/workspaces/:workspace/sandboxes/:sandbox_id" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json"

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/sandboxes/re8w7e7brgnyi",
  "html_url": "https://app.buddy.works/buddy/my-project/sandboxes/re8w7e7brgnyi",
  "id": "re8w7e7brgnyi",
  "identifier": "new-sandbox",
  "name": "New sandbox",
  "status": "RUNNING",
  "os": "ubuntu:24.04",
  "resources": "3x6",
  "install_commands": "apt-get update\napt-get install -y nginx",
  "run_command": "nginx -t",
  "app_dir": "/var/www/html",
  "app_type": "SERVICE",
  "tags": [
    "purple",
    "azure"
  ],
  "app_status": "ENDED",
  "boot_logs": [
    "Sandbox starting...",
    "+ apt-get update",
    "Hit:1 https://archive.ubuntu.com/ubuntu noble InRelease",
    "Get:2 https://archive.ubuntu.com/ubuntu noble-updates InRelease [126 kB]",
    "Hit:3 https://security.ubuntu.com/ubuntu noble-security InRelease",
    "Hit:4 https://es.buddy.works/bdy/apt-repo dev InRelease",
    "Fetched 126 kB in 1s (173 kB/s)",
    "Reading package lists...",
    "+ apt-get install -y nginx",
    "Reading package lists...",
    "Building dependency tree...",
    "Reading state information...",
    "The following additional packages will be installed:",
    "  nginx-common",
    "Suggested packages:",
    "  fcgiwrap nginx-doc ssl-cert",
    "The following NEW packages will be installed:",
    "  nginx nginx-common",
    "0 upgraded, 2 newly installed, 0 to remove and 0 not upgraded.",
    "Need to get 564 kB of archives.",
    "After this operation, 1596 kB of additional disk space will be used.",
    "Get:1 https://archive.ubuntu.com/ubuntu noble-updates/main amd64 nginx-common all 1.24.0-2ubuntu7.5 [43.4 kB]",
    "Get:2 https://archive.ubuntu.com/ubuntu noble-updates/main amd64 nginx amd64 1.24.0-2ubuntu7.5 [520 kB]",
    "Preconfiguring packages ...",
    "Fetched 564 kB in 0s (1222 kB/s)",
    "Selecting previously unselected package nginx-common.",
    "(Reading database ... ",
    "(Reading database ... 5%",
    "(Reading database ... 10%",
    "(Reading database ... 15%",
    "(Reading database ... 20%",
    "(Reading database ... 25%",
    "(Reading database ... 30%",
    "(Reading database ... 35%",
    "(Reading database ... 40%",
    "(Reading database ... 45%",
    "(Reading database ... 50%",
    "(Reading database ... 55%",
    "(Reading database ... 60%",
    "(Reading database ... 65%",
    "(Reading database ... 70%",
    "(Reading database ... 75%",
    "(Reading database ... 80%",
    "(Reading database ... 85%",
    "(Reading database ... 90%",
    "(Reading database ... 95%",
    "(Reading database ... 100%",
    "(Reading database ... 20340 files and directories currently installed.)",
    "Preparing to unpack .../nginx-common_1.24.0-2ubuntu7.5_all.deb ...",
    "Unpacking nginx-common (1.24.0-2ubuntu7.5) ...",
    "Selecting previously unselected package nginx.",
    "Preparing to unpack .../nginx_1.24.0-2ubuntu7.5_amd64.deb ...",
    "Unpacking nginx (1.24.0-2ubuntu7.5) ...",
    "Setting up nginx-common (1.24.0-2ubuntu7.5) ...",
    "Created symlink /etc/systemd/system/multi-user.target.wants/nginx.service → /usr/lib/systemd/system/nginx.service.",
    "Setting up nginx (1.24.0-2ubuntu7.5) ...",
    " * Upgrading binary nginx",
    "   ...done."
  ],
  "setup_status": "DONE",
  "endpoints": [
    {
      "name": "cqccimvxsc-tls",
      "endpoint": "localhost:465",
      "type": "TLS",
      "region": "EU",
      "whitelist": [
        "12.34.56.78"
      ],
      "timeout": 60,
      "tls": {
        "private_key": "-----BEGIN PRIVATE KEY-----\r\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDNonj3e5c1THAf\r\nekNOFmlbpW3YDPHPtK/456mFDMoGVy9NEVninnSYdHUCT4heTOJmjnJdkN+xF9oI\r\ndpsZbFZL7y9jsMEC3wVMzPl26mbli96PITAru456p4x2BuYYr/h6ZLhdHfe3WdDW\r\nhuKWOElLUWCDJ8hxnD2wUi8Gso1IGXAyyXytQKTPZeI+PGdglNILiYLU5FKdmp5F\r\nXLgck3hP1SLceFauUgZlb93IiXUGl55KqE0J73xJMUPYr5Y1D+Uwr/D1cAkDCuyg\r\nj+0H2Ah0bcS5wbdh+0vA2rGW1prHzs/rmPU+ijX1WZ1PWQ3Mx/uwrKdkAJ+MMS9C\r\nRpITs66rAgMBAAECggEAMOqjaAvobm9ehL5q4FqIeZqixLBfnY9YBRfmxZXDQTrg\r\nL68e+L/E8LdTVldhEz2q5cahAg0CiXgpD7ZXMvcImEuvtEFJyMsQ0bI47cbY72YU\r\nbWvxr5WQUTEmQrVlax4BN+xZxxzn3p/pA/9WS3HcTaRwFwMRtaT7L8R9F1TGMw4c\r\n73TaleBJHLKJ13RUq2TcSc3g4e/BTAix7mUnKnTgwZF36fk4rjZPUU/XF11yJcwn\r\n1646nqL8OKiIeuPZzsUxyg6IIOFHjzFYrAc72eLFwPm3r5peVbojG/eFGT4NClqe\r\nRnwVKxO6yyIYOuXfTeb02fAhCCsnlrUp6BPq+gBjUQKBgQDmIR6wa7uHnVVtDWco\r\nCglhEabzyZPgdxM8/Lb8hWMQwo5Ouo94yrojJ1sSVQmNa0isVHMssUEpSxjluUdA\r\nuHq455149DcmUYtdnGOItoJ8anloUNmgCrSFzlJziy1teeQ1ls/Ufw4Oh+c0L+Hc\r\njBAYRa0BMUIUWBY5L6HSbFllBQKBgQDkwGus+pFhbJf8brQkHe79Q61ggr+gjyEc\r\nqOvKgc75/C3P1uF/33jLX3ZLcqMNneXbqj5qY9IbfwTO6PvQXp1fyxYtRFwu2F4p\r\nN7x4RFn8jufnNZtworSuIrNQIPTGCziGit6tfOZ/Q7k6PeANXFVzJps8kyoBXqfX\r\naUhQrvMT7wKBgQDPsBBMU84Y5CtWkgQJJJW2XwH3fnLQ32YjYkeaup7fX1ajQsd8\r\n0ikO1NPiRZCraqlZrZWMPiR6qeW8XWwqwtMu0QlTQcQL9wf54cwKc/xrYIRVWrIt\r\nN7wYDk5nLLJA3QLSQlsqgcgj4Q8OEDCcpGNaJHewXc4vIhhcX9qBV3uOKQKBgQDh\r\nUvT9Z7fKmng/jCBfryiZSo++kCwIENSR8YaJbEIflhreLpDjL5JB6d+RQ/N+1zjy\r\nnohqrbbppL1svqxEvN4R3O8UWdDfx/tAaIl6ggGNuIqQAgsB8RM+sCmm1T+m0Ki2\r\nRpY/l9dIJsKOryJCpt/41F93VJK81KtJkYhNCXeg+wKBgFrPfCmAOxaVxSjofPEB\r\nk1kSw37LqW9a7zxZD0J6E8o7Lf4W1uCi0popC4SQyfLdZI8sTZQ1UhQ/+c15GrtZ\r\n+i2TBBqK9Oww2XD8mraXXwbPmXQMvugPEseB2KQntE415Ojo1Jjv23+S3ZCDf4Ho\r\nWAQBIxV7p8WN0/ZP+7X9MmAR\r\n-----END PRIVATE KEY-----",
        "certificate": "-----BEGIN CERTIFICATE-----\r\nMIIDETCCAfkCFAl/BbLY56Bz0kv5baq6sZcEjZJSMA0GCSqGSIb3DQEBCwUAMEUx\r\nCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRl\r\ncm5ldCBXaWRnaXRzIFB0eSBMdGQwHhcNMjUwNDE0MTI0MjUyWhcNMjYwNDE0MTI0\r\nMjUyWjBFMQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UE\r\nCgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOC\r\nAQ8AMIIBCgKCAQEAzaJ493uXNUxwH3pDThZpW6Vt2Azxz7Sv+OephQzKBlcvTRFZ\r\n4p50mHR1Ak+IXkziZo5yXZDfsRfaCHabGWxWS+8vY7DBAt8FTMz5dupm5YvejyEw\r\nK7uOeqeMdgbmGK/4emS4XR33t1nQ1obiljhJS1FggyfIcZw9sFIvBrKNSBlwMsl8\r\nrUCkz2XiPjxnYJTSC4mC1ORSnZqeRVy4HJN4T9Ui3HhWrlIGZW/dyIl1BpeeSqhN\r\nCe98STFD2K+WNQ/lMK/w9XAJAwrsoI/tB9gIdG3EucG3YftLwNqxltaax87P65j1\r\nPoo19VmdT1kNzMf7sKynZACfjDEvQkaSE7OuqwIDAQABMA0GCSqGSIb3DQEBCwUA\r\nA4IBAQBOiYTvKzc1fBV/JSVP50Re20kT7nfXLMClzZQUk19itKOEbKJvbLCo4ZBA\r\nysquQ1duYsPG3ngtLa1RUdDwotc/qTRPMVdp0dFYzi6ZqZy5jcDixtg7wQGBhkny\r\nfBr9ihjZ5JjWO/vnMQ6/YpXxh9uukzHuXH7CwKZYFh4euKH8PBpWPXV7CUPPVksp\r\nluwTYuVMPeeBAXr2CKImAjSR0P366GpDKsYWBJklmUFW7/Ku/icaAtFslkPZjLcL\r\nEVk+zLc53xlEeWAuMhbbzCvviaH7Y2CV1ekUqnptw93HWUhIqcIjF66Zfi827rw5\r\nCAKfj/WNzhPoBsa4GSPYmtHAGgh2\r\n-----END CERTIFICATE-----",
        "ca_certificate": "-----BEGIN CERTIFICATE-----\r\nMIIFazCCA1OgAwIBAgIUD0+eSVjuHitQvByry9pGNRCK6GAwDQYJKoZIhvcNAQEL\r\nBQAwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoM\r\nGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDAeFw0yNTA0MTQxMjQ1NTNaFw0zNTA0\r\nMTIxMjQ1NTNaMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEw\r\nHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwggIiMA0GCSqGSIb3DQEB\r\nAQUAA4ICDwAwggIKAoICAQCvBeykQsOShikEmLSzuqM5xDlCz1YiUmEUy9KH+wt+\r\nM+7plo9XLFt3lX7lGYX0BSWJdRMJywIYKjZLiINcxAcAE08Nak6DxyjbQ5eHT7Il\r\n6ZprWU6t6J00nxhBZREVzC8Y82J8uRT0tMOccLyjewJJcrpk9pM6/ubtkpkoNAAH\r\ntOwUgflryuSy30npYyD9sMZLtThJdMMmrFG9+rUet+myR4mhHUfKwFToINRrjUlX\r\nOdcxiAefec1IR3u6oGamlRvFY6VknSEXl+hJqvJiXXVeHihLFa4LzFRyHFJnNkzB\r\n60p++KueFadD0xqE6oz5oV1Jz4CT0Vld91WZBZyr73FSB74HmGxAGAaDVRwRNR+g\r\nzTpVhDY7nii5iJuMByyoSkwKvAjvXHLEzOhvBYs5FYNSQRZo3Rou2LACmyCl5/lk\r\nhX4WWbv8FRrowE7AA0oEUMbbsSyk1QLU9yy7u9YM8tbkOprzkKzpqFvN8NOHA5KD\r\nw/qeS4k6HYol5LZ7Be9jVPkmkLS/QiKOr5UJRV9DQOXkzlbelKl0MRNQkdeg8atC\r\n+3A/Y+lnmAxWQXSeU7QZeX3RhwvmrixXyTsMyA9Zy+KzkvKI4nuViHKUJejJzS06\r\nhbRC/mt/9nnRPD4RSpmkF6Qi6deqL3pJzl26X0QTOTHTylVjd0XJ3o6/KbNNJYQP\r\nMwIDAQABo1MwUTAdBgNVHQ4EFgQU4CZZvd21LeyU6jRmhyV7Z/maCjowHwYDVR0j\r\nBBgwFoAU4CZZvd21LeyU6jRmhyV7Z/maCjowDwYDVR0TAQH/BAUwAwEB/zANBgkq\r\nhkiG9w0BAQsFAAOCAgEAX5IWFNKeRSkzQIrMaNnEgp5lq4SLJNCI0cjupKk0kQ7O\r\n4J1JEPzOW0/BkeDZ+eRfYblKIRLJKZUys8Sz63zsX37PrSn/OEHgoMAnbfdgpP9g\r\nIlXmj2n8Q/hH95E7D8h5ivMWOzd91RH7ObsvlwRisRuPWZajSof1XV6QYX1Lk4S+\r\nkEuRNfZRkxCHMANgjZ9Ch6CvUXjKGwc8UGBCfJMbSqnlK8t/096eDGw5IeNYkWAB\r\ngqb6fr2Cho2rCXCPd74lCn8ctRUtYHpKTzYcS4MM9ZeOhvxjs5XjE5FgMf2ogYUc\r\ntP1VUyIyqQvDh7yYjBp/GVcYij+eCTfuXGhPKBOFrXmscBbagtI+mRD1KX9KoVZw\r\n0jFM00aGfjLYFpYWHNLCBne3lMS0BW5rQCEdlCE4TB/IggjfEJFOtZ+yg5YsYcTZ\r\nngKSoOXlkhzvDqwHAFI34k0KC47jJFnvKF6v+ti0oEjX6NS7DotocU7pNYVe8+y5\r\n5PqaOxoAniIJ7uHkLEbFL8uOJOWTopO4yhOPkqScJDtBGCTBtO07I559UoEM5HT/\r\n6pmUoeUiT2PLmkbevGXvaTSgA3h276Ht5ZfxXTkL7RVlzuP4JjxZXqLpT3kxv/8p\r\nAI6AA//9zcVBtneStSPaZv+iRqBp5RlLVOnWxb2/Z8cp+Mv7IpCx6bMYr1/lw1g=\r\n-----END CERTIFICATE-----",
        "terminate_at": "AGENT"
      }
    },
    {
      "name": "cqccimvxsc-tcp",
      "endpoint": "localhost:22",
      "type": "TCP",
      "region": "EU",
      "whitelist": [
        "12.34.56.78"
      ],
      "timeout": 60
    },
    {
      "name": "cqccimvxsc-http",
      "endpoint": "localhost:8080",
      "type": "HTTP",
      "region": "EU",
      "whitelist": [
        "12.34.56.78"
      ],
      "timeout": 60
    }
  ],
  "project": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/my-project",
    "html_url": "https://app.buddy.works/buddy/my-project",
    "name": "my-project",
    "display_name": "My Project",
    "status": "ACTIVE"
  }
}

STATUS
200 OK

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999