Skip to main content
POST
/
core.v1.ResourceService
/
CreateResource
cURL
curl -X POST "https://api.joinformal.com/core.v1.ResourceService/CreateResource" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "resource": {
    "id": "<string>",
    "name": "<string>",
    "technology": "ssh",
    "hostname": "<string>",
    "port": 123,
    "environment": "<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"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "provider": "",
    "tags": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  }
}

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
hostname
string
Minimum string length: 1
port
integer<int32>
Required range: x <= 65535
technology
enum<string>
Available options:
athena,
bigquery,
clickhouse,
dynamodb,
elastic,
grpc,
http,
kafka,
kubernetes,
mariadb,
mcp,
mongodb,
mssqlserver,
mysql,
postgres,
redis,
s3,
snowflake,
ssh,
web
environment
string
terminationProtection
boolean
spaceId
string | null
tags
ResourceTag · object[]

Response

Success

resource
resource · object