Environment API

The environment module of the @codebolt/plugin-sdk.

import plugin from '@codebolt/plugin-sdk';

Quick Reference

Method	Description
createEnvironment
deleteEnvironment
getEnvironment
getEnvironmentStatistics
getEnvironmentStatus
getLocalProviders
getRunningProviders
listEnvironments
restartEnvironment
sendMessageToEnvironment
startAgentInEnvironment
startEnvironment
stopEnvironment
updateEnvironment

Methods

---

createEnvironment

plugin.environment.createEnvironment(environmentData: object): Promise<any>

Parameter	Type	Required	Description
environmentData	object	Yes

Returns: Promise<any>

Full reference →

---

deleteEnvironment

plugin.environment.deleteEnvironment(environmentId: string): Promise<any>

Parameter	Type	Required	Description
environmentId	string	Yes

Returns: Promise<any>

Full reference →

---

getEnvironment

plugin.environment.getEnvironment(environmentId: string): Promise<any>

Parameter	Type	Required	Description
environmentId	string	Yes

Returns: Promise<any>

Full reference →

---

getEnvironmentStatistics

plugin.environment.getEnvironmentStatistics(): Promise<any>

No parameters.

Returns: Promise<any>

Full reference →

---

getEnvironmentStatus

plugin.environment.getEnvironmentStatus(environmentId: string): Promise<any>

Parameter	Type	Required	Description
environmentId	string	Yes

Returns: Promise<any>

Full reference →

---

getLocalProviders

plugin.environment.getLocalProviders(): Promise<any>

No parameters.

Returns: Promise<any>

Full reference →

---

getRunningProviders

plugin.environment.getRunningProviders(): Promise<any>

No parameters.

Returns: Promise<any>

Full reference →

---

listEnvironments

plugin.environment.listEnvironments(): Promise<any>

No parameters.

Returns: Promise<any>

Full reference →

---

restartEnvironment

plugin.environment.restartEnvironment(environmentId: string): Promise<any>

Parameter	Type	Required	Description
environmentId	string	Yes

Returns: Promise<any>

Full reference →

---

sendMessageToEnvironment

plugin.environment.sendMessageToEnvironment(environmentId: string, message: any): Promise<any>

Parameter	Type	Required	Description
environmentId	string	Yes
message	any	Yes

Returns: Promise<any>

Full reference →

---

startAgentInEnvironment

plugin.environment.startAgentInEnvironment(environmentId: string, task: string, agentId?: string, threadId?: string): Promise<any>

Parameter	Type	Required	Description
environmentId	string	Yes
task	string	Yes
agentId	string	No
threadId	string	No

Returns: Promise<any>

Full reference →

---

startEnvironment

plugin.environment.startEnvironment(environmentId: string): Promise<any>

Parameter	Type	Required	Description
environmentId	string	Yes

Returns: Promise<any>

Full reference →

---

stopEnvironment

plugin.environment.stopEnvironment(environmentId: string): Promise<any>

Parameter	Type	Required	Description
environmentId	string	Yes

Returns: Promise<any>

Full reference →

---

updateEnvironment

plugin.environment.updateEnvironment(environmentId: string, updateData: any): Promise<any>

Parameter	Type	Required	Description
environmentId	string	Yes
updateData	any	Yes

Returns: Promise<any>

Full reference →