DeploymentApi¶

All URIs are relative to http://localhost:8080/api/v3

Method	HTTP request	Description
createDeployment	POST /deployment/	Creates a new deployment
deleteDeploymentById	DELETE /deployment/{deploymentId}	Deletes a deployment
getDeploymentById	GET /deployment/{deploymentId}	Find deployment by ID
getDeployments	GET /deployment/	Returns a list of deployments
startDeploymentById	PUT /deployment/{deploymentId}/start	Starts a deployment
stopDeploymentById	PUT /deployment/{deploymentId}/stop	Stops a deployment
updateDeployment	PUT /deployment/{deploymentId}	Updates a deployment

createDeployment¶

Map createDeployment(body, api_key)

Creates a new deployment

Parameters¶

Name	Type	Description	Notes
body	Object
api_key	String		[optional] [default to null]

Return type¶

Map

Authorization¶

api_key

HTTP request headers¶

Content-Type: application/json
Accept: application/json

deleteDeploymentById¶

Map deleteDeploymentById(deploymentId, api_key)

Deletes a deployment

Deletes a deployment

Parameters¶

Name	Type	Description	Notes
deploymentId	String	ID of deployment that needs to be deleted	[default to null]
api_key	String		[optional] [default to null]

Return type¶

Map

Authorization¶

api_key

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

getDeploymentById¶

Map getDeploymentById(deploymentId, api_key)

Find deployment by ID

Returns a single deployment

Parameters¶

Name	Type	Description	Notes
deploymentId	String	ID of deployment to return	[default to null]
api_key	String		[optional] [default to null]

Return type¶

Map

Authorization¶

api_key

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

getDeployments¶

List getDeployments(api_key)

Returns a list of deployments

Returns the list of deployments

Parameters¶

Name	Type	Description	Notes
api_key	String		[optional] [default to null]

Return type¶

List

Authorization¶

api_key

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

startDeploymentById¶

Map startDeploymentById(deploymentId, api_key)

Starts a deployment

Starts a deployment

Parameters¶

Name	Type	Description	Notes
deploymentId	String	ID of deployment to be resumed	[default to null]
api_key	String		[optional] [default to null]

Return type¶

Map

Authorization¶

api_key

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

stopDeploymentById¶

Map stopDeploymentById(deploymentId, api_key)

Stops a deployment

Stops a deployment

Parameters¶

Name	Type	Description	Notes
deploymentId	String	ID of deployment that needs to be stopped	[default to null]
api_key	String		[optional] [default to null]

Return type¶

Map

Authorization¶

api_key

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

updateDeployment¶

Map updateDeployment(deploymentId, body, api_key)

Updates a deployment

Updates a deployment

Parameters¶

Name	Type	Description	Notes
deploymentId	String	ID of deployment that needs to be updated	[default to null]
body	Object
api_key	String		[optional] [default to null]

Return type¶

Map

Authorization¶

api_key

HTTP request headers¶

Content-Type: application/json
Accept: application/json