Endpoint topic

Callable endpoints

Each class contains callable methods that will call a method on the server side. These are normally defined in the endpoint directory in your server project. This client sends requests to these endpoints and returns the result.

Example usage:

// How to use ExampleEndpoint.
client.example.hello("world!");

// Generic format.
client.<endpoint>.<method>(...);

Please see the full official documentation here

Classes

EndpointAdminAppBuilds Endpoint
Endpoint for the one-off Google Play service account backfill.
EndpointAdminBilling Endpoint
Endpoint for an administrator to reissue an invoice.
EndpointAdminDatabaseScaling Endpoint
Endpoint for reconciling database compute scaling against Serverpod Cloud.
EndpointAdminGrants Endpoint
Admin tools for setting capsule grant allowances.
EndpointAdminProcurement Endpoint
Endpoint for global administrator to handle procurement for users.
EndpointAdminProjects Endpoint
Endpoint for global administrator projects access.
EndpointAdminSecrets Endpoint
Endpoint for global administrator secrets migration.
EndpointAdminStorageIdentity Endpoint
Endpoint for the one-off storage-identity backfill.
EndpointAdminTest Endpoint
Admin tools for exercising push notifications.
EndpointAdminUpdatePlan Endpoint
EndpointAdminUsers Endpoint
Endpoint for global administrator users access.
EndpointAppBuilds Endpoint
EndpointAppPublishing Endpoint
Per-platform publishing setup of a capsule: the store it uploads to and how its builds are signed. Credential values are never returned.
EndpointAuth Endpoint
Endpoint for authentication.
EndpointAuthWithAuth Endpoint
Endpoint for authenticated-user session management.
EndpointBilling Endpoint
EndpointBucket Endpoint
Endpoint for managing a capsule's storage buckets.
EndpointBucketObjects Endpoint
Endpoint for the object contents of a capsule's storage buckets.
EndpointCapsules Endpoint
Endpoint for capsule operations.
EndpointCompute Endpoint
Endpoint for reading and updating capsule compute configuration.
EndpointCustomDomainName Endpoint
EndpointDatabase Endpoint
Endpoint for database management.
EndpointDeploy Endpoint
EndpointEmailIdp Endpoint
EndpointEnvironmentVariables Endpoint
Endpoint for managing environment variables.
EndpointGitHubIdp Endpoint
EndpointGoogleIdp Endpoint
EndpointInfraResources Endpoint
Endpoint for infrastructure resource provisioning.
EndpointInsights Endpoint
EndpointJwtRefresh Endpoint
By extending RefreshJwtTokensEndpoint, the JWT token refresh endpoint is made available on the server and enables automatic token refresh on the client.
EndpointLogs Endpoint
Endpoint for accessing cloud logs.
EndpointMetrics Endpoint
Endpoint for reading capsule metrics.
EndpointPlans Endpoint
Endpoint for managing subscription plans.
EndpointPlatform Endpoint
Endpoint for reading platform information about Serverpod Cloud.
EndpointProjects Endpoint
Endpoint for managing projects.
EndpointRoles Endpoint
Endpoint for managing access roles.
EndpointSecrets Endpoint
EndpointStatus Endpoint
Endpoint for accessing capsule deployment status.
EndpointStoreConnections Endpoint
Store connections belong to the signed-in user's owner and are shared by all of the owner's projects. The key is never returned.
EndpointUsers Endpoint
Endpoint for managing users.