Skip to main content
POST
cURL

Authorizations

X-API-KEY
string
header
required

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

Body

application/json

Exactly one of these fields is required: aws or gcp.

name
string
Minimum string length: 1
cloudRegion
string

required for AWS, unused for GCP

type
string

TODO: remove, deprecated by oneof cloud (2025-02-24)

aws
aws · object

One of the discriminated union fields - use exactly one

gcp
gcp · object

One of the discriminated union fields - use exactly one

Response

Success

url
string
id
string
Minimum string length: 1
securityKey
string