Skip to main content
POST
/
core.v1.SidecarService
/
CreateSidecar
cURL
curl -X POST "https://api.joinformal.com/core.v1.SidecarService/CreateSidecar" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "sidecar": {
    "id": "<string>",
    "name": "<string>",
    "hostname": "<string>",
    "terminationProtection": true,
    "deployed": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json
​
name
string
Required string length: 3 - 63
Pattern: ^[0-9a-z\-]+$
​
technology
enum<string>
Available options:
ssh,
postgres,
mysql,
mongodb,
snowflake,
http,
s3,
dynamodb,
bigquery,
kubernetes,
llm,
multi
​
hostname
string
​
terminationProtection
boolean

Response

Success

​
sidecar
sidecar · object