Services
Start a service
Start a named service inside a session and optionally wait for its port to become reachable. Services keep running independently of exec calls.
POST
/projects/{projectId}/sessions/{sessionId}/servicesHTTP client
Set up your HTTP client with the auth header before calling the API. Match the authentication type shown above.
const BASE_URL = 'https://api.mudbase.dev/api/sandboxes';
const HEADERS = {
'x-api-key': 'sk_YOUR_API_KEY',
'Content-Type': 'application/json',
};const BASE_URL = 'https://api.mudbase.dev/api/sandboxes';
const HEADERS = {
'x-api-key': 'sk_YOUR_API_KEY',
'Content-Type': 'application/json',
};Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const res = await fetch('https://api.mudbase.dev/api/sandboxes/projects/YOUR_PROJECT_ID/sessions/YOUR_SESSION_ID/services', {
method: 'POST',
headers: HEADERS,
body: JSON.stringify({
"name": "Johnathan Torp I",
"cmd": "protocol calculate",
"args": [
"sensor hack"
],
"cwd": "interface connect",
"port": 97096,
"waitForPort": true,
"timeoutMs": 39262
}),
});
const data = await res.json();const res = await fetch('https://api.mudbase.dev/api/sandboxes/projects/YOUR_PROJECT_ID/sessions/YOUR_SESSION_ID/services', {
method: 'POST',
headers: HEADERS,
body: JSON.stringify({
"name": "Johnathan Torp I",
"cmd": "protocol calculate",
"args": [
"sensor hack"
],
"cwd": "interface connect",
"port": 97096,
"waitForPort": true,
"timeoutMs": 39262
}),
});
const data = await res.json();Playground
liveTest this endpoint with your own credentials. Your requests will be sent to the live API.
Get your API key from the console
No Request Yet
Send a request to see the full inspector
Authentication
Requires API Key
Note
Include your API key in the
X-API-Key: YOUR_KEY header (server-to-server, SDKs). View authentication guide →Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | - |
sessionId | string | Yes | - |
Request Body
json
{
"name": "Johnathan Torp I",
"cmd": "protocol calculate",
"args": [
"sensor hack"
],
"cwd": "interface connect",
"port": 97096,
"env": {},
"waitForPort": true,
"timeoutMs": 39262
}{
"name": "Johnathan Torp I",
"cmd": "protocol calculate",
"args": [
"sensor hack"
],
"cwd": "interface connect",
"port": 97096,
"env": {},
"waitForPort": true,
"timeoutMs": 39262
}Responses
200Service started.