EnvironmentsApi API

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

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

Quick Reference

Method	Description
createEnvironment
createInstalledProvider
deleteEnvironment
deleteInstalledProvider
getDiffFiles
getEnvironment
getFullProject
getInstalledProvider
getLocalProviders
getProviderStatus
getRunningProviders
installProvider
listEnvironments
listInstalledProviders
mergePatch
readFile
restartEnvironment
sendPullRequest
setDefaultProvider
startEnvironment
startProvider
stopEnvironment
stopProvider
updateEnvironment
updateInstalledProvider
writeFile

Methods

---

createEnvironment

plugin.environmentsApi.createEnvironment(data: CreateEnvironmentRequest): Promise<Environment>

Parameter	Type	Required	Description
data	CreateEnvironmentRequest	Yes

Returns: Promise<Environment>

Full reference →

---

createInstalledProvider

plugin.environmentsApi.createInstalledProvider(data: CreateInstalledProviderRequest): Promise<InstalledProvider>

Parameter	Type	Required	Description
data	CreateInstalledProviderRequest	Yes

Returns: Promise<InstalledProvider>

Full reference →

---

deleteEnvironment

plugin.environmentsApi.deleteEnvironment(id: string): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<unknown>

Full reference →

---

deleteInstalledProvider

plugin.environmentsApi.deleteInstalledProvider(id: string): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<unknown>

Full reference →

---

getDiffFiles

plugin.environmentsApi.getDiffFiles(id: string, data: GetDiffFilesRequest): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	GetDiffFilesRequest	Yes

Returns: Promise<unknown>

Full reference →

---

getEnvironment

plugin.environmentsApi.getEnvironment(id: string): Promise<Environment>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<Environment>

Full reference →

---

getFullProject

plugin.environmentsApi.getFullProject(id: string): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<unknown>

Full reference →

---

getInstalledProvider

plugin.environmentsApi.getInstalledProvider(id: string): Promise<InstalledProvider>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<InstalledProvider>

Full reference →

---

getLocalProviders

plugin.environmentsApi.getLocalProviders(): Promise<ProviderData[]>

No parameters.

Returns: Promise<ProviderData[]>

Full reference →

---

getProviderStatus

plugin.environmentsApi.getProviderStatus(id: string): Promise<EnvironmentProviderStatus>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<EnvironmentProviderStatus>

Full reference →

---

getRunningProviders

plugin.environmentsApi.getRunningProviders(): Promise<InstalledProvider[]>

No parameters.

Returns: Promise<InstalledProvider[]>

Full reference →

---

installProvider

plugin.environmentsApi.installProvider(data: InstallProviderRequest): Promise<InstalledProvider>

Parameter	Type	Required	Description
data	InstallProviderRequest	Yes

Returns: Promise<InstalledProvider>

Full reference →

---

listEnvironments

plugin.environmentsApi.listEnvironments(params?: Record<string, unknown>): Promise<Environment[]>

Parameter	Type	Required	Description
params	Record<string, unknown>	No

Returns: Promise<Environment[]>

Full reference →

---

listInstalledProviders

plugin.environmentsApi.listInstalledProviders(params?: Record<string, unknown>): Promise<InstalledProvider[]>

Parameter	Type	Required	Description
params	Record<string, unknown>	No

Returns: Promise<InstalledProvider[]>

Full reference →

---

mergePatch

plugin.environmentsApi.mergePatch(id: string, data: MergePatchRequest): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	MergePatchRequest	Yes

Returns: Promise<unknown>

Full reference →

---

readFile

plugin.environmentsApi.readFile(id: string, data: ReadEnvironmentFileRequest): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	ReadEnvironmentFileRequest	Yes

Returns: Promise<unknown>

Full reference →

---

restartEnvironment

plugin.environmentsApi.restartEnvironment(id: string, data?: Record<string, unknown>): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	Record<string, unknown>	No

Returns: Promise<unknown>

Full reference →

---

sendPullRequest

plugin.environmentsApi.sendPullRequest(id: string, data: SendPullRequestRequest): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	SendPullRequestRequest	Yes

Returns: Promise<unknown>

Full reference →

---

setDefaultProvider

plugin.environmentsApi.setDefaultProvider(id: string, data?: Record<string, unknown>): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	Record<string, unknown>	No

Returns: Promise<unknown>

Full reference →

---

startEnvironment

plugin.environmentsApi.startEnvironment(id: string, data?: Record<string, unknown>): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	Record<string, unknown>	No

Returns: Promise<unknown>

Full reference →

---

startProvider

plugin.environmentsApi.startProvider(id: string, data?: Record<string, unknown>): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	Record<string, unknown>	No

Returns: Promise<unknown>

Full reference →

---

stopEnvironment

plugin.environmentsApi.stopEnvironment(id: string, data?: Record<string, unknown>): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	Record<string, unknown>	No

Returns: Promise<unknown>

Full reference →

---

stopProvider

plugin.environmentsApi.stopProvider(id: string, data?: Record<string, unknown>): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	Record<string, unknown>	No

Returns: Promise<unknown>

Full reference →

---

updateEnvironment

plugin.environmentsApi.updateEnvironment(id: string, data: UpdateEnvironmentRequest): Promise<Environment>

Parameter	Type	Required	Description
id	string	Yes
data	UpdateEnvironmentRequest	Yes

Returns: Promise<Environment>

Full reference →

---

updateInstalledProvider

plugin.environmentsApi.updateInstalledProvider(id: string, data: UpdateInstalledProviderRequest): Promise<InstalledProvider>

Parameter	Type	Required	Description
id	string	Yes
data	UpdateInstalledProviderRequest	Yes

Returns: Promise<InstalledProvider>

Full reference →

---

writeFile

plugin.environmentsApi.writeFile(id: string, data: WriteEnvironmentFileRequest): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	WriteEnvironmentFileRequest	Yes

Returns: Promise<unknown>

Full reference →