Deploy Project

Prerequisites

• The caller must provide a project id.

Authorization

• API key (via the X-API-KEY header).

Parameters

<Accordion title="Path Parameters"> | Field name | Description | Format | | :--------- | :-------------------- | :----- | | **id** | The ID of the project | UUID | </Accordion>

<Accordion title="Query Parameters"> | Field name | Description | Format | | :--------- | :------------------- | :----- | | version | The project version | String | | deployer | The deployer | String | | profile | The deployer profile | String | </Accordion>

<Accordion title="Request Body"> | Field name | Description | Format | | :--------------------- | :----------------------------------------------------------- | :----- | | **environmentType** | The deployment environment type | String | | activeProfiles | Active profiles | Array | | configurationVariables | [Configuration variables](#configuration-variable-structure) | Array | | applicationName | The deployment application name | String | </Accordion>

<Accordion title="Configuration Variable Structure"> <div id="configuration-variable-structure"> | Field name | Description | Format | | :--------- | :------------------------ | :----- | | name | The configuration name | String | | type | The configuration type | String | | default | The configuration default | Object | </div> </Accordion>

<Accordion title="Response Body"> | Field name | Description | Format | | :--------- | :------------------------------- | :----- | | id | The ID of the deployment service | UUID | | status | The deployment status | String | </Accordion>

Examples

<Tabs> <Tab title="Project"> ```json Request { "environmentType": "TEST", "activeProfiles": [ "$default" ], "configurationVariables": [ { "name": "VARIABLE", "type": "INTEGER", "default": 0 } ], "applicationName": "deployment-name" } ``` ```json Response { "id": "00000000-0000-0000-0000-000000004444", "status": "STARTED" } ``` </Tab>

<Tab /> </Tabs>