Skip to main content
POST
/
core.v1.SatelliteService
/
CreateSatellite
cURL
curl -X POST "https://api.joinformal.com/core.v1.SatelliteService/CreateSatellite" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "satellite": {
    "id": "<string>",
    "name": "<string>",
    "terminationProtection": true,
    "spaceId": "<string>",
    "space": {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "terminationProtection": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "satelliteType": "data_discovery",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.formal.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

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

Body

application/json
​
name
string
Minimum string length: 1
​
terminationProtection
boolean
​
spaceId
string | null
​
satelliteType
enum<string>
Available options:
data_discovery,
data_classifier,
policy_data_loader,
ai

Response

Success

​
satellite
satellite · object