The deploy operation is used to deploy changes from a Git repository.

Request Packet Structure

A request XML packet deploying changes from a Git repository, includes the deploy operation node:

<packet>
    <extension>
        <call>
            <git>
                <deploy>
                    ...
                </deploy>
            </git>
        </call>
    </extension>
</packet>

The deploy node has the following structure:

  • The domain node is required. It specifies the domain. Data type: string.
  • The name node is required. It specifies the repository name. Data type: string.

Response Packet Structure

The output XML packet is structured as follows:

<packet>
    <extension>
        <call>
            <result>
                <status>
                    ...
                </status>
                ...
                <git>
                    <deploy/>
                </git>
            </result>
        </call>
    </extension>
</packet>
  • The result node is required. It contains the following nodes:
    • The status node is required. It specifies the execution status of the deploy operation. Data type: result_status. Allowed values: ok | error.
    • The errcode node is optional. It is used to return the error code when the deploy operation fails. Data type: unsignedInt.
    • The errtext node is optional. It is used to return the error message if the deploy operation fails. Data type: string.
    • The git node is required and contains the deploy node.

Samples

This package deploys changes from a Git repository:

<packet>
    <extension>
        <call>
            <git>
                <deploy>
                    <domain>example.com</domain>
                    <name>example1</name>
                </deploy>
            </git>
        </call>
    </extension>
</packet>

Response:

<packet>
    <extension>
        <call>
            <result>
                <status>ok</status>
                <git>
                    <deploy/>
                </git>
            </result>
        </call>
    </extension>
</packet>