Skip to main content

CksEnvironment

A provisioned (or provisioning/destroyed) tenant environment. status tracks provisioning lifecycle; billingStatus tracks payment lifecycle — they are independent.

type CksEnvironment {
  id: String!
  orgId: BigInt!
  slug: String!
  displayName: String!
  primaryCloud: String!
  primaryRegion: String!
  status: String!
  subdomainHandle: String
  desiredEnvironmentVersion: String
  observedEnvironmentVersion: String
  databaseFlavor: String
  gameApiFlavor: String
  udpBuddyFlavor: String
  caddyFlavor: String
  gameApiMinServers: Int!
  gameApiMaxServers: Int!
  udpBuddyMinServers: Int!
  udpBuddyMaxServers: Int!
  loadBalancerCount: Int!
  environmentClass: String!
  singleBoxFlavor: String
  isShared: Boolean!
  buddyBillingTier: Int
  graphqlBillingTier: Int
  postgresBillingTier: Int
  billingStatus: String!
  billingGraceDeadline: DateTime
  suspendedAt: DateTime
  createdAt: DateTime!
  updatedAt: DateTime!
}

Fields​

CksEnvironment.id ● String! non-null scalar​

Opaque environment UUID (cks_environments.id).

CksEnvironment.orgId ● BigInt! non-null scalar​

Owning organization id (BigInt).

CksEnvironment.slug ● String! non-null scalar​

URL-safe environment identifier, stable for the environment's lifetime. Auto-generated as 'e-<12 chars>' unless a custom slug was supplied at creation.

CksEnvironment.displayName ● String! non-null scalar​

CksEnvironment.primaryCloud ● String! non-null scalar​

Cloud provider, e.g. 'ovh'.

CksEnvironment.primaryRegion ● String! non-null scalar​

Primary datacenter/region code, e.g. 'GRA11'.

CksEnvironment.status ● String! non-null scalar​

Provisioning lifecycle (NOT billing): deploy_requested -> provisioning -> active; deploy_failed on error; destroy_requested -> destroyed (destroy_failed on error). See billingStatus for payment state.

CksEnvironment.subdomainHandle ● String scalar​

Subdomain handle used to build the environment public URLs. Null until assigned.

CksEnvironment.desiredEnvironmentVersion ● String scalar​

Environment release version the platform is driving toward (target/desired state).

CksEnvironment.observedEnvironmentVersion ● String scalar​

Release version actually observed running. Lags desiredEnvironmentVersion while a deploy is in progress.

CksEnvironment.databaseFlavor ● String scalar​

CksEnvironment.gameApiFlavor ● String scalar​

CksEnvironment.udpBuddyFlavor ● String scalar​

CksEnvironment.caddyFlavor ● String scalar​

CksEnvironment.gameApiMinServers ● Int! non-null scalar​

CksEnvironment.gameApiMaxServers ● Int! non-null scalar​

CksEnvironment.udpBuddyMinServers ● Int! non-null scalar​

CksEnvironment.udpBuddyMaxServers ● Int! non-null scalar​

CksEnvironment.loadBalancerCount ● Int! non-null scalar​

CksEnvironment.environmentClass ● String! non-null scalar​

'dedicated' (multi-VM) or 'dev_single' (one dev-only VM).

CksEnvironment.singleBoxFlavor ● String scalar​

Single VM flavor when environmentClass = 'dev_single'.

CksEnvironment.isShared ● Boolean! non-null scalar​

True for the single platform-owned shared environment (slug 'shared') that hosts the shared game-api serving apps with deploymentTarget='shared'. Customer environments are always false.

CksEnvironment.buddyBillingTier ● Int scalar​

Selected Buddy billing tier level, if any.

CksEnvironment.graphqlBillingTier ● Int scalar​

Selected GraphQL billing tier level, if any.

CksEnvironment.postgresBillingTier ● Int scalar​

Selected Postgres billing tier level, if any.

CksEnvironment.billingStatus ● String! non-null scalar​

Payment lifecycle (NOT provisioning): active; grace (a charge failed — funds must be added before billingGraceDeadline); suspension_queued -> suspended (runtime stopped for non-payment); resume_queued -> active after payment (resume_failed on error). Recover with resumeEnvironment.

CksEnvironment.billingGraceDeadline ● DateTime scalar​

When billingStatus = grace, the deadline to add funds before suspension (~24h after the failed charge). Null otherwise.

CksEnvironment.suspendedAt ● DateTime scalar​

When the environment was suspended for non-payment. Null unless suspended.

CksEnvironment.createdAt ● DateTime! non-null scalar​

CksEnvironment.updatedAt ● DateTime! non-null scalar​

Returned By​

orgEnvironments query ● updateEnvironmentBillingTiers mutation

Member Of​

CksEnvironmentDetail object