POST realm/deployments

The web method POST realm/deployments starts a transaction to deploy the workspace.

For more information, see The Deploy Transaction.

JSON Attributes

You may supply JSON data with the request:

{
  "name":"MyDeployment",
  "description":"This deployment is not like the others."
}

Attribute	Description
name	Optional. When present, the realm server names the deployment with the name string you supply. When absent, the realm server names the deployment with a time stamp string.
description	Optional. When present, the realm server adds the description string you supply to the deployment object. When absent, the deployment has no description.

Attribute

Description

name

Optional.

When present, the realm server names the deployment with the name string you supply.

When absent, the realm server names the deployment with a time stamp string.

description

Optional.

When present, the realm server adds the description string you supply to the deployment object.

When absent, the deployment has no description.

Syntax	Description
force=`boolean`	Optional. When `true`, force deployment of the workspace, even if the current user does not hold the modification lock. For example, you can force deployment of modifications made by another user who is unavailable to deploy them in person.

Syntax

Description

force=boolean

Optional.

When true, force deployment of the workspace, even if the current user does not hold the modification lock.

For example, you can force deployment of modifications made by another user who is unavailable to deploy them in person.

curl -X POST http://host:port/api/v1/realm/deployments -d json_data