Create a hosted world session for an explicit drill and seed
curl --request POST \
--url https://api.firedrill.run/v1/projects/{projectId}/environments/{environmentId}/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"seed": "<string>",
"drillId": "<string>",
"scenarioId": "<string>",
"buildHash": "<string>",
"callbackReceiverBindingIds": [
"<string>"
],
"ttlMs": 302400000
}
'import requests
url = "https://api.firedrill.run/v1/projects/{projectId}/environments/{environmentId}/sessions"
payload = {
"seed": "<string>",
"drillId": "<string>",
"scenarioId": "<string>",
"buildHash": "<string>",
"callbackReceiverBindingIds": ["<string>"],
"ttlMs": 302400000
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
seed: '<string>',
drillId: '<string>',
scenarioId: '<string>',
buildHash: '<string>',
callbackReceiverBindingIds: ['<string>'],
ttlMs: 302400000
})
};
fetch('https://api.firedrill.run/v1/projects/{projectId}/environments/{environmentId}/sessions', 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.firedrill.run/v1/projects/{projectId}/environments/{environmentId}/sessions",
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([
'seed' => '<string>',
'drillId' => '<string>',
'scenarioId' => '<string>',
'buildHash' => '<string>',
'callbackReceiverBindingIds' => [
'<string>'
],
'ttlMs' => 302400000
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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.firedrill.run/v1/projects/{projectId}/environments/{environmentId}/sessions"
payload := strings.NewReader("{\n \"seed\": \"<string>\",\n \"drillId\": \"<string>\",\n \"scenarioId\": \"<string>\",\n \"buildHash\": \"<string>\",\n \"callbackReceiverBindingIds\": [\n \"<string>\"\n ],\n \"ttlMs\": 302400000\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.firedrill.run/v1/projects/{projectId}/environments/{environmentId}/sessions")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"seed\": \"<string>\",\n \"drillId\": \"<string>\",\n \"scenarioId\": \"<string>\",\n \"buildHash\": \"<string>\",\n \"callbackReceiverBindingIds\": [\n \"<string>\"\n ],\n \"ttlMs\": 302400000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firedrill.run/v1/projects/{projectId}/environments/{environmentId}/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"seed\": \"<string>\",\n \"drillId\": \"<string>\",\n \"scenarioId\": \"<string>\",\n \"buildHash\": \"<string>\",\n \"callbackReceiverBindingIds\": [\n \"<string>\"\n ],\n \"ttlMs\": 302400000\n}"
response = http.request(request)
puts response.read_body{
"session": {
"schemaVersion": 1,
"organizationId": "<string>",
"projectId": "<string>",
"environmentId": "<string>",
"sessionId": "<string>",
"buildHash": "<string>",
"seed": "<string>",
"callbackReceiverBindingIds": [],
"state": "creating",
"leaseGeneration": 4503599627370495,
"createdAtMs": 0,
"updatedAtMs": 0,
"expiresAtMs": 0,
"version": 0,
"drillId": "<string>",
"scenarioId": "<string>",
"warmPool": {
"state": "preparing",
"setupHash": "<string>"
},
"parentSessionId": "<string>",
"parentHostedSnapshotId": "<string>",
"destroyedAtMs": 0
},
"operation": {
"schemaVersion": 1,
"operationId": "<string>",
"organizationId": "<string>",
"kind": "<string>",
"state": "pending",
"idempotencyKey": "<string>",
"requestHash": "<string>",
"createdAtMs": 0,
"updatedAtMs": 0,
"projectId": "<string>",
"resourceType": "<string>",
"resourceId": "<string>",
"error": {
"schemaVersion": 1,
"code": "<string>",
"source": "framework",
"message": "<string>",
"retryable": true,
"issues": [],
"correlationId": "<string>",
"details": {},
"evidence": {
"runId": "<string>",
"sequence": 4503599627370495
}
},
"result": {
"schemaVersion": 1,
"kind": "world.time.advance",
"operationId": "<string>",
"sessionId": "<string>",
"leaseGeneration": 4503599627370495,
"buildHash": "<string>",
"correlationId": "<string>",
"requestedUs": 0,
"startedUs": 0,
"reachedUs": 0,
"maxEvents": 500000,
"scheduledEventsProcessed": 0,
"evidenceBeforeSequence": 0,
"evidenceAfterSequence": 0,
"status": "completed",
"eventBudgetExhausted": true,
"failure": {
"code": "<string>",
"message": "<string>",
"scheduledEventId": "<string>"
}
},
"cancelRequestedAtMs": 0,
"startedAtMs": 0,
"finishedAtMs": 0
}
}{
"session": {
"schemaVersion": 1,
"organizationId": "<string>",
"projectId": "<string>",
"environmentId": "<string>",
"sessionId": "<string>",
"buildHash": "<string>",
"seed": "<string>",
"callbackReceiverBindingIds": [],
"state": "creating",
"leaseGeneration": 4503599627370495,
"createdAtMs": 0,
"updatedAtMs": 0,
"expiresAtMs": 0,
"version": 0,
"drillId": "<string>",
"scenarioId": "<string>",
"warmPool": {
"state": "preparing",
"setupHash": "<string>"
},
"parentSessionId": "<string>",
"parentHostedSnapshotId": "<string>",
"destroyedAtMs": 0
},
"operation": {
"schemaVersion": 1,
"operationId": "<string>",
"organizationId": "<string>",
"kind": "<string>",
"state": "pending",
"idempotencyKey": "<string>",
"requestHash": "<string>",
"createdAtMs": 0,
"updatedAtMs": 0,
"projectId": "<string>",
"resourceType": "<string>",
"resourceId": "<string>",
"error": {
"schemaVersion": 1,
"code": "<string>",
"source": "framework",
"message": "<string>",
"retryable": true,
"issues": [],
"correlationId": "<string>",
"details": {},
"evidence": {
"runId": "<string>",
"sequence": 4503599627370495
}
},
"result": {
"schemaVersion": 1,
"kind": "world.time.advance",
"operationId": "<string>",
"sessionId": "<string>",
"leaseGeneration": 4503599627370495,
"buildHash": "<string>",
"correlationId": "<string>",
"requestedUs": 0,
"startedUs": 0,
"reachedUs": 0,
"maxEvents": 500000,
"scheduledEventsProcessed": 0,
"evidenceBeforeSequence": 0,
"evidenceAfterSequence": 0,
"status": "completed",
"eventBudgetExhausted": true,
"failure": {
"code": "<string>",
"message": "<string>",
"scheduledEventId": "<string>"
}
},
"cancelRequestedAtMs": 0,
"startedAtMs": 0,
"finishedAtMs": 0
}
}{
"code": "<string>",
"message": "<string>",
"correlationId": "<string>",
"retryable": true,
"source": "platform",
"retryAfterMs": 123,
"operationId": "<string>",
"issues": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": {},
"evidence": {
"sessionId": "<string>",
"runId": "<string>",
"journalSeq": 4503599627370495,
"buildHash": "<string>"
}
}Create a hosted world session for an explicit drill and seed
Create a hosted world session for an explicit drill and seed
curl --request POST \
--url https://api.firedrill.run/v1/projects/{projectId}/environments/{environmentId}/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"seed": "<string>",
"drillId": "<string>",
"scenarioId": "<string>",
"buildHash": "<string>",
"callbackReceiverBindingIds": [
"<string>"
],
"ttlMs": 302400000
}
'import requests
url = "https://api.firedrill.run/v1/projects/{projectId}/environments/{environmentId}/sessions"
payload = {
"seed": "<string>",
"drillId": "<string>",
"scenarioId": "<string>",
"buildHash": "<string>",
"callbackReceiverBindingIds": ["<string>"],
"ttlMs": 302400000
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
seed: '<string>',
drillId: '<string>',
scenarioId: '<string>',
buildHash: '<string>',
callbackReceiverBindingIds: ['<string>'],
ttlMs: 302400000
})
};
fetch('https://api.firedrill.run/v1/projects/{projectId}/environments/{environmentId}/sessions', 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.firedrill.run/v1/projects/{projectId}/environments/{environmentId}/sessions",
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([
'seed' => '<string>',
'drillId' => '<string>',
'scenarioId' => '<string>',
'buildHash' => '<string>',
'callbackReceiverBindingIds' => [
'<string>'
],
'ttlMs' => 302400000
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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.firedrill.run/v1/projects/{projectId}/environments/{environmentId}/sessions"
payload := strings.NewReader("{\n \"seed\": \"<string>\",\n \"drillId\": \"<string>\",\n \"scenarioId\": \"<string>\",\n \"buildHash\": \"<string>\",\n \"callbackReceiverBindingIds\": [\n \"<string>\"\n ],\n \"ttlMs\": 302400000\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.firedrill.run/v1/projects/{projectId}/environments/{environmentId}/sessions")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"seed\": \"<string>\",\n \"drillId\": \"<string>\",\n \"scenarioId\": \"<string>\",\n \"buildHash\": \"<string>\",\n \"callbackReceiverBindingIds\": [\n \"<string>\"\n ],\n \"ttlMs\": 302400000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firedrill.run/v1/projects/{projectId}/environments/{environmentId}/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"seed\": \"<string>\",\n \"drillId\": \"<string>\",\n \"scenarioId\": \"<string>\",\n \"buildHash\": \"<string>\",\n \"callbackReceiverBindingIds\": [\n \"<string>\"\n ],\n \"ttlMs\": 302400000\n}"
response = http.request(request)
puts response.read_body{
"session": {
"schemaVersion": 1,
"organizationId": "<string>",
"projectId": "<string>",
"environmentId": "<string>",
"sessionId": "<string>",
"buildHash": "<string>",
"seed": "<string>",
"callbackReceiverBindingIds": [],
"state": "creating",
"leaseGeneration": 4503599627370495,
"createdAtMs": 0,
"updatedAtMs": 0,
"expiresAtMs": 0,
"version": 0,
"drillId": "<string>",
"scenarioId": "<string>",
"warmPool": {
"state": "preparing",
"setupHash": "<string>"
},
"parentSessionId": "<string>",
"parentHostedSnapshotId": "<string>",
"destroyedAtMs": 0
},
"operation": {
"schemaVersion": 1,
"operationId": "<string>",
"organizationId": "<string>",
"kind": "<string>",
"state": "pending",
"idempotencyKey": "<string>",
"requestHash": "<string>",
"createdAtMs": 0,
"updatedAtMs": 0,
"projectId": "<string>",
"resourceType": "<string>",
"resourceId": "<string>",
"error": {
"schemaVersion": 1,
"code": "<string>",
"source": "framework",
"message": "<string>",
"retryable": true,
"issues": [],
"correlationId": "<string>",
"details": {},
"evidence": {
"runId": "<string>",
"sequence": 4503599627370495
}
},
"result": {
"schemaVersion": 1,
"kind": "world.time.advance",
"operationId": "<string>",
"sessionId": "<string>",
"leaseGeneration": 4503599627370495,
"buildHash": "<string>",
"correlationId": "<string>",
"requestedUs": 0,
"startedUs": 0,
"reachedUs": 0,
"maxEvents": 500000,
"scheduledEventsProcessed": 0,
"evidenceBeforeSequence": 0,
"evidenceAfterSequence": 0,
"status": "completed",
"eventBudgetExhausted": true,
"failure": {
"code": "<string>",
"message": "<string>",
"scheduledEventId": "<string>"
}
},
"cancelRequestedAtMs": 0,
"startedAtMs": 0,
"finishedAtMs": 0
}
}{
"session": {
"schemaVersion": 1,
"organizationId": "<string>",
"projectId": "<string>",
"environmentId": "<string>",
"sessionId": "<string>",
"buildHash": "<string>",
"seed": "<string>",
"callbackReceiverBindingIds": [],
"state": "creating",
"leaseGeneration": 4503599627370495,
"createdAtMs": 0,
"updatedAtMs": 0,
"expiresAtMs": 0,
"version": 0,
"drillId": "<string>",
"scenarioId": "<string>",
"warmPool": {
"state": "preparing",
"setupHash": "<string>"
},
"parentSessionId": "<string>",
"parentHostedSnapshotId": "<string>",
"destroyedAtMs": 0
},
"operation": {
"schemaVersion": 1,
"operationId": "<string>",
"organizationId": "<string>",
"kind": "<string>",
"state": "pending",
"idempotencyKey": "<string>",
"requestHash": "<string>",
"createdAtMs": 0,
"updatedAtMs": 0,
"projectId": "<string>",
"resourceType": "<string>",
"resourceId": "<string>",
"error": {
"schemaVersion": 1,
"code": "<string>",
"source": "framework",
"message": "<string>",
"retryable": true,
"issues": [],
"correlationId": "<string>",
"details": {},
"evidence": {
"runId": "<string>",
"sequence": 4503599627370495
}
},
"result": {
"schemaVersion": 1,
"kind": "world.time.advance",
"operationId": "<string>",
"sessionId": "<string>",
"leaseGeneration": 4503599627370495,
"buildHash": "<string>",
"correlationId": "<string>",
"requestedUs": 0,
"startedUs": 0,
"reachedUs": 0,
"maxEvents": 500000,
"scheduledEventsProcessed": 0,
"evidenceBeforeSequence": 0,
"evidenceAfterSequence": 0,
"status": "completed",
"eventBudgetExhausted": true,
"failure": {
"code": "<string>",
"message": "<string>",
"scheduledEventId": "<string>"
}
},
"cancelRequestedAtMs": 0,
"startedAtMs": 0,
"finishedAtMs": 0
}
}{
"code": "<string>",
"message": "<string>",
"correlationId": "<string>",
"retryable": true,
"source": "platform",
"retryAfterMs": 123,
"operationId": "<string>",
"issues": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": {},
"evidence": {
"sessionId": "<string>",
"runId": "<string>",
"journalSeq": 4503599627370495,
"buildHash": "<string>"
}
}Authorizations
Opaque control credential
Headers
Required string length:
8 - 128Pattern:
^[A-Za-z0-9._:-]+$Path Parameters
Pattern:
^prj_[0-9a-z]{12,32}$Pattern:
^env_[0-9a-z]{12,32}$Body
application/json
Pattern:
^(0|[1-9]\d{0,19})$Run-ready setup from this drill. Mutually exclusive with scenarioId; omit both selectors for the build baseline.
Required string length:
1 - 96Pattern:
^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$Standalone setup from this compiled scenario, without a drill or target. Mutually exclusive with drillId.
Required string length:
1 - 96Pattern:
^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$Opt-in warm allocation. prepare reserves one real world without granting access (TTL defaults to and cannot exceed 300000 ms). prefer checks out an exact compatible prepared world or creates a cold world. Omit for unchanged cold creation; no automatic pool refill occurs.
Available options:
prepare, prefer Pattern:
^sha256:[0-9a-f]{64}$Explicit approved receiver bindings for this session. Omit or pass an empty list to select none. Forks and reruns retain this exact selection; they never use project defaults.
Maximum array length:
64Pattern:
^cbr_[0-9a-z]{12,32}$Required range:
0 < x <= 604800000