pub struct Client { /* private fields */ }Expand description
Client for Alien API
Version: 1.0.0
Implementations§
Source§impl Client
impl Client
Sourcepub fn new(baseurl: &str) -> Self
pub fn new(baseurl: &str) -> Self
Create a new client.
baseurl is the base URL provided to the internal
reqwest::Client, and should include a scheme and hostname,
as well as port and a path stem if applicable.
Sourcepub fn new_with_client(baseurl: &str, client: Client) -> Self
pub fn new_with_client(baseurl: &str, client: Client) -> Self
Construct a new client with an existing reqwest::Client,
allowing more control over its configuration.
baseurl is the base URL provided to the internal
reqwest::Client, and should include a scheme and hostname,
as well as port and a path stem if applicable.
Source§impl Client
impl Client
Sourcepub fn update_user_profile(&self) -> UpdateUserProfile<'_>
pub fn update_user_profile(&self) -> UpdateUserProfile<'_>
Update the current user’s profile (display name).
Sends a PATCH request to /v1/user/profile
let response = client.update_user_profile()
.body(body)
.send()
.await;Sourcepub fn list_memberships(&self) -> ListMemberships<'_>
pub fn list_memberships(&self) -> ListMemberships<'_>
List all workspaces the current user has access to.
Sends a GET request to /v1/user/memberships
let response = client.list_memberships()
.send()
.await;Sourcepub fn create_workspace(&self) -> CreateWorkspace<'_>
pub fn create_workspace(&self) -> CreateWorkspace<'_>
Create a new workspace. The current user will be automatically added as an admin.
Sends a POST request to /v1/user/workspaces
let response = client.create_workspace()
.body(body)
.send()
.await;Sourcepub fn list_git_namespaces(&self) -> ListGitNamespaces<'_>
pub fn list_git_namespaces(&self) -> ListGitNamespaces<'_>
List all git namespaces (GitHub installations) the current user has access to.
Sends a GET request to /v1/user/git-namespaces
let response = client.list_git_namespaces()
.provider(provider)
.send()
.await;Sourcepub fn sync_git_namespaces(&self) -> SyncGitNamespaces<'_>
pub fn sync_git_namespaces(&self) -> SyncGitNamespaces<'_>
Sync git namespaces from the provider. For GitHub, this fetches all app installations accessible to the user.
Sends a POST request to /v1/user/git-namespaces/sync
let response = client.sync_git_namespaces()
.body(body)
.send()
.await;Sourcepub fn list_git_namespace_repositories(
&self,
) -> ListGitNamespaceRepositories<'_>
pub fn list_git_namespace_repositories( &self, ) -> ListGitNamespaceRepositories<'_>
List repositories accessible through a git namespace (GitHub installation).
Sends a GET request to /v1/user/git-namespaces/{id}/repositories
Arguments:
idsearch: Search query to filter repositories by name
let response = client.list_git_namespace_repositories()
.id(id)
.search(search)
.send()
.await;Sourcepub fn whoami(&self) -> Whoami<'_>
pub fn whoami(&self) -> Whoami<'_>
Get current authenticated principal information (user or service account). Works with both session cookies and API keys.
Sends a GET request to /v1/whoami
let response = client.whoami()
.send()
.await;Sourcepub fn list_workspaces(&self) -> ListWorkspaces<'_>
pub fn list_workspaces(&self) -> ListWorkspaces<'_>
Retrieve all workspaces.
Sends a GET request to /v1/workspaces
Arguments:
cursor: Cursor for pagination - omit for first pagelimit: Maximum number of items to return per pagesearch: Search workspaces by nameworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_workspaces()
.cursor(cursor)
.limit(limit)
.search(search)
.workspace(workspace)
.send()
.await;Sourcepub fn get_workspace(&self) -> GetWorkspace<'_>
pub fn get_workspace(&self) -> GetWorkspace<'_>
Retrieve a workspace by ID.
Sends a GET request to /v1/workspaces/{id}
Arguments:
id: Unique identifier for the workspace.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_workspace()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn delete_workspace(&self) -> DeleteWorkspace<'_>
pub fn delete_workspace(&self) -> DeleteWorkspace<'_>
Delete a workspace. The workspace must have no projects.
Sends a DELETE request to /v1/workspaces/{id}
Arguments:
id: Unique identifier for the workspace.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.delete_workspace()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn update_workspace(&self) -> UpdateWorkspace<'_>
pub fn update_workspace(&self) -> UpdateWorkspace<'_>
Update a workspace.
Sends a PATCH request to /v1/workspaces/{id}
Arguments:
id: Unique identifier for the workspace.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.update_workspace()
.id(id)
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn list_workspace_members(&self) -> ListWorkspaceMembers<'_>
pub fn list_workspace_members(&self) -> ListWorkspaceMembers<'_>
List all members of a workspace.
Sends a GET request to /v1/workspaces/{id}/members
Arguments:
id: Unique identifier for the workspace.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_workspace_members()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn add_workspace_member(&self) -> AddWorkspaceMember<'_>
pub fn add_workspace_member(&self) -> AddWorkspaceMember<'_>
Add a member to a workspace by email. The user must already have an account.
Sends a POST request to /v1/workspaces/{id}/members
Arguments:
id: Unique identifier for the workspace.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.add_workspace_member()
.id(id)
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn remove_workspace_member(&self) -> RemoveWorkspaceMember<'_>
pub fn remove_workspace_member(&self) -> RemoveWorkspaceMember<'_>
Remove a member from a workspace.
Sends a DELETE request to /v1/workspaces/{id}/members/{userId}
Arguments:
id: Unique identifier for the workspace.user_idworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.remove_workspace_member()
.id(id)
.user_id(user_id)
.workspace(workspace)
.send()
.await;Sourcepub fn update_workspace_member(&self) -> UpdateWorkspaceMember<'_>
pub fn update_workspace_member(&self) -> UpdateWorkspaceMember<'_>
Update a workspace member’s role.
Sends a PATCH request to /v1/workspaces/{id}/members/{userId}
Arguments:
id: Unique identifier for the workspace.user_idworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.update_workspace_member()
.id(id)
.user_id(user_id)
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn list_projects(&self) -> ListProjects<'_>
pub fn list_projects(&self) -> ListProjects<'_>
Retrieve all projects.
Sends a GET request to /v1/projects
Arguments:
cursor: Cursor for pagination - omit for first pageinclude: Optional fields to include: deploymentCount, latestReleaselimit: Maximum number of items to return per pagesearch: Search projects by nameworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_projects()
.cursor(cursor)
.include(include)
.limit(limit)
.search(search)
.workspace(workspace)
.send()
.await;Sourcepub fn create_project(&self) -> CreateProject<'_>
pub fn create_project(&self) -> CreateProject<'_>
Create a new project.
Sends a POST request to /v1/projects
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.create_project()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn get_project(&self) -> GetProject<'_>
pub fn get_project(&self) -> GetProject<'_>
Retrieve a project by ID or name.
Sends a GET request to /v1/projects/{idOrName}
Arguments:
id_or_name: Project ID or name.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_project()
.id_or_name(id_or_name)
.workspace(workspace)
.send()
.await;Sourcepub fn delete_project(&self) -> DeleteProject<'_>
pub fn delete_project(&self) -> DeleteProject<'_>
Delete a project. The project must have no agents.
Sends a DELETE request to /v1/projects/{idOrName}
Arguments:
id_or_name: Project ID or name.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.delete_project()
.id_or_name(id_or_name)
.workspace(workspace)
.send()
.await;Sourcepub fn update_project(&self) -> UpdateProject<'_>
pub fn update_project(&self) -> UpdateProject<'_>
Update a project.
Sends a PATCH request to /v1/projects/{idOrName}
Arguments:
id_or_name: Project ID or name.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.update_project()
.id_or_name(id_or_name)
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn create_project_from_template(&self) -> CreateProjectFromTemplate<'_>
pub fn create_project_from_template(&self) -> CreateProjectFromTemplate<'_>
Create a project by forking alienplatform/alien into your namespace, then configuring GitHub Actions.
Sends a POST request to /v1/projects/import-template
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.create_project_from_template()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn get_project_template_urls(&self) -> GetProjectTemplateUrls<'_>
pub fn get_project_template_urls(&self) -> GetProjectTemplateUrls<'_>
Get template URLs for deploying agents in this project.
Sends a GET request to /v1/projects/{idOrName}/template-urls
Arguments:
id_or_name: Project ID or name.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_project_template_urls()
.id_or_name(id_or_name)
.workspace(workspace)
.send()
.await;Sourcepub fn get_project_active_release(&self) -> GetProjectActiveRelease<'_>
pub fn get_project_active_release(&self) -> GetProjectActiveRelease<'_>
Get the active release for this project. Returns the latest release, or the pinned release if deploymentId is provided and that deployment has a pinned release.
Sends a GET request to /v1/projects/{idOrName}/active-release
Arguments:
id_or_name: Project ID or name.deployment_id: Optional deployment ID to check for pinned releaseworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_project_active_release()
.id_or_name(id_or_name)
.deployment_id(deployment_id)
.workspace(workspace)
.send()
.await;Sourcepub fn get_project_build_config(&self) -> GetProjectBuildConfig<'_>
pub fn get_project_build_config(&self) -> GetProjectBuildConfig<'_>
Get build configuration for a specific platform. Returns agent manager URL and repository info for GitHub Actions to use directly.
Sends a GET request to /v1/projects/{idOrName}/build-config/{platform}
Arguments:
id_or_name: Project ID or name.platform: Represents the target cloud platform.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_project_build_config()
.id_or_name(id_or_name)
.platform(platform)
.workspace(workspace)
.send()
.await;Sourcepub fn list_deployment_groups(&self) -> ListDeploymentGroups<'_>
pub fn list_deployment_groups(&self) -> ListDeploymentGroups<'_>
List deployment groups
Sends a GET request to /v1/deployment-groups
Arguments:
cursor: Cursor for pagination - omit for first pagelimit: Maximum number of items to return per pageproject: Filter by project ID or name.search: Search deployment groups by nameworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_deployment_groups()
.cursor(cursor)
.limit(limit)
.project(project)
.search(search)
.workspace(workspace)
.send()
.await;Sourcepub fn create_deployment_group(&self) -> CreateDeploymentGroup<'_>
pub fn create_deployment_group(&self) -> CreateDeploymentGroup<'_>
Create a new deployment group
Sends a POST request to /v1/deployment-groups
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.create_deployment_group()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn get_deployment_group(&self) -> GetDeploymentGroup<'_>
pub fn get_deployment_group(&self) -> GetDeploymentGroup<'_>
Get deployment group details
Sends a GET request to /v1/deployment-groups/{id}
Arguments:
id: Unique identifier for the deployment group.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_deployment_group()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn delete_deployment_group(&self) -> DeleteDeploymentGroup<'_>
pub fn delete_deployment_group(&self) -> DeleteDeploymentGroup<'_>
Delete deployment group
Sends a DELETE request to /v1/deployment-groups/{id}
Arguments:
id: Unique identifier for the deployment group.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.delete_deployment_group()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn update_deployment_group(&self) -> UpdateDeploymentGroup<'_>
pub fn update_deployment_group(&self) -> UpdateDeploymentGroup<'_>
Update deployment group
Sends a PATCH request to /v1/deployment-groups/{id}
Arguments:
id: Unique identifier for the deployment group.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.update_deployment_group()
.id(id)
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn create_deployment_group_token(&self) -> CreateDeploymentGroupToken<'_>
pub fn create_deployment_group_token(&self) -> CreateDeploymentGroupToken<'_>
Create deployment group token
Creates a deployment-group scoped API key and returns both the token and formatted deployment link
Sends a POST request to /v1/deployment-groups/{id}/tokens
Arguments:
id: Unique identifier for the deployment group.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.create_deployment_group_token()
.id(id)
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn list_packages(&self) -> ListPackages<'_>
pub fn list_packages(&self) -> ListPackages<'_>
List packages with optional filters. Returns packages ordered by creation date (newest first).
Sends a GET request to /v1/packages
Arguments:
cursor: Cursor for pagination - omit for first pagelimit: Maximum number of items to return per pageproject: Filter by project ID or name.status: Filter by package statustype_: Filter by package typeworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_packages()
.cursor(cursor)
.limit(limit)
.project(project)
.status(status)
.type_(type_)
.workspace(workspace)
.send()
.await;Sourcepub fn get_package(&self) -> GetPackage<'_>
pub fn get_package(&self) -> GetPackage<'_>
Get details of a specific package.
Sends a GET request to /v1/packages/{id}
Arguments:
id: Unique identifier for the package.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_package()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn rebuild_packages(&self) -> RebuildPackages<'_>
pub fn rebuild_packages(&self) -> RebuildPackages<'_>
Rebuild packages for a project. This will cancel any pending packages and create new ones with auto-incremented versions.
Sends a POST request to /v1/packages/rebuild
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.rebuild_packages()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn cancel_package(&self) -> CancelPackage<'_>
pub fn cancel_package(&self) -> CancelPackage<'_>
Cancel a pending or building package.
Sends a POST request to /v1/packages/{id}/cancel
Arguments:
id: Unique identifier for the package.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.cancel_package()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn list_releases(&self) -> ListReleases<'_>
pub fn list_releases(&self) -> ListReleases<'_>
Retrieve all releases.
Sends a GET request to /v1/releases
Arguments:
author: Filter by commit author login or namebranch: Filter by git branch (commitRef)created_after: Filter releases created after this date (ISO 8601)created_before: Filter releases created before this date (ISO 8601)cursor: Cursor for pagination - omit for first pageinclude: Optional fields to include: projectlimit: Maximum number of items to return per pageproject: Filter by project ID or name.search: Search releases by commit message, branch, SHA, or release IDworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_releases()
.author(author)
.branch(branch)
.created_after(created_after)
.created_before(created_before)
.cursor(cursor)
.include(include)
.limit(limit)
.project(project)
.search(search)
.workspace(workspace)
.send()
.await;Sourcepub fn create_release(&self) -> CreateRelease<'_>
pub fn create_release(&self) -> CreateRelease<'_>
Create a new release.
Sends a POST request to /v1/releases
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.create_release()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn list_release_branches(&self) -> ListReleaseBranches<'_>
pub fn list_release_branches(&self) -> ListReleaseBranches<'_>
List distinct git branches across releases. Used for filter dropdowns.
Sends a GET request to /v1/releases/branches
Arguments:
limit: Maximum number of branches to returnproject: Filter by project ID or name.search: Search branches by name (case-insensitive contains)workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_release_branches()
.limit(limit)
.project(project)
.search(search)
.workspace(workspace)
.send()
.await;List distinct commit authors across releases. Used for filter dropdowns.
Sends a GET request to /v1/releases/authors
Arguments:
limit: Maximum number of authors to returnproject: Filter by project ID or name.search: Search authors by login or name (case-insensitive contains)workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_release_authors()
.limit(limit)
.project(project)
.search(search)
.workspace(workspace)
.send()
.await;Sourcepub fn get_release(&self) -> GetRelease<'_>
pub fn get_release(&self) -> GetRelease<'_>
Retrieve a release by ID.
Sends a GET request to /v1/releases/{id}
Arguments:
id: Unique identifier for the release.include: Optional fields to include: projectworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_release()
.id(id)
.include(include)
.workspace(workspace)
.send()
.await;Sourcepub fn list_deployments(&self) -> ListDeployments<'_>
pub fn list_deployments(&self) -> ListDeployments<'_>
Retrieve all agents.
Sends a GET request to /v1/deployments
Arguments:
cursor: Cursor for pagination - omit for first pagedeployment_group: Filter by deployment group ID or nameinclude: Optional fields to include: release, deploymentGroup, projectlimit: Maximum number of items to return per pagemanager_id: Filter by agent manager IDplatform: Filter agents by platformproject: Filter by project ID or name.search: Search agents by name or deployment group namestatus: Filter agents by statusworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_deployments()
.cursor(cursor)
.deployment_group(deployment_group)
.include(include)
.limit(limit)
.manager_id(manager_id)
.platform(platform)
.project(project)
.search(search)
.status(status)
.workspace(workspace)
.send()
.await;Sourcepub fn create_deployment(&self) -> CreateDeployment<'_>
pub fn create_deployment(&self) -> CreateDeployment<'_>
Create a new agent. Deployment group tokens automatically use their group. Workspace/project tokens must provide deploymentGroupId.
Sends a POST request to /v1/deployments
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.create_deployment()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn get_deployment_stats(&self) -> GetDeploymentStats<'_>
pub fn get_deployment_stats(&self) -> GetDeploymentStats<'_>
Get aggregated agent statistics. Returns total count and breakdown by status.
Sends a GET request to /v1/deployments/stats
Arguments:
deployment_group: Filter by deployment group ID or namemanager_id: Filter by agent manager IDplatform: Filter agents by platformproject: Filter by project ID or name.search: Search agents by name or deployment group namestatus: Filter agents by statusworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_deployment_stats()
.deployment_group(deployment_group)
.manager_id(manager_id)
.platform(platform)
.project(project)
.search(search)
.status(status)
.workspace(workspace)
.send()
.await;Sourcepub fn list_deployment_filter_platforms(
&self,
) -> ListDeploymentFilterPlatforms<'_>
pub fn list_deployment_filter_platforms( &self, ) -> ListDeploymentFilterPlatforms<'_>
List distinct platforms used by agents. Used for filter dropdowns.
Sends a GET request to /v1/deployments/filter-platforms
Arguments:
project: Filter by project ID or name.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_deployment_filter_platforms()
.project(project)
.workspace(workspace)
.send()
.await;Sourcepub fn list_deployment_filter_deployment_groups(
&self,
) -> ListDeploymentFilterDeploymentGroups<'_>
pub fn list_deployment_filter_deployment_groups( &self, ) -> ListDeploymentFilterDeploymentGroups<'_>
List deployment groups with agent counts. Used for filter dropdowns.
Sends a GET request to /v1/deployments/filter-deployment-groups
Arguments:
limit: Maximum number of items to returnproject: Filter by project ID or name.search: Search deployment groups by nameworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_deployment_filter_deployment_groups()
.limit(limit)
.project(project)
.search(search)
.workspace(workspace)
.send()
.await;Sourcepub fn get_deployment(&self) -> GetDeployment<'_>
pub fn get_deployment(&self) -> GetDeployment<'_>
Retrieve an agent by ID.
Sends a GET request to /v1/deployments/{id}
Arguments:
id: Unique identifier for the deployment.include: Optional fields to include: release, deploymentGroup, projectworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_deployment()
.id(id)
.include(include)
.workspace(workspace)
.send()
.await;Sourcepub fn delete_deployment(&self) -> DeleteDeployment<'_>
pub fn delete_deployment(&self) -> DeleteDeployment<'_>
Delete an agent by ID. This can be used to start deletion or retry failed deletions.
Sends a DELETE request to /v1/deployments/{id}
Arguments:
id: Unique identifier for the deployment.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.delete_deployment()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn get_deployment_connection_info(&self) -> GetDeploymentConnectionInfo<'_>
pub fn get_deployment_connection_info(&self) -> GetDeploymentConnectionInfo<'_>
Get deployment connection information including ARC endpoint and resource URLs.
Sends a GET request to /v1/deployments/{id}/info
Arguments:
id: Unique identifier for the deployment.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_deployment_connection_info()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn import_deployment(&self) -> ImportDeployment<'_>
pub fn import_deployment(&self) -> ImportDeployment<'_>
Import an agent from existing infrastructure (e.g., CloudFormation stack). The agent ID is automatically generated.
Sends a POST request to /v1/deployments/import
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.import_deployment()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn redeploy_deployment(&self) -> RedeployDeployment<'_>
pub fn redeploy_deployment(&self) -> RedeployDeployment<'_>
Redeploy a running agent with the same release and fresh environment variables. Sets status to update-pending.
Sends a POST request to /v1/deployments/{id}/redeploy
Arguments:
id: Unique identifier for the deployment.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.redeploy_deployment()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn pin_deployment_release(&self) -> PinDeploymentRelease<'_>
pub fn pin_deployment_release(&self) -> PinDeploymentRelease<'_>
Pin or unpin agent to a specific release. Only works for running agents. Controller will automatically trigger update to target release.
Sends a POST request to /v1/deployments/{id}/pin-release
Arguments:
id: Unique identifier for the deployment.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.pin_deployment_release()
.id(id)
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn retry_deployment(&self) -> RetryDeployment<'_>
pub fn retry_deployment(&self) -> RetryDeployment<'_>
Retry a failed agent operation. Uses alien-infra’s retry mechanisms to resume from exact failure point.
Sends a POST request to /v1/deployments/{id}/retry
Arguments:
id: Unique identifier for the deployment.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.retry_deployment()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn update_deployment_environment_variables(
&self,
) -> UpdateDeploymentEnvironmentVariables<'_>
pub fn update_deployment_environment_variables( &self, ) -> UpdateDeploymentEnvironmentVariables<'_>
Update an agent’s environment variables. If the agent is running and not locked, the status will be changed to update-pending to trigger a deployment.
Sends a PATCH request to /v1/deployments/{id}/environment-variables
Arguments:
id: Unique identifier for the deployment.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.update_deployment_environment_variables()
.id(id)
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn create_deployment_token(&self) -> CreateDeploymentToken<'_>
pub fn create_deployment_token(&self) -> CreateDeploymentToken<'_>
Create an agent token (agent-scoped API key) for this agent. The agent must exist before creating a token.
Sends a POST request to /v1/deployments/{id}/token
Arguments:
id: Unique identifier for the deployment.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.create_deployment_token()
.id(id)
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn list_managers(&self) -> ListManagers<'_>
pub fn list_managers(&self) -> ListManagers<'_>
Retrieve all managers.
Sends a GET request to /v1/managers
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_managers()
.workspace(workspace)
.send()
.await;Sourcepub fn create_manager(&self) -> CreateManager<'_>
pub fn create_manager(&self) -> CreateManager<'_>
Create a new manager.
Sends a POST request to /v1/managers
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.create_manager()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn get_manager(&self) -> GetManager<'_>
pub fn get_manager(&self) -> GetManager<'_>
Retrieve a manager by ID.
Sends a GET request to /v1/managers/{id}
Arguments:
id: Unique identifier for a manager.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_manager()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn delete_manager(&self) -> DeleteManager<'_>
pub fn delete_manager(&self) -> DeleteManager<'_>
Delete a manager by ID.
Sends a DELETE request to /v1/managers/{id}
Arguments:
id: Unique identifier for a manager.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.delete_manager()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn get_manager_management_config(&self) -> GetManagerManagementConfig<'_>
pub fn get_manager_management_config(&self) -> GetManagerManagementConfig<'_>
Get the management configuration for a manager.
Sends a GET request to /v1/managers/{id}/management-config
Arguments:
id: Unique identifier for a manager.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_manager_management_config()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn provision_manager(&self) -> ProvisionManager<'_>
pub fn provision_manager(&self) -> ProvisionManager<'_>
Enqueue provisioning for a manager by ID.
Sends a POST request to /v1/managers/{id}/provision
Arguments:
id: Unique identifier for a manager.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.provision_manager()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn update_manager(&self) -> UpdateManager<'_>
pub fn update_manager(&self) -> UpdateManager<'_>
Update a manager to a specific release ID or active release.
Sends a POST request to /v1/managers/{id}/update
Arguments:
id: Unique identifier for a manager.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.update_manager()
.id(id)
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn list_manager_events(&self) -> ListManagerEvents<'_>
pub fn list_manager_events(&self) -> ListManagerEvents<'_>
Retrieve all events of a manager.
Sends a GET request to /v1/managers/{id}/events
Arguments:
idworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_manager_events()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn generate_deepstore_token(&self) -> GenerateDeepstoreToken<'_>
pub fn generate_deepstore_token(&self) -> GenerateDeepstoreToken<'_>
Generate a JWT token and connection info for querying manager logs directly. Returns everything the browser needs to create a DeepstoreClient and query the data plane without routing log data through the platform API (end-to-end encryption).
Sends a POST request to /v1/managers/{id}/deepstore/token
Arguments:
id: Unique identifier for a manager.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.generate_deepstore_token()
.id(id)
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn report_manager_heartbeat(&self) -> ReportManagerHeartbeat<'_>
pub fn report_manager_heartbeat(&self) -> ReportManagerHeartbeat<'_>
Report Manager health status and metrics.
Sends a POST request to /v1/managers/{id}/heartbeat
Arguments:
id: Unique identifier for a manager.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.report_manager_heartbeat()
.id(id)
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn get_manager_deployment(&self) -> GetManagerDeployment<'_>
pub fn get_manager_deployment(&self) -> GetManagerDeployment<'_>
Get deployment details for a user manager (internal agent platform, status, resources).
Sends a GET request to /v1/managers/{id}/deployment
Arguments:
id: Unique identifier for a manager.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_manager_deployment()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn connect_manager_to_google_cloud(&self) -> ConnectManagerToGoogleCloud<'_>
pub fn connect_manager_to_google_cloud(&self) -> ConnectManagerToGoogleCloud<'_>
Connect a Google Cloud manager via OAuth.
Sends a GET request to /v1/managers/{id}/google-cloud-connect
Arguments:
id: Unique identifier for a manager.project_id: GCP project ID where the manager will be deployedredirect_urlregion: GCP region where the manager will be deployedworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.connect_manager_to_google_cloud()
.id(id)
.project_id(project_id)
.redirect_url(redirect_url)
.region(region)
.workspace(workspace)
.send()
.await;Sourcepub fn list_api_keys(&self) -> ListApiKeys<'_>
pub fn list_api_keys(&self) -> ListApiKeys<'_>
Retrieve all API keys for the current workspace.
Sends a GET request to /v1/api-keys
Arguments:
cursor: Cursor for pagination - omit for first pagelimit: Maximum number of items to return per pageworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_api_keys()
.cursor(cursor)
.limit(limit)
.workspace(workspace)
.send()
.await;Sourcepub fn create_api_key(&self) -> CreateApiKey<'_>
pub fn create_api_key(&self) -> CreateApiKey<'_>
Create a new API key.
Sends a POST request to /v1/api-keys
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.create_api_key()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn get_api_key(&self) -> GetApiKey<'_>
pub fn get_api_key(&self) -> GetApiKey<'_>
Retrieve a specific API key.
Sends a GET request to /v1/api-keys/{id}
Arguments:
id: Unique identifier for the api key.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_api_key()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn revoke_api_key(&self) -> RevokeApiKey<'_>
pub fn revoke_api_key(&self) -> RevokeApiKey<'_>
Revoke (soft delete) an API key.
Sends a DELETE request to /v1/api-keys/{id}
Arguments:
id: Unique identifier for the api key.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.revoke_api_key()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn update_api_key(&self) -> UpdateApiKey<'_>
pub fn update_api_key(&self) -> UpdateApiKey<'_>
Update an API key (enable/disable, change description).
Sends a PATCH request to /v1/api-keys/{id}
Arguments:
id: Unique identifier for the api key.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.update_api_key()
.id(id)
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn delete_api_keys(&self) -> DeleteApiKeys<'_>
pub fn delete_api_keys(&self) -> DeleteApiKeys<'_>
Permanently delete multiple API keys.
Sends a POST request to /v1/api-keys/batch-delete
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.delete_api_keys()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn list_domains(&self) -> ListDomains<'_>
pub fn list_domains(&self) -> ListDomains<'_>
List system domains and workspace domains.
Sends a GET request to /v1/domains
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_domains()
.workspace(workspace)
.send()
.await;Sourcepub fn create_domain(&self) -> CreateDomain<'_>
pub fn create_domain(&self) -> CreateDomain<'_>
Create a workspace domain.
Sends a POST request to /v1/domains
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.create_domain()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn get_domain(&self) -> GetDomain<'_>
pub fn get_domain(&self) -> GetDomain<'_>
Get domain by ID.
Sends a GET request to /v1/domains/{id}
Arguments:
id: Unique identifier for the domain.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_domain()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn delete_domain(&self) -> DeleteDomain<'_>
pub fn delete_domain(&self) -> DeleteDomain<'_>
Delete a workspace domain.
Sends a DELETE request to /v1/domains/{id}
Arguments:
id: Unique identifier for the domain.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.delete_domain()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn list_events(&self) -> ListEvents<'_>
pub fn list_events(&self) -> ListEvents<'_>
Retrieve all events.
Sends a GET request to /v1/events
Arguments:
cursor: Cursor for pagination - omit for first pagelimit: Maximum number of items to return per pageproject: Filter by project ID or name.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_events()
.cursor(cursor)
.limit(limit)
.project(project)
.workspace(workspace)
.send()
.await;Sourcepub fn get_event(&self) -> GetEvent<'_>
pub fn get_event(&self) -> GetEvent<'_>
Retrieve an event by ID.
Sends a GET request to /v1/events/{id}
Arguments:
id: Unique identifier for the event.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_event()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn list_commands(&self) -> ListCommands<'_>
pub fn list_commands(&self) -> ListCommands<'_>
Retrieve commands. Use for dashboard analytics and command history.
Sends a GET request to /v1/commands
Arguments:
created_after: Filter commands created after this date (ISO 8601)created_before: Filter commands created before this date (ISO 8601)cursor: Cursor for pagination - omit for first pagedeployment_id: Filter by deployment IDinclude: Optional fields to include: deployment, projectlimit: Maximum number of items to return per pagename: Filter by command nameproject: Filter by project ID or name.state: Filter by command stateworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_commands()
.created_after(created_after)
.created_before(created_before)
.cursor(cursor)
.deployment_id(deployment_id)
.include(include)
.limit(limit)
.name(name)
.project(project)
.state(state)
.workspace(workspace)
.send()
.await;Sourcepub fn create_command(&self) -> CreateCommand<'_>
pub fn create_command(&self) -> CreateCommand<'_>
Create command metadata. Called by Agent Manager when processing ARC commands. Returns project info for routing decisions.
Sends a POST request to /v1/commands
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.create_command()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn list_command_names(&self) -> ListCommandNames<'_>
pub fn list_command_names(&self) -> ListCommandNames<'_>
List distinct command names. Use for filter dropdowns in the dashboard.
Sends a GET request to /v1/commands/names
Arguments:
project: Filter by project ID or name.search: Search command names (prefix match)workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_command_names()
.project(project)
.search(search)
.workspace(workspace)
.send()
.await;Sourcepub fn list_command_agents(&self) -> ListCommandAgents<'_>
pub fn list_command_agents(&self) -> ListCommandAgents<'_>
List distinct deployments that have commands, including deployment group info. Use for filter dropdowns in the dashboard.
Sends a GET request to /v1/commands/deployments
Arguments:
project: Filter by project ID or name.search: Search deployment or deployment group namesworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_command_agents()
.project(project)
.search(search)
.workspace(workspace)
.send()
.await;Sourcepub fn get_command(&self) -> GetCommand<'_>
pub fn get_command(&self) -> GetCommand<'_>
Retrieve a command by ID.
Sends a GET request to /v1/commands/{id}
Arguments:
id: Unique identifier for the command.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_command()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn update_command(&self) -> UpdateCommand<'_>
pub fn update_command(&self) -> UpdateCommand<'_>
Update command state. Called by Agent Manager when command is dispatched or completes.
Sends a PATCH request to /v1/commands/{id}
Arguments:
id: Unique identifier for the command.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.update_command()
.id(id)
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn get_deployment_info(&self) -> GetDeploymentInfo<'_>
pub fn get_deployment_info(&self) -> GetDeploymentInfo<'_>
Get deployment information for the deployment page. Accepts both agent-scoped and deployment-group-scoped API keys. Returns project information, package status/outputs, and either agent or deployment group details depending on the token type. Poll this endpoint to check if packages are ready.
Sends a GET request to /v1/deployment-info
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_deployment_info()
.workspace(workspace)
.send()
.await;Sourcepub fn sync_acquire(&self) -> SyncAcquire<'_>
pub fn sync_acquire(&self) -> SyncAcquire<'_>
Acquire a batch of deployments for processing. Used by Manager to atomically lock deployments matching filters. Each deployment in the batch must be released after processing.
Sends a POST request to /v1/sync/acquire
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.sync_acquire()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn sync_reconcile(&self) -> SyncReconcile<'_>
pub fn sync_reconcile(&self) -> SyncReconcile<'_>
Reconcile agent deployment state. Push model (with session) verifies lock ownership. Pull model (no session) verifies agent is unlocked. Accepts full DeploymentState after step() execution.
Sends a POST request to /v1/sync/reconcile
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.sync_reconcile()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn sync_release(&self) -> SyncRelease<'_>
pub fn sync_release(&self) -> SyncRelease<'_>
Release an agent’s deployment lock. Must be called after processing an acquired agent, even if processing failed. This is critical to avoid deadlocks.
Sends a POST request to /v1/sync/release
Arguments:
workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.body
let response = client.sync_release()
.workspace(workspace)
.body(body)
.send()
.await;Sourcepub fn get_container_overview(&self) -> GetContainerOverview<'_>
pub fn get_container_overview(&self) -> GetContainerOverview<'_>
Bird’s-eye view of all container definitions across all deployments, with aggregate health stats, machine health breakdown, and HTTP performance metrics.
Sends a GET request to /v1/containers/overview
Arguments:
deployment_group_idproject: Filter by project ID or name.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_container_overview()
.deployment_group_id(deployment_group_id)
.project(project)
.workspace(workspace)
.send()
.await;Sourcepub fn get_container_attention(&self) -> GetContainerAttention<'_>
pub fn get_container_attention(&self) -> GetContainerAttention<'_>
Returns deployments that need attention: crash loops, scheduling failures, unhealthy machines.
Sends a GET request to /v1/containers/attention
Arguments:
deployment_group_idproject: Filter by project ID or name.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_container_attention()
.deployment_group_id(deployment_group_id)
.project(project)
.workspace(workspace)
.send()
.await;Sourcepub fn get_container_definition_deployments(
&self,
) -> GetContainerDefinitionDeployments<'_>
pub fn get_container_definition_deployments( &self, ) -> GetContainerDefinitionDeployments<'_>
Per-deployment breakdown for a container: status, replicas, metrics, and HTTP performance across all deployments running this container.
Sends a GET request to /v1/containers/{containerName}/deployments
Arguments:
container_namedeployment_group_idproject: Filter by project ID or name.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_container_definition_deployments()
.container_name(container_name)
.deployment_group_id(deployment_group_id)
.project(project)
.workspace(workspace)
.send()
.await;Sourcepub fn get_container_machines(&self) -> GetContainerMachines<'_>
pub fn get_container_machines(&self) -> GetContainerMachines<'_>
Cross-deployment machine health: per-deployment machine counts by status, capacity group utilization, and scaling recommendations.
Sends a GET request to /v1/containers/machines
Arguments:
deployment_group_idproject: Filter by project ID or name.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_container_machines()
.deployment_group_id(deployment_group_id)
.project(project)
.workspace(workspace)
.send()
.await;Sourcepub fn get_deployment_cluster(&self) -> GetDeploymentCluster<'_>
pub fn get_deployment_cluster(&self) -> GetDeploymentCluster<'_>
Container cluster overview for a specific deployment: machine count, container count, and capacity.
Sends a GET request to /v1/containers/deployments/{id}/cluster
Arguments:
id: Unique identifier for the deployment.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_deployment_cluster()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn list_deployment_containers(&self) -> ListDeploymentContainers<'_>
pub fn list_deployment_containers(&self) -> ListDeploymentContainers<'_>
List all containers running in a specific deployment.
Sends a GET request to /v1/containers/deployments/{id}/containers
Arguments:
id: Unique identifier for the deployment.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_deployment_containers()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn get_deployment_container(&self) -> GetDeploymentContainer<'_>
pub fn get_deployment_container(&self) -> GetDeploymentContainer<'_>
Get detailed status, configuration, and replica metrics for a specific container in a deployment.
Sends a GET request to /v1/containers/deployments/{id}/containers/{containerName}
Arguments:
id: Unique identifier for the deployment.container_nameworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.get_deployment_container()
.id(id)
.container_name(container_name)
.workspace(workspace)
.send()
.await;Sourcepub fn list_deployment_machines(&self) -> ListDeploymentMachines<'_>
pub fn list_deployment_machines(&self) -> ListDeploymentMachines<'_>
List all compute machines in a deployment’s container cluster.
Sends a GET request to /v1/containers/deployments/{id}/machines
Arguments:
id: Unique identifier for the deployment.workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_deployment_machines()
.id(id)
.workspace(workspace)
.send()
.await;Sourcepub fn list_deployment_container_events(
&self,
) -> ListDeploymentContainerEvents<'_>
pub fn list_deployment_container_events( &self, ) -> ListDeploymentContainerEvents<'_>
List orchestration events for a deployment’s container cluster.
Sends a GET request to /v1/containers/deployments/{id}/events
Arguments:
id: Unique identifier for the deployment.involved_object_idinvolved_object_typelimitreasontype_workspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_deployment_container_events()
.id(id)
.involved_object_id(involved_object_id)
.involved_object_type(involved_object_type)
.limit(limit)
.reason(reason)
.type_(type_)
.workspace(workspace)
.send()
.await;Sourcepub fn list_deployment_container_instance_events(
&self,
) -> ListDeploymentContainerInstanceEvents<'_>
pub fn list_deployment_container_instance_events( &self, ) -> ListDeploymentContainerInstanceEvents<'_>
List orchestration events for a specific container in a deployment.
Sends a GET request to /v1/containers/deployments/{id}/containers/{containerName}/events
Arguments:
id: Unique identifier for the deployment.container_namelimitworkspace: Workspace name. Defaults to your last workspace (user auth) or your API key’s workspace (token auth). When using an API key, if provided, must match the key’s workspace.
let response = client.list_deployment_container_instance_events()
.id(id)
.container_name(container_name)
.limit(limit)
.workspace(workspace)
.send()
.await;