Skip to main content
Environments can also be managed in the KeyStone Dashboard under Settings > Environments - no code required.

create / list / get / update / deactivate

env = await client.environments.create({
    "name": "Staging",
    "slug": "staging",
    "auth0_client_id": "your-staging-client-id",
    "default_timeout_seconds": 3600,
})

result = await client.environments.list()
env = await client.environments.get("env-uuid")

await client.environments.update("env-uuid", {
    "default_timeout_seconds": 7200,
    "rate_limit_rpm": 1000,
})

# Deactivate (preserves data, blocks M2M auth)
await client.environments.deactivate("env-uuid")

Environment fields

FieldTypeDescription
idUUIDEnvironment UUID
platform_idUUIDParent platform UUID
namestrDisplay name
slugstrURL-friendly identifier
auth0_client_idstrM2M credential
webhook_urlstr | NoneDefault webhook URL
api_versionstr | NonePinned API version
default_timeout_secondsintDefault settlement timeout
is_activeboolWhether M2M auth is accepted
rate_limit_rpmint | NoneRate limit override