Create an Environment
curl --request POST \
--url https://api.checkfu.com/v1/environments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'checkfu-beta: <checkfu-beta>' \
--header 'checkfu-version: <checkfu-version>' \
--data '
{
"name": "<string>",
"config": {
"type": "cloud",
"networking": {
"type": "unrestricted"
},
"packages": {
"type": "packages",
"apt": [
"<string>"
],
"cargo": [
"<string>"
],
"gem": [
"<string>"
],
"go": [
"<string>"
],
"npm": [
"<string>"
],
"pip": [
"<string>"
]
}
},
"description": "<string>",
"metadata": {}
}
'import requests
url = "https://api.checkfu.com/v1/environments"
payload = {
"name": "<string>",
"config": {
"type": "cloud",
"networking": { "type": "unrestricted" },
"packages": {
"type": "packages",
"apt": ["<string>"],
"cargo": ["<string>"],
"gem": ["<string>"],
"go": ["<string>"],
"npm": ["<string>"],
"pip": ["<string>"]
}
},
"description": "<string>",
"metadata": {}
}
headers = {
"checkfu-version": "<checkfu-version>",
"checkfu-beta": "<checkfu-beta>",
"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>',
'checkfu-beta': '<checkfu-beta>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
config: {
type: 'cloud',
networking: {type: 'unrestricted'},
packages: {
type: 'packages',
apt: ['<string>'],
cargo: ['<string>'],
gem: ['<string>'],
go: ['<string>'],
npm: ['<string>'],
pip: ['<string>']
}
},
description: '<string>',
metadata: {}
})
};
fetch('https://api.checkfu.com/v1/environments', 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/environments",
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([
'name' => '<string>',
'config' => [
'type' => 'cloud',
'networking' => [
'type' => 'unrestricted'
],
'packages' => [
'type' => 'packages',
'apt' => [
'<string>'
],
'cargo' => [
'<string>'
],
'gem' => [
'<string>'
],
'go' => [
'<string>'
],
'npm' => [
'<string>'
],
'pip' => [
'<string>'
]
]
],
'description' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"checkfu-beta: <checkfu-beta>",
"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/environments"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"config\": {\n \"type\": \"cloud\",\n \"networking\": {\n \"type\": \"unrestricted\"\n },\n \"packages\": {\n \"type\": \"packages\",\n \"apt\": [\n \"<string>\"\n ],\n \"cargo\": [\n \"<string>\"\n ],\n \"gem\": [\n \"<string>\"\n ],\n \"go\": [\n \"<string>\"\n ],\n \"npm\": [\n \"<string>\"\n ],\n \"pip\": [\n \"<string>\"\n ]\n }\n },\n \"description\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("checkfu-version", "<checkfu-version>")
req.Header.Add("checkfu-beta", "<checkfu-beta>")
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/environments")
.header("checkfu-version", "<checkfu-version>")
.header("checkfu-beta", "<checkfu-beta>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"config\": {\n \"type\": \"cloud\",\n \"networking\": {\n \"type\": \"unrestricted\"\n },\n \"packages\": {\n \"type\": \"packages\",\n \"apt\": [\n \"<string>\"\n ],\n \"cargo\": [\n \"<string>\"\n ],\n \"gem\": [\n \"<string>\"\n ],\n \"go\": [\n \"<string>\"\n ],\n \"npm\": [\n \"<string>\"\n ],\n \"pip\": [\n \"<string>\"\n ]\n }\n },\n \"description\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checkfu.com/v1/environments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["checkfu-beta"] = '<checkfu-beta>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"config\": {\n \"type\": \"cloud\",\n \"networking\": {\n \"type\": \"unrestricted\"\n },\n \"packages\": {\n \"type\": \"packages\",\n \"apt\": [\n \"<string>\"\n ],\n \"cargo\": [\n \"<string>\"\n ],\n \"gem\": [\n \"<string>\"\n ],\n \"go\": [\n \"<string>\"\n ],\n \"npm\": [\n \"<string>\"\n ],\n \"pip\": [\n \"<string>\"\n ]\n }\n },\n \"description\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"archived_at": "<string>",
"config": {
"type": "cloud",
"networking": {
"type": "unrestricted"
},
"packages": {
"apt": [
"<string>"
],
"cargo": [
"<string>"
],
"gem": [
"<string>"
],
"go": [
"<string>"
],
"npm": [
"<string>"
],
"pip": [
"<string>"
],
"type": "packages"
}
},
"created_at": "<string>",
"description": "<string>",
"metadata": {},
"name": "<string>",
"type": "environment",
"updated_at": "<string>",
"scope": "organization"
}{
"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.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"
}
}Create an Environment
Creates a CMA-compatible cloud or self-hosted Environment. Omitted cloud fields resolve to unrestricted networking and empty package lists. Self-hosted scope accepts the exact organization or account literals and defaults to account for Checkfu’s Tenant isolation boundary.
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
/
v1
/
environments
Create an Environment
curl --request POST \
--url https://api.checkfu.com/v1/environments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'checkfu-beta: <checkfu-beta>' \
--header 'checkfu-version: <checkfu-version>' \
--data '
{
"name": "<string>",
"config": {
"type": "cloud",
"networking": {
"type": "unrestricted"
},
"packages": {
"type": "packages",
"apt": [
"<string>"
],
"cargo": [
"<string>"
],
"gem": [
"<string>"
],
"go": [
"<string>"
],
"npm": [
"<string>"
],
"pip": [
"<string>"
]
}
},
"description": "<string>",
"metadata": {}
}
'import requests
url = "https://api.checkfu.com/v1/environments"
payload = {
"name": "<string>",
"config": {
"type": "cloud",
"networking": { "type": "unrestricted" },
"packages": {
"type": "packages",
"apt": ["<string>"],
"cargo": ["<string>"],
"gem": ["<string>"],
"go": ["<string>"],
"npm": ["<string>"],
"pip": ["<string>"]
}
},
"description": "<string>",
"metadata": {}
}
headers = {
"checkfu-version": "<checkfu-version>",
"checkfu-beta": "<checkfu-beta>",
"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>',
'checkfu-beta': '<checkfu-beta>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
config: {
type: 'cloud',
networking: {type: 'unrestricted'},
packages: {
type: 'packages',
apt: ['<string>'],
cargo: ['<string>'],
gem: ['<string>'],
go: ['<string>'],
npm: ['<string>'],
pip: ['<string>']
}
},
description: '<string>',
metadata: {}
})
};
fetch('https://api.checkfu.com/v1/environments', 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/environments",
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([
'name' => '<string>',
'config' => [
'type' => 'cloud',
'networking' => [
'type' => 'unrestricted'
],
'packages' => [
'type' => 'packages',
'apt' => [
'<string>'
],
'cargo' => [
'<string>'
],
'gem' => [
'<string>'
],
'go' => [
'<string>'
],
'npm' => [
'<string>'
],
'pip' => [
'<string>'
]
]
],
'description' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"checkfu-beta: <checkfu-beta>",
"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/environments"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"config\": {\n \"type\": \"cloud\",\n \"networking\": {\n \"type\": \"unrestricted\"\n },\n \"packages\": {\n \"type\": \"packages\",\n \"apt\": [\n \"<string>\"\n ],\n \"cargo\": [\n \"<string>\"\n ],\n \"gem\": [\n \"<string>\"\n ],\n \"go\": [\n \"<string>\"\n ],\n \"npm\": [\n \"<string>\"\n ],\n \"pip\": [\n \"<string>\"\n ]\n }\n },\n \"description\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("checkfu-version", "<checkfu-version>")
req.Header.Add("checkfu-beta", "<checkfu-beta>")
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/environments")
.header("checkfu-version", "<checkfu-version>")
.header("checkfu-beta", "<checkfu-beta>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"config\": {\n \"type\": \"cloud\",\n \"networking\": {\n \"type\": \"unrestricted\"\n },\n \"packages\": {\n \"type\": \"packages\",\n \"apt\": [\n \"<string>\"\n ],\n \"cargo\": [\n \"<string>\"\n ],\n \"gem\": [\n \"<string>\"\n ],\n \"go\": [\n \"<string>\"\n ],\n \"npm\": [\n \"<string>\"\n ],\n \"pip\": [\n \"<string>\"\n ]\n }\n },\n \"description\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checkfu.com/v1/environments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["checkfu-beta"] = '<checkfu-beta>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"config\": {\n \"type\": \"cloud\",\n \"networking\": {\n \"type\": \"unrestricted\"\n },\n \"packages\": {\n \"type\": \"packages\",\n \"apt\": [\n \"<string>\"\n ],\n \"cargo\": [\n \"<string>\"\n ],\n \"gem\": [\n \"<string>\"\n ],\n \"go\": [\n \"<string>\"\n ],\n \"npm\": [\n \"<string>\"\n ],\n \"pip\": [\n \"<string>\"\n ]\n }\n },\n \"description\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"archived_at": "<string>",
"config": {
"type": "cloud",
"networking": {
"type": "unrestricted"
},
"packages": {
"apt": [
"<string>"
],
"cargo": [
"<string>"
],
"gem": [
"<string>"
],
"go": [
"<string>"
],
"npm": [
"<string>"
],
"pip": [
"<string>"
],
"type": "packages"
}
},
"created_at": "<string>",
"description": "<string>",
"metadata": {},
"name": "<string>",
"type": "environment",
"updated_at": "<string>",
"scope": "organization"
}{
"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.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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Available options:
2026-08-27 Maximum string length:
255Body
application/json
Response
BetaEnvironment
Pattern:
^env_[0-9a-f]{32}$- Option 1
- Option 2
Show child attributes
Show child attributes
at most 16 correlation pairs with keys of 1 to 64 characters
Show child attributes
Show child attributes
Available options:
environment Available options:
organization, account