Struct PlatformApiClient 

pub struct PlatformApiClient { /* private fields */ }

Client for interacting with the Syncable Platform API

Implementations

impl PlatformApiClient

pub fn new() -> Result<Self>

Create a new Platform API client using the default API URL

Uses SYNCABLE_ENV=development to switch to local development server.

pub fn with_url(api_url: impl Into<String>) -> Result<Self>

Create a new Platform API client with a custom API URL

pub fn api_url(&self) -> &str

Get the configured API URL

pub async fn get_current_user(&self) -> Result<UserProfile>

Get the current authenticated user’s profile

Endpoint: GET /api/users/me

pub async fn list_organizations(&self) -> Result<Vec<Organization>>

List organizations the authenticated user belongs to

Endpoint: GET /api/organizations/attended-by-user

pub async fn get_organization(&self, id: &str) -> Result<Organization>

Get an organization by ID

Endpoint: GET /api/organizations/:id

pub async fn list_projects(&self, org_id: &str) -> Result<Vec<Project>>

List projects in an organization

Endpoint: GET /api/projects/organization/:organizationId

pub async fn get_project(&self, id: &str) -> Result<Project>

Get a project by ID

Endpoint: GET /api/projects/:id

pub async fn create_project( &self, org_id: &str, name: &str, description: &str, ) -> Result<Project>

Create a new project in an organization

Endpoint: POST /api/projects

Note: This first fetches the current user to get the creator_id.

pub async fn list_project_repositories( &self, project_id: &str, ) -> Result<ProjectRepositoriesResponse>

List repositories connected to a project

Returns all GitHub/GitLab repositories that have been connected to the project. Use this to get repository info needed for deployment configuration.

Endpoint: GET /api/github/projects/:projectId/repositories

pub async fn list_github_installations( &self, ) -> Result<GitHubInstallationsResponse>

List GitHub App installations for the organization

Returns all GitHub App installations accessible to the authenticated user’s organization. Use this to find which GitHub accounts are connected.

Endpoint: GET /api/github/installations

pub async fn get_github_installation_url( &self, ) -> Result<GitHubInstallationUrlResponse>

Get the URL to install the GitHub App

Returns the URL users should visit to install the Syncable GitHub App. Use this when no installations are found.

Endpoint: GET /api/github/installation/url

pub async fn list_available_repositories( &self, project_id: Option<&str>, search: Option<&str>, page: Option<i32>, ) -> Result<AvailableRepositoriesResponse>

List repositories available for connection

Returns repositories accessible through GitHub App installations, including which ones are already connected to the project.

Endpoint: GET /api/github/repositories/available

pub async fn connect_repository( &self, request: &ConnectRepositoryRequest, ) -> Result<ConnectRepositoryResponse>

Connect a repository to a project

Connects a GitHub repository to a project, allowing deployments from that repo.

Endpoint: POST /api/github/projects/repositories/connect

pub async fn initialize_gitops( &self, project_id: &str, installation_id: Option<i64>, ) -> Result<InitializeGitOpsResponse>

Initialize GitOps repository for a project

Ensures a GitOps infrastructure repository exists for the project. If it doesn’t exist, automatically creates it using the GitHub App installation.

Endpoint: POST /api/projects/:projectId/gitops/initialize

pub async fn list_environments( &self, project_id: &str, ) -> Result<Vec<Environment>>

List environments for a project

Returns all environments (deployment targets) defined for the project.

Endpoint: GET /api/projects/:projectId/environments

pub async fn create_environment( &self, project_id: &str, name: &str, environment_type: &str, cluster_id: Option<&str>, provider_regions: Option<&HashMap<String, String>>, ) -> Result<Environment>

Create a new environment for a project

Creates an environment with the specified type (cluster or cloud). For cluster environments, a cluster_id is required.

Endpoint: POST /api/environments

Note: environment_type should be “cluster” (for K8s) or “cloud” (for Cloud Runner)

pub async fn check_provider_connection( &self, provider: &CloudProvider, project_id: &str, ) -> Result<Option<CloudCredentialStatus>>

Check if a cloud provider is connected to a project

Returns Some(status) if the provider is connected, None if not connected.

SECURITY NOTE: This method only returns connection STATUS, never actual credentials. The agent should never have access to OAuth tokens, API keys, or other secrets.

Uses: GET /api/cloud-credentials?projectId=xxx (lists all, then filters)

pub async fn list_cloud_credentials_for_project( &self, project_id: &str, ) -> Result<Vec<CloudCredentialStatus>>

List all cloud credentials for a project

Returns all connected cloud providers for the project.

SECURITY NOTE: This method only returns connection STATUS, never actual credentials.

Endpoint: GET /api/cloud-credentials?projectId=xxx

pub async fn list_deployment_configs( &self, project_id: &str, ) -> Result<Vec<DeploymentConfig>>

List deployment configurations for a project

Returns all deployment configs associated with the project, including service name, branch, target type, and auto-deploy settings.

Endpoint: GET /api/projects/:projectId/deployment-configs

pub async fn create_deployment_config( &self, request: &CreateDeploymentConfigRequest, ) -> Result<DeploymentConfig>

Create a new deployment configuration

Creates a deployment config for a service. Requires repository integration to be set up first (GitHub/GitLab). The project_id should be included in the request body.

Returns the created/updated deployment config. The API also returns a was_updated flag indicating whether this was an update to an existing config.

Endpoint: POST /api/deployment-configs

pub async fn update_deployment_config_secrets( &self, config_id: &str, secrets: &[DeploymentSecretInput], ) -> Result<()>

Update environment variables / secrets on a deployment config

SECURITY NOTE: This sends secret values over HTTPS to the backend. The backend stores them encrypted. API responses mask secret values.

Endpoint: PUT /api/deployment-configs/:configId/secrets

pub async fn trigger_deployment( &self, request: &TriggerDeploymentRequest, ) -> Result<TriggerDeploymentResponse>

Trigger a deployment using a deployment config

Starts a new deployment for the specified config. Optionally specify a commit SHA to deploy a specific version.

Endpoint: POST /api/deployment-configs/deploy

pub async fn get_deployment_status( &self, task_id: &str, ) -> Result<DeploymentTaskStatus>

Get deployment task status

Returns the current status of a deployment task, including progress percentage, current step, and overall status.

Endpoint: GET /api/deployments/task/:taskId

pub async fn list_deployments( &self, project_id: &str, limit: Option<i32>, ) -> Result<PaginatedDeployments>

List deployments for a project

Returns a paginated list of deployments for the project, sorted by creation time (most recent first).

Endpoint: GET /api/deployments/project/:projectId

pub async fn get_service_logs( &self, service_id: &str, start: Option<&str>, end: Option<&str>, limit: Option<i32>, ) -> Result<GetLogsResponse>

Get container logs for a deployed service

Returns recent logs from the service’s containers. Supports time filtering and line limits for efficient log retrieval.

Arguments

• service_id - The service/deployment ID (from list_deployments)
• start - Optional ISO timestamp to filter logs from
• end - Optional ISO timestamp to filter logs until
• limit - Optional max number of log lines (default: 100)

Endpoint: GET /api/deployments/services/:serviceId/logs

pub async fn list_clusters_for_project( &self, project_id: &str, ) -> Result<Vec<ClusterEntity>>

List all clusters for a project

Returns all K8s clusters available for deployments in this project.

Endpoint: GET /api/clusters/project/:projectId

pub async fn get_cluster( &self, cluster_id: &str, ) -> Result<Option<ClusterEntity>>

Get a specific cluster by ID

Returns cluster details or None if not found.

Endpoint: GET /api/clusters/:clusterId

pub async fn list_registries_for_project( &self, project_id: &str, ) -> Result<Vec<ArtifactRegistry>>

List all artifact registries for a project

Returns all container registries available for image storage in this project.

Endpoint: GET /api/projects/:projectId/artifact-registries

pub async fn list_ready_registries_for_project( &self, project_id: &str, ) -> Result<Vec<ArtifactRegistry>>

List only ready artifact registries for a project

Returns registries that are ready to receive image pushes. Use this for deployment wizard to show only usable registries.

Endpoint: GET /api/projects/:projectId/artifact-registries/ready

pub async fn create_registry( &self, project_id: &str, request: &CreateRegistryRequest, ) -> Result<CreateRegistryResponse>

Provision a new artifact registry

Starts async provisioning via Backstage scaffolder. Returns task ID for polling status.

Endpoint: POST /api/projects/:projectId/artifact-registries

pub async fn get_registry_task_status( &self, task_id: &str, ) -> Result<RegistryTaskStatus>

Get registry provisioning task status

Poll this endpoint to check provisioning progress.

Endpoint: GET /api/artifact-registries/task/:taskId

pub async fn get_hetzner_options( &self, project_id: &str, ) -> Result<HetznerOptionsData>

Get Hetzner options (locations and server types) with real-time data

Uses the /api/v1/cloud-runner/hetzner/options endpoint which returns both locations and server types in one call. This is the same endpoint used by the frontend for Hetzner infrastructure selection.

Endpoint: GET /api/v1/cloud-runner/hetzner/options?projectId=:projectId

pub async fn get_hetzner_locations( &self, project_id: &str, ) -> Result<Vec<LocationWithAvailability>>

Get Hetzner locations with real-time availability information

Returns all Hetzner locations with the server types currently available at each location. Uses the customer’s Hetzner API token stored in their cloud credentials to query the Hetzner API.

This enables dynamic resource selection instead of relying on hardcoded values.

Endpoint: GET /api/deployments/availability/locations?projectId=:projectId

pub async fn get_hetzner_server_types( &self, project_id: &str, preferred_location: Option<&str>, ) -> Result<Vec<ServerTypeSummary>>

Get Hetzner server types with pricing and availability

Returns all non-deprecated Hetzner server types sorted by monthly price, with availability information showing which locations have capacity.

Use this to dynamically populate server type selection UI and enable smart resource recommendations based on real pricing data.

Endpoint: GET /api/deployments/availability/server-types?projectId=:projectId&preferredLocation=:location

pub async fn check_hetzner_availability( &self, project_id: &str, location: &str, server_type: &str, ) -> Result<AvailabilityCheckResult>

Check if a specific server type is available at a location

Returns availability status with:

• Whether the server type is available
• Reason if unavailable (capacity vs unsupported)
• Alternative locations where it IS available

Use this before deployment to detect capacity issues early and suggest alternatives.

Endpoint: GET /api/deployments/availability/check?projectId=:projectId&location=:location&serverType=:serverType

pub async fn list_project_networks( &self, project_id: &str, ) -> Result<Vec<CloudRunnerNetwork>>

List all cloud runner networks for a project

Returns VPCs, subnets, Azure Container App Environments, GCP VPC Connectors, etc. Use this to discover private networking infrastructure provisioned for the project.

Endpoint: GET /api/v1/cloud-runner/projects/:projectId/networks

pub async fn check_connection(&self) -> Result<()>

Check if the API is reachable (quick health check)

Uses a shorter timeout (5s) for quick connectivity verification. This method does NOT require authentication.

Returns Ok(()) if API is reachable, Err(ConnectionFailed) otherwise.