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

EndpointAdminProcurement Endpoint
Endpoint for global administrator to handle procurement for users.
EndpointAdminProjects Endpoint
Endpoint for global administrator projects access.
EndpointAdminUsers Endpoint
Endpoint for global administrator users access.
EndpointAuth Endpoint
Endpoint for authentication.
EndpointAuthWithAuth Endpoint
Endpoint for authentication.
EndpointBilling Endpoint
EndpointCustomDomainName Endpoint
EndpointDatabase Endpoint
Endpoint for database management.
EndpointDeploy Endpoint
EndpointEnvironmentVariables Endpoint
Endpoint for managing environment variables.
EndpointInfraResources Endpoint
Endpoint for infrastructure resource provisioning.
EndpointLogs Endpoint
Endpoint for accessing cloud logs.
EndpointPlans Endpoint
Endpoint for managing subscription plans.
EndpointProjects Endpoint
Endpoint for managing projects.
EndpointRoles Endpoint
Endpoint for managing access roles.
EndpointSecrets Endpoint
EndpointStatus Endpoint
Endpoint for accessing capsule deployment status.
EndpointUsers Endpoint
Endpoint for managing users.