curl -X POST "https://api.joinformal.com/core.v1.SidecarService/CreateSidecarResourceLink" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"example": "value"
}'{
"link": {
"id": "<string>",
"sidecar": {
"id": "<string>",
"name": "<string>",
"technology": "ssh",
"hostname": "<string>",
"terminationProtection": true,
"deployed": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"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": ""
},
"port": 123,
"terminationProtection": true
}
}curl -X POST "https://api.joinformal.com/core.v1.SidecarService/CreateSidecarResourceLink" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"example": "value"
}'{
"link": {
"id": "<string>",
"sidecar": {
"id": "<string>",
"name": "<string>",
"technology": "ssh",
"hostname": "<string>",
"terminationProtection": true,
"deployed": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"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": ""
},
"port": 123,
"terminationProtection": true
}
}API key authentication. Get your API key from the Formal dashboard.
Success
Show child attributes
1Show child attributes
11ssh, postgres, mysql, mongodb, snowflake, http, s3, bigquery, kubernetes, multi timestamp.lt_now = true
timestamp.lt_now = true
Show child attributes
11ssh, postgres, mysql, mongodb, snowflake, http, s3, bigquery, kubernetes, multi, clickhouse, redis, grpc, mcp, web 1x <= 65535Show child attributes
11timestamp.lt_now = true
timestamp.lt_now = true
timestamp.lt_now = true
timestamp.lt_now = true
, aws-ec2, aws-ecs x <= 65535Was this page helpful?