Environments

Create an environment

POST
Create a new environment

Request

This endpoint expects an object.
name
stringRequired
The name of the environment
isProd
booleanRequired
Whether or not the environment is a production environment
guestAuthentication
list of enumsOptional
The type of authentication to use for guests
Allowed values: shared_linkmagic_link
metadata
map from strings to anyOptional
translationsPath
stringOptional
namespaces
list of stringsOptional
languageOverride
stringOptional

Response

This endpoint returns an object
data
object
POST
$curl -X POST https://api.x.flatfile.com/v1/environments \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "dev",
>  "isProd": false,
>  "guestAuthentication": [
>    "magic_link"
>  ],
>  "metadata": {
>    "key": "value"
>  },
>  "namespaces": [
>    "default"
>  ]
>}'
Response
1{
2  "data": {
3    "id": "us_env_YOUR_ID",
4    "accountId": "us_acc_YOUR_ID",
5    "name": "dev",
6    "isProd": false,
7    "guestAuthentication": [
8      "magic_link"
9    ],
10    "features": {},
11    "metadata": {},
12    "namespaces": [
13      "default"
14    ]
15  }
16}
Built with