Edit Environment API
Use this API to edit an existing environment in your project.
API Description
Method | Path |
---|---|
POST | /v1/projects/{projectId}/environments/{environmentId} |
Headers | |
---|---|
Authorization | Bearer: [API key] |
Full Endpoint URL https://api.flightcontrol.dev/v1/projects/{projectId}/environments/{environmentId}
Body
Parameter | Required | Type | Description |
---|---|---|---|
name | optional | string | The environment name displayed in Flightcontrol dashboard. |
source | optional | object: check below for detail | The source used to build your environment. |
The source
object
Parameter | Required | Type | Description |
---|---|---|---|
branch | optional | string | The Git branch in github used to provision and build the environment’s services. |
trigger | optional | ”push” or “manual” | Whether the environment is deployed automatically with every Git push (Git push to deploy) or deployed manually through the dashboard or deploy hooks |
Response Example
[
{
"message": "Environment updated successfully"
}
]
Response Conditions
Success
Errors