Class AgentDeploymentResource

Cloud agent deployments — vsdk.agents.deployment.

Index

Constructors

Methods

delete get getLatestVersion list logs setVersionActive

Constructors

constructor

new AgentDeploymentResource(http: HttpClient): AgentDeploymentResource
Parameters
- http: HttpClient
Returns AgentDeploymentResource

Methods

delete

delete(
deploymentId: string,
options?: { force?: boolean },
): Promise<{ message: string }>
Delete a deployment.
Parameters
- deploymentId: string
- options: { force?: boolean } = {}
Returns Promise<{ message: string }>

get

get(deploymentId: string): Promise<AgentDeployment>
Fetch a single deployment by id. Throws RoomNotFoundError if not found.
Parameters
- deploymentId: string
Returns Promise<AgentDeployment>

getLatestVersion

getLatestVersion(deploymentId: string): Promise<AgentDeploymentVersion>
Fetch the latest version of a deployment.
Parameters
- deploymentId: string
Returns Promise<AgentDeploymentVersion>

list

list(params?: ListDeploymentsParams): Promise<Page<AgentDeployment>>
List cloud agent deployments (paginated, async-iterable).
Parameters
- params: ListDeploymentsParams = {}
Returns Promise<Page<AgentDeployment>>

logs

logs(
deploymentId: string,
params?: ListDeploymentLogsParams,
): Promise<Page<AgentLogEntry>>
List a deployment's console logs (paginated, async-iterable). This is a historical query (default: last 24h), not a live stream.
Parameters
- deploymentId: string
- params: ListDeploymentLogsParams = {}
Returns Promise<Page<AgentLogEntry>>

setVersionActive

setVersionActive(
    versionId: string,
    activate: boolean,
    options?: { force?: boolean },
): Promise<{ message: string }>
Re-point a deployment at a version, or stop it. activate: true rolls onto versionId; activate: false stops the running version. (Not needed after AgentsResource.deploy, which already activates.)
Parameters
- versionId: string
- activate: boolean
- options: { force?: boolean } = {}
Returns Promise<{ message: string }>