Update an environment
curl --request PUT \
--url https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/environment/{environmentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Tenant-Id: <tenant-id>' \
--data '
{
"id": "<string>",
"sk": "<string>",
"name": "<string>",
"description": "<string>"
}
'import requests
url = "https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/environment/{environmentId}"
payload = {
"id": "<string>",
"sk": "<string>",
"name": "<string>",
"description": "<string>"
}
headers = {
"Tenant-Id": "<tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'Tenant-Id': '<tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({id: '<string>', sk: '<string>', name: '<string>', description: '<string>'})
};
fetch('https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/environment/{environmentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/environment/{environmentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'sk' => '<string>',
'name' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Tenant-Id: <tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/environment/{environmentId}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"sk\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Tenant-Id", "<tenant-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/environment/{environmentId}")
.header("Tenant-Id", "<tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"sk\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/environment/{environmentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Tenant-Id"] = '<tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"sk\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"sk": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"aws_region": "us-east-1",
"aws_account_id": "<string>",
"status": "CLONED",
"total_resources": 123,
"env_variables": [
{
"id": "<string>",
"name": "<string>",
"value": "<string>",
"sensitive": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"actor": "<string>"
}
],
"webhooks": [
{
"id": "<string>",
"events": [
"<string>"
],
"endpoint": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"last_workflow_id": "<string>",
"stack_info": "<string>",
"bootstraped_info": {
"artifacts_bucket_arn": "<string>",
"artifacts_bucket_name": "<string>",
"openid_role_arn": "<string>",
"openid_role_name": "<string>"
},
"month_cost": {
"cost": 123,
"cost_unit": "<string>",
"max_day_cost": 123,
"min_day_cost": 123,
"average_day_cost": 123
}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}Environments
Update an environment
PUT
/
environment
/
{environmentId}
Update an environment
curl --request PUT \
--url https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/environment/{environmentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Tenant-Id: <tenant-id>' \
--data '
{
"id": "<string>",
"sk": "<string>",
"name": "<string>",
"description": "<string>"
}
'import requests
url = "https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/environment/{environmentId}"
payload = {
"id": "<string>",
"sk": "<string>",
"name": "<string>",
"description": "<string>"
}
headers = {
"Tenant-Id": "<tenant-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'Tenant-Id': '<tenant-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({id: '<string>', sk: '<string>', name: '<string>', description: '<string>'})
};
fetch('https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/environment/{environmentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/environment/{environmentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'sk' => '<string>',
'name' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Tenant-Id: <tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/environment/{environmentId}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"sk\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Tenant-Id", "<tenant-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/environment/{environmentId}")
.header("Tenant-Id", "<tenant-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"sk\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://9nr7sbhimh.execute-api.us-west-1.amazonaws.com/prod/environment/{environmentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Tenant-Id"] = '<tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"sk\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"sk": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"aws_region": "us-east-1",
"aws_account_id": "<string>",
"status": "CLONED",
"total_resources": 123,
"env_variables": [
{
"id": "<string>",
"name": "<string>",
"value": "<string>",
"sensitive": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"actor": "<string>"
}
],
"webhooks": [
{
"id": "<string>",
"events": [
"<string>"
],
"endpoint": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"last_workflow_id": "<string>",
"stack_info": "<string>",
"bootstraped_info": {
"artifacts_bucket_arn": "<string>",
"artifacts_bucket_name": "<string>",
"openid_role_arn": "<string>",
"openid_role_name": "<string>"
},
"month_cost": {
"cost": 123,
"cost_unit": "<string>",
"max_day_cost": 123,
"min_day_cost": 123,
"average_day_cost": 123
}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}{
"code": "common.internal_error",
"error": "<string>",
"meta": {}
}Authorizations
BearerAuthApiKeyAuth
Bearer token in the Authorization header (e.g. JWT / Cognito access token).
Headers
ID of the tenant (current tenant context).
Path Parameters
Environment identifier.
Body
application/json
Response
OK
AWS region identifier. Matches models.AwsRegion JSON values in paas-lib.
Available options:
us-east-1, us-east-2, us-west-1, us-west-2, us-gov-east-1, us-gov-west-1, ca-central-1, ca-west-1, eu-central-1, eu-central-2, eu-north-1, eu-west-1, eu-west-2, eu-west-3, eu-south-1, eu-south-2, me-south-1, me-central-1, mx-central-1, cn-north-1, cn-northwest-1, ap-east-1, ap-south-1, ap-south-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-4, ap-southeast-5, ap-east-2, ap-southeast-7, ap-southeast-6, af-south-1, sa-east-1 Example:
"us-east-1"
Available options:
CLONED, DEFINED, DEPLOY_IN_PROGRESS, DEPLOYED, FAILED, ROLLBACK, REQUIRES_MANUAL_DELETION Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Aggregated cost summary for a billing period.
Show child attributes
Show child attributes