Service actions

Server actions for Services: create, update, delete, deploy, scale, domains, volumes, backups, and Nginx config (RBAC via getActionAccess).

Written By Zoro

Last updated 4 months ago

These Server Actions implement most Service lifecycle work in thedashboard: provisioning, configuration, deploys, routing, scaling, and backups.Implementation is concentrated in packages/core/src/actions/service/index.tswith related pieces in deployment/, backups/, dbBackup/, andunifiedDeployment/ where noted.

RBAC: Permission keys for each actionName are defined inpackages/core/src/lib/permissions/config.ts inside getActionAccess.

Create, update, delete

`actionName`	Permission keys (from `getActionAccess`)
`createServiceAction`	`services.create`, `projects.read`, `services.read`
`createAppServiceAction`	`services.create`, `projects.read`, `services.read`, `environments.read`
`createDatabaseServiceAction`	`services.create`, `projects.read`, `services.read`, `environments.read`
`updateServiceAction`	`services.read`, `services.update`
`deleteServiceAction`	`services.delete`, `services.read`

Deploy, stop, restart

`actionName`	Permission keys (from `getActionAccess`)
`createDeploymentAction`	`services.read`, `services.update`
`restartServiceAction`	`services.read`, `services.update`
`stopServiceAction`	`services.read`, `services.update`
`createUnifiedDeploymentAction`	`projects.create`, `projects.read`, `services.create`, `services.read`, `servers.read`, `servers.update`, `services.update`, `projects.update`

createUnifiedDeploymentAction coordinates multi-service / project-style deployflows; see packages/core/src/actions/unifiedDeployment/index.ts.

Domains, TLS, routing

`actionName`	Permission keys (from `getActionAccess`)
`updateServiceDomainAction`	`services.read`, `services.update`
`syncServiceDomainAction`	`services.read`, `services.update`
`regenerateSSLAction`	`services.read`, `services.update`
`markDefaultServiceDomainAction`	`services.update`
`getCustomDomainDNSRecordsAction`	`services.read`
`getServiceNginxConfigAction`	`services.read`
`setServiceNginxConfigSchema`	`services.update`

Customer tasks: Domains and SSL under Deployments and Operations in the sidebar and Proxy and routing under Deployments and Operations in the sidebar.

Scaling and resources

`actionName`	Permission keys (from `getActionAccess`)
`scaleServiceAction`	`services.read`
`fetchServiceScaleStatusAction`	`services.read`
`getServiceScalingDetailsAction`	`services.read`
`setServiceResourceLimitAction`	`services.read`
`setServiceResourceReserveAction`	`services.read`
`fetchServiceResourceStatusAction`	`services.read`
`clearServiceResourceLimitAction`	`services.read`
`clearServiceResourceReserveAction`	`services.read`
`checkServerResourcesAction`	`services.read`

Volumes and uploads

`actionName`	Permission keys (from `getActionAccess`)
`updateVolumesAction`	`services.read`, `services.update`
`requestFileSourceUploadAction`	`services.read`, `services.update`

Database-specific service operations

`actionName`	Permission keys (from `getActionAccess`)
`exposeDatabasePortAction`	`services.read`, `services.update`

Reads and aggregates

`actionName`	Permission keys (from `getActionAccess`)
`getServiceDetails`	`services.read`
`getServiceDeploymentsBackups`	`services.read`
`getServiceBackups`	`backups.read`
`getProjectServicesReplicasAction`	`projects.read`
`getDeploymentsAction`	`services.read`

Database backups (database Services)

Implementation: packages/core/src/actions/dbBackup/ and packages/core/src/actions/backupStorageProviders/.

`actionName`	Permission keys (from `getActionAccess`)
`internalBackupAction`	`backups.create`, `services.read`
`internalRestoreAction`	`backups.read`, `services.read`, `backups.update`
`internalDbDeleteAction`	`services.read`, `backups.delete`, `backups.read`
`saveBackupScheduleAction`	`backups.update`, `services.read`
`requestBackupDownloadAction`	`backups.read`, `services.read`
`getBackupDownloadUrlAction`	`backups.read`, `services.read`
`requestDumpUploadAction`	`backups.update`, `services.read`
`uploadDumpRestoreAction`	`backups.update`, `services.read`
`getAllBackupsAction`	`backups.read`, `backups.update`
`updateServiceBackupDestinationAction`	`services.update`, `services.read`, `backupStorageProviders.read`
`getBackupStorageProvidersAction`	`backupStorageProviders.read`
`connectBackupStorageProviderAction`	`backupStorageProviders.create`
`updateBackupStorageProviderAction`	`backupStorageProviders.update`
`deleteBackupStorageProviderAction`	`backupStorageProviders.delete`
`testBackupStorageProviderAction`	`backupStorageProviders.read`
`verifyBackupStorageProviderAction`	`backupStorageProviders.update`

Customer guides: Backups and Backups and restore.

Learn more

Services overview for the product model.
Project / application actions for Environments and Applications that scope Services.

Was this helpful?

Still need help? Ask the team