Skip to main content
POST
/
api
/
v3
/
projects
/
settings
Update project settings
curl --request POST \
  --url https://playflow.dev/api/api/v3/projects/settings \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "port_configs": [
    {
      "name": "<string>",
      "internal_port": 32768,
      "protocol": "udp",
      "tls_enabled": true,
      "id": "<string>"
    }
  ],
  "auth_config": {
    "provider": "none"
  },
  "environment_variables": {},
  "pool_config": {
    "enabled": true,
    "regions": {}
  },
  "lobby_configs": [
    {
      "id": "<string>",
      "name": "<string>",
      "enabled": true,
      "timeout": 2,
      "heartbeat": true,
      "heartbeatTimeout": 123,
      "customProperties": {},
      "inviteCodeConfig": {
        "type": "numeric",
        "length": 8,
        "prefix": "<string>"
      },
      "serverSettings": {},
      "matchmaking": {
        "modes": {}
      }
    }
  ]
}
'
{
  "port_configs": [
    {
      "name": "<string>",
      "internal_port": 32768,
      "protocol": "udp",
      "tls_enabled": true,
      "id": "<string>"
    }
  ],
  "auth_config": {
    "provider": "none"
  },
  "environment_variables": {},
  "pool_config": {
    "enabled": true,
    "regions": {}
  },
  "lobby_configs": [
    {
      "id": "<string>",
      "name": "<string>",
      "enabled": true,
      "timeout": 2,
      "heartbeat": true,
      "heartbeatTimeout": 123,
      "customProperties": {},
      "inviteCodeConfig": {
        "type": "numeric",
        "length": 8,
        "prefix": "<string>"
      },
      "serverSettings": {},
      "matchmaking": {
        "modes": {}
      }
    }
  ],
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
api-key
string
header
required

Body

application/json

Project settings to update. All fields are optional — only include what you want to change. Omitted fields remain unchanged.

​
port_configs
object[]

Network port configuration for all servers in this project (max 10 ports). Defines which ports PlayFlow allocates for each server.

Maximum array length: 10
​
auth_config
object

Player authentication provider configuration. Determines how player tokens are verified.

​
environment_variables
object

Default environment variables injected into every game server. Can be overridden per-server at start time.

​
pool_config
object

Server pool configuration for reducing cold-start latency. Set to { enabled: false, regions: {} } to disable pooling.

​
lobby_configs
object[]

Lobby and matchmaking configuration. Defines lobby types, team structures, and matching rules (max 20).

Maximum array length: 20

Response

Updated project settings (returns all fields, including unchanged ones).

Complete current project settings including ports, auth, environment, pool, and lobby configurations.

​
port_configs
object[]
required

Current network port configuration for the project.

​
auth_config
object
required

Current player authentication configuration.

​
environment_variables
object
required

Current default environment variables for all servers.

​
pool_config
object
required

Current server pool configuration. Null if pooling has never been configured.

​
lobby_configs
object[]
required

Current lobby and matchmaking configurations.

​
updated_at
string<date-time>
required

ISO 8601 timestamp of the last settings update.