Publish a SandboxProfileRevision

curl --request POST \
  --url https://api.checkfu.com/v1/sandbox-profiles/{id}/revisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "expected_resource_version": 1,
  "base_image": {
    "reference": "<string>",
    "digest": "<string>"
  },
  "packages": [
    {
      "name": "<string>",
      "version": "<string>"
    }
  ],
  "network_policy": {
    "mode": "none",
    "allowed_hosts": [
      "<string>"
    ]
  },
  "resource_limits": {
    "cpu_millis": 1,
    "memory_mib": 1,
    "disk_mib": 1,
    "max_duration_seconds": 1
  }
}
'

import requests

url = "https://api.checkfu.com/v1/sandbox-profiles/{id}/revisions"

payload = {
    "expected_resource_version": 1,
    "base_image": {
        "reference": "<string>",
        "digest": "<string>"
    },
    "packages": [
        {
            "name": "<string>",
            "version": "<string>"
        }
    ],
    "network_policy": {
        "mode": "none",
        "allowed_hosts": ["<string>"]
    },
    "resource_limits": {
        "cpu_millis": 1,
        "memory_mib": 1,
        "disk_mib": 1,
        "max_duration_seconds": 1
    }
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'checkfu-version': '<checkfu-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    expected_resource_version: 1,
    base_image: {reference: '<string>', digest: '<string>'},
    packages: [{name: '<string>', version: '<string>'}],
    network_policy: {mode: 'none', allowed_hosts: ['<string>']},
    resource_limits: {cpu_millis: 1, memory_mib: 1, disk_mib: 1, max_duration_seconds: 1}
  })
};

fetch('https://api.checkfu.com/v1/sandbox-profiles/{id}/revisions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checkfu.com/v1/sandbox-profiles/{id}/revisions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'expected_resource_version' => 1,
    'base_image' => [
        'reference' => '<string>',
        'digest' => '<string>'
    ],
    'packages' => [
        [
                'name' => '<string>',
                'version' => '<string>'
        ]
    ],
    'network_policy' => [
        'mode' => 'none',
        'allowed_hosts' => [
                '<string>'
        ]
    ],
    'resource_limits' => [
        'cpu_millis' => 1,
        'memory_mib' => 1,
        'disk_mib' => 1,
        'max_duration_seconds' => 1
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-version: <checkfu-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checkfu.com/v1/sandbox-profiles/{id}/revisions"

	payload := strings.NewReader("{\n  \"expected_resource_version\": 1,\n  \"base_image\": {\n    \"reference\": \"<string>\",\n    \"digest\": \"<string>\"\n  },\n  \"packages\": [\n    {\n      \"name\": \"<string>\",\n      \"version\": \"<string>\"\n    }\n  ],\n  \"network_policy\": {\n    \"mode\": \"none\",\n    \"allowed_hosts\": [\n      \"<string>\"\n    ]\n  },\n  \"resource_limits\": {\n    \"cpu_millis\": 1,\n    \"memory_mib\": 1,\n    \"disk_mib\": 1,\n    \"max_duration_seconds\": 1\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.checkfu.com/v1/sandbox-profiles/{id}/revisions")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expected_resource_version\": 1,\n  \"base_image\": {\n    \"reference\": \"<string>\",\n    \"digest\": \"<string>\"\n  },\n  \"packages\": [\n    {\n      \"name\": \"<string>\",\n      \"version\": \"<string>\"\n    }\n  ],\n  \"network_policy\": {\n    \"mode\": \"none\",\n    \"allowed_hosts\": [\n      \"<string>\"\n    ]\n  },\n  \"resource_limits\": {\n    \"cpu_millis\": 1,\n    \"memory_mib\": 1,\n    \"disk_mib\": 1,\n    \"max_duration_seconds\": 1\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/sandbox-profiles/{id}/revisions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expected_resource_version\": 1,\n  \"base_image\": {\n    \"reference\": \"<string>\",\n    \"digest\": \"<string>\"\n  },\n  \"packages\": [\n    {\n      \"name\": \"<string>\",\n      \"version\": \"<string>\"\n    }\n  ],\n  \"network_policy\": {\n    \"mode\": \"none\",\n    \"allowed_hosts\": [\n      \"<string>\"\n    ]\n  },\n  \"resource_limits\": {\n    \"cpu_millis\": 1,\n    \"memory_mib\": 1,\n    \"disk_mib\": 1,\n    \"max_duration_seconds\": 1\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "sandbox_profile_id": "<string>",
  "workspace_id": "<string>",
  "revision_number": 1,
  "template": {
    "tier": "container",
    "base_image": {
      "reference": "<string>",
      "digest": "<string>"
    },
    "packages": [
      {
        "manager": "apt",
        "name": "<string>",
        "version": "<string>"
      }
    ],
    "network_policy": {
      "mode": "none",
      "allowed_hosts": [
        "<string>"
      ],
      "required_egress_certification": "advisory_filter",
      "egress_presets": {
        "version": 1,
        "presets": [
          "package_managers"
        ]
      }
    },
    "resource_limits": {
      "cpu_millis": 1,
      "memory_mib": 1,
      "disk_mib": 1,
      "max_duration_seconds": 1
    },
    "retention_mode": "durable"
  },
  "derived_image_digest": "<string>",
  "published_by": {
    "kind": "system"
  },
  "published_at": "<string>"
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "validation.conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-conflict"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Publish a SandboxProfileRevision

Publishes the next immutable SandboxProfileRevision under the same logical name, guarded by expected_version. The payload is a complete replacement snapshot, not a patch: every template field you want retained must be sent. Existing Sessions keep the version they admitted. Returns the new version with 201; send Idempotency-Key to make retries safe.

Checkfu support posture: alpha; hosted. Required evidence journey: sandbox-conformance. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.

POST

sandbox-profiles

{id}

revisions

Publish a SandboxProfileRevision

curl --request POST \
  --url https://api.checkfu.com/v1/sandbox-profiles/{id}/revisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "expected_resource_version": 1,
  "base_image": {
    "reference": "<string>",
    "digest": "<string>"
  },
  "packages": [
    {
      "name": "<string>",
      "version": "<string>"
    }
  ],
  "network_policy": {
    "mode": "none",
    "allowed_hosts": [
      "<string>"
    ]
  },
  "resource_limits": {
    "cpu_millis": 1,
    "memory_mib": 1,
    "disk_mib": 1,
    "max_duration_seconds": 1
  }
}
'

import requests

url = "https://api.checkfu.com/v1/sandbox-profiles/{id}/revisions"

payload = {
    "expected_resource_version": 1,
    "base_image": {
        "reference": "<string>",
        "digest": "<string>"
    },
    "packages": [
        {
            "name": "<string>",
            "version": "<string>"
        }
    ],
    "network_policy": {
        "mode": "none",
        "allowed_hosts": ["<string>"]
    },
    "resource_limits": {
        "cpu_millis": 1,
        "memory_mib": 1,
        "disk_mib": 1,
        "max_duration_seconds": 1
    }
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'checkfu-version': '<checkfu-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    expected_resource_version: 1,
    base_image: {reference: '<string>', digest: '<string>'},
    packages: [{name: '<string>', version: '<string>'}],
    network_policy: {mode: 'none', allowed_hosts: ['<string>']},
    resource_limits: {cpu_millis: 1, memory_mib: 1, disk_mib: 1, max_duration_seconds: 1}
  })
};

fetch('https://api.checkfu.com/v1/sandbox-profiles/{id}/revisions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checkfu.com/v1/sandbox-profiles/{id}/revisions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'expected_resource_version' => 1,
    'base_image' => [
        'reference' => '<string>',
        'digest' => '<string>'
    ],
    'packages' => [
        [
                'name' => '<string>',
                'version' => '<string>'
        ]
    ],
    'network_policy' => [
        'mode' => 'none',
        'allowed_hosts' => [
                '<string>'
        ]
    ],
    'resource_limits' => [
        'cpu_millis' => 1,
        'memory_mib' => 1,
        'disk_mib' => 1,
        'max_duration_seconds' => 1
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-version: <checkfu-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checkfu.com/v1/sandbox-profiles/{id}/revisions"

	payload := strings.NewReader("{\n  \"expected_resource_version\": 1,\n  \"base_image\": {\n    \"reference\": \"<string>\",\n    \"digest\": \"<string>\"\n  },\n  \"packages\": [\n    {\n      \"name\": \"<string>\",\n      \"version\": \"<string>\"\n    }\n  ],\n  \"network_policy\": {\n    \"mode\": \"none\",\n    \"allowed_hosts\": [\n      \"<string>\"\n    ]\n  },\n  \"resource_limits\": {\n    \"cpu_millis\": 1,\n    \"memory_mib\": 1,\n    \"disk_mib\": 1,\n    \"max_duration_seconds\": 1\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.checkfu.com/v1/sandbox-profiles/{id}/revisions")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expected_resource_version\": 1,\n  \"base_image\": {\n    \"reference\": \"<string>\",\n    \"digest\": \"<string>\"\n  },\n  \"packages\": [\n    {\n      \"name\": \"<string>\",\n      \"version\": \"<string>\"\n    }\n  ],\n  \"network_policy\": {\n    \"mode\": \"none\",\n    \"allowed_hosts\": [\n      \"<string>\"\n    ]\n  },\n  \"resource_limits\": {\n    \"cpu_millis\": 1,\n    \"memory_mib\": 1,\n    \"disk_mib\": 1,\n    \"max_duration_seconds\": 1\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/sandbox-profiles/{id}/revisions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expected_resource_version\": 1,\n  \"base_image\": {\n    \"reference\": \"<string>\",\n    \"digest\": \"<string>\"\n  },\n  \"packages\": [\n    {\n      \"name\": \"<string>\",\n      \"version\": \"<string>\"\n    }\n  ],\n  \"network_policy\": {\n    \"mode\": \"none\",\n    \"allowed_hosts\": [\n      \"<string>\"\n    ]\n  },\n  \"resource_limits\": {\n    \"cpu_millis\": 1,\n    \"memory_mib\": 1,\n    \"disk_mib\": 1,\n    \"max_duration_seconds\": 1\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "sandbox_profile_id": "<string>",
  "workspace_id": "<string>",
  "revision_number": 1,
  "template": {
    "tier": "container",
    "base_image": {
      "reference": "<string>",
      "digest": "<string>"
    },
    "packages": [
      {
        "manager": "apt",
        "name": "<string>",
        "version": "<string>"
      }
    ],
    "network_policy": {
      "mode": "none",
      "allowed_hosts": [
        "<string>"
      ],
      "required_egress_certification": "advisory_filter",
      "egress_presets": {
        "version": 1,
        "presets": [
          "package_managers"
        ]
      }
    },
    "resource_limits": {
      "cpu_millis": 1,
      "memory_mib": 1,
      "disk_mib": 1,
      "max_duration_seconds": 1
    },
    "retention_mode": "durable"
  },
  "derived_image_digest": "<string>",
  "published_by": {
    "kind": "system"
  },
  "published_at": "<string>"
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "validation.conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-conflict"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version

enum<string>

required

Available options:

2026-08-27

idempotency-key

string

Maximum string length: 255

Path Parameters

string

required

Pattern: ^sprof_[0-9a-f]{32}$

Body

application/json

expected_resource_version

integer

required

Required range: x > 0

tier

enum<string>

required

Available options:

container,

microvm

base_image

object

required

Show child attributes

packages

object[]

required

Maximum array length: 256

Show child attributes

network_policy

object

required

Option 1
Option 2
Option 3

Show child attributes

resource_limits

object

required

Show child attributes

retention_mode

enum<string>

required

Available options:

durable,

ephemeral_zdr

Response

Success

sandbox_profile_id

string

required

Pattern: ^sprof_[0-9a-f]{32}$

workspace_id

string

required

Pattern: ^wrkspc_[0-9a-f]{32}$

revision_number

integer

required

Required range: x > 0

template

object

required

Show child attributes

derived_image_digest

string

required

Pattern: ^sha256:[0-9a-f]{64}$

published_by

object

required

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

published_at

string

required

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Publish a SandboxProfileRevision

Authorizations

Headers

Path Parameters

Body

Response