Skip to main content
GET
/
api
/
v3
/
projects
/
settings
Get project settings
curl --request GET \
  --url https://playflow.dev/api/api/v3/projects/settings \
  --header 'api-key: <api-key>'
{
  "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

Response

Complete current project settings.

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.