Reference
118 API, CLI, and SDK pages.
hosting
- Attach a new domain to a projectAttach a new domain to a project
- Create a hosting project (registers a name + slug)Create a hosting project (registers a name + slug)
- Dispatch a new deployment (triggers build-worker)Dispatch a new deployment (triggers build-worker)
- Fetch resolved env vars for a deployment (CLI-side)Fetch resolved env vars for a deployment (CLI-side)
- Trigger a BlueForge-config-driven deployTrigger a BlueForge-config-driven deploy
endpoints
- Check health of all registered federation servicesCheck health of all registered federation services
- Create a new platform project (provisions DB + API keys)Create a new platform project (provisions DB + API keys)
- List projects visible to the API keyList projects visible to the API key
- Restart all containers for an appRestart all containers for an app
- Soft-delete a project (recoverable via support)Soft-delete a project (recoverable via support)
methods
- client.agent.queryclient.agent.query
- client.agent.schemaclient.agent.schema
- client.aggregateclient.aggregate
- client.auth.getSessionclient.auth.getSession
- client.auth.getUserclient.auth.getUser
- client.auth.resetPasswordclient.auth.resetPassword
- client.auth.signInclient.auth.signIn
- client.auth.signInWithOAuthclient.auth.signInWithOAuth
- client.auth.signOutclient.auth.signOut
- client.auth.signUpclient.auth.signUp
- client.auth.updateUserclient.auth.updateUser
- client.cdn.configclient.cdn.config
- client.cdn.purgeclient.cdn.purge
- client.cdn.purgeProjectclient.cdn.purgeProject
- client.channelclient.channel
- client.fromclient.from
- client.functions.deployclient.functions.deploy
- client.functions.invokeclient.functions.invoke
- client.functions.listclient.functions.list
- client.functions.removeclient.functions.remove
- client.healthclient.health
- client.org.addMemberclient.org.addMember
- client.org.createclient.org.create
- client.org.getclient.org.get
- client.org.listclient.org.list
- client.redis.batchclient.redis.batch
- client.redis.delclient.redis.del
- client.redis.expireclient.redis.expire
- client.redis.getclient.redis.get
- client.redis.incrclient.redis.incr
- client.redis.keysclient.redis.keys
- client.redis.setclient.redis.set
- client.searchclient.search
- client.statsclient.stats
- client.storage.createBucketclient.storage.createBucket
- client.storage.downloadclient.storage.download
- client.storage.getPublicUrlclient.storage.getPublicUrl
- client.storage.getUsageclient.storage.getUsage
- client.storage.listBucketsclient.storage.listBuckets
- client.storage.searchclient.storage.search
- client.storage.uploadclient.storage.upload
- client.vault.deleteclient.vault.delete
- client.vault.getclient.vault.get
- client.vault.listclient.vault.list
- client.vault.setclient.vault.set
- client.wallet.configureAutoRefillclient.wallet.configureAutoRefill
- client.wallet.createAlertclient.wallet.createAlert
- client.wallet.createRefillSessionclient.wallet.createRefillSession
- client.wallet.creditclient.wallet.credit
- client.wallet.debitclient.wallet.debit
- client.wallet.freezeclient.wallet.freeze
- client.wallet.getAutoRefillclient.wallet.getAutoRefill
- client.wallet.getBalanceclient.wallet.getBalance
- client.wallet.listAlertsclient.wallet.listAlerts
- client.wallet.listTransactionsclient.wallet.listTransactions
- client.wallet.startConnectOnboardingclient.wallet.startConnectOnboarding
- client.wallet.unfreezeclient.wallet.unfreeze
- client.webhooks.subscribeclient.webhooks.subscribe
- Create a new organisation via SDKCreate a new organisation via SDK
- Create a new platform project via SDKCreate a new platform project via SDK
- List projects visible to the SDK API keyList projects visible to the SDK API key
- Restart all containers for an app via SDKRestart all containers for an app via SDK
platform
- Create a new API key (plaintext returned once)Create a new API key (plaintext returned once)
- Execute parameterized SQL against the project's DBExecute parameterized SQL against the project's DB
- Get auth config + recent usersGet auth config + recent users
- Get project details (status, plan, timestamps)Get project details (status, plan, timestamps)
- Get storage usage stats for the projectGet storage usage stats for the project
- Trigger a new backupTrigger a new backup
commands
- Create a new organisation (tenant)Create a new organisation (tenant)
- Create a new platform projectCreate a new platform project
- Deploy an app via git SHA or artifact uploadDeploy an app via git SHA or artifact upload
- forge api-keyforge api-key
- forge app restartforge app restart
- forge app-rollbackforge app-rollback
- forge app-traceforge app-trace
- forge app-verifyforge app-verify
- forge buildforge build
- forge db-migrateforge db-migrate
- forge db-moveforge db-move
- forge db-register-migrationforge db-register-migration
- forge db-seedforge db-seed
- forge deployforge deploy
- forge devforge dev
- forge doctorforge doctor
- forge env-cmdforge env-cmd
- forge errforge err
- forge explainforge explain
- forge fleetforge fleet
- forge initforge init
- forge linkforge link
- forge listforge list
- forge loginforge login
- forge logsforge logs
- forge moveforge move
- forge org listforge org list
- forge project getforge project get
- forge rollbackforge rollback
- forge routingforge routing
- forge service-deployforge service-deploy
- forge statusforge status
- forge stopforge stop
- forge storageforge storage
- forge syncforge sync
- forge vaultforge vault
- forge walletforge wallet
- forge workspaceforge workspace
- List platform projectsList platform projects
- List registered federation services and their healthList registered federation services and their health