Create from existing Sandbox

POST
/workspaces
/:workspace
/sandboxes

Creates a new sandbox by cloning an existing one.

Request

REQUIRED SCOPES

WORKSPACE, SANDBOX_MANAGE

URL PARAMETERS

workspacerequired string

The workspace name.

GET PARAMETERS

project_namerequired string

The name ID of the project.

POST PARAMETERS

source_sandbox_idrequired string

The ID of the existing sandbox.

namerequired string

The name of the new sandbox.

identifierrequired string

The sandbox identifier. It can consist of uppercase and lowercase letters, numbers, underscores, and hyphens. It must start with a letter.

Last modified on Sep 10, 2025

Create New Sandbox Create New Sandbox from Snapshot

Example:

curl -X POST "https://api.buddy.works/workspaces/:workspace/sandboxes" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "source_sandbox_id": "re8w7e7brgnyi",
  "name": "Clone my Sandbox",
  "identifier": "clone-my-sandbox"
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/sandboxes/vyoz35pho7rau",
  "html_url": "https://app.buddy.works/buddy/my-project/sandboxes/vyoz35pho7rau",
  "id": "vyoz35pho7rau",
  "identifier": "clone-my-sandbox",
  "name": "Clone my Sandbox",
  "status": "STARTING",
  "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": "NONE",
  "setup_status": "CONFIGURING",
  "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
201 Created

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