Skip to main content
POST
/
core.v1.IntegrationCloudService
/
UpdateCloudIntegrationV2
cURL
curl -X POST "https://api.joinformal.com/core.v1.IntegrationCloudService/UpdateCloudIntegrationV2" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
fetch("https://api.joinformal.com/core.v1.IntegrationCloudService/UpdateCloudIntegrationV2", {
method: "POST",
headers: {
"X-API-KEY": "YOUR_API_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({
example: "value"
})
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));
import requests

url = "https://api.joinformal.com/core.v1.IntegrationCloudService/UpdateCloudIntegrationV2"
headers = {
"X-API-KEY": "YOUR_API_KEY",
"Content-Type": "application/json"
}
data = {
"example": "value"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
package main

import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
)

func main() {
url := "https://api.joinformal.com/core.v1.IntegrationCloudService/UpdateCloudIntegrationV2"

body := map[string]string{
"example": "value",
}

jsonData, _ := json.Marshal(body)

req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
req.Header.Set("X-API-KEY", "YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()

responseBody, _ := io.ReadAll(resp.Body)
fmt.Println(string(responseBody))
}
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.joinformal.com/core.v1.IntegrationCloudService/UpdateCloudIntegrationV2",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'cloud' => [
'id' => '<string>',
'name' => '<string>',
'active' => true,
'createdAt' => '2023-11-07T05:31:56Z',
'updatedAt' => '2023-11-07T05:31:56Z',
'aws' => [
'url' => '<string>',
'awsFormalId' => '<string>',
'awsAccountId' => '<string>',
'awsFormalIamRole' => '<string>',
'awsFormalHandshakeId' => '<string>',
'templateBody' => '<string>',
'awsFormalUserName' => '<string>',
'awsFormalPingbackArn' => '<string>',
'awsFormalStackName' => '<string>',
'awsCloudRegion' => '<string>',
'awsTemplateVersion' => '<string>',
'awsS3BucketArn' => '<string>',
'awsEnableEksAutodiscovery' => true,
'awsEnableRdsAutodiscovery' => true,
'awsEnableRedshiftAutodiscovery' => true,
'awsAllowS3Access' => true,
'awsEnableEc2Autodiscovery' => true,
'awsEnableEcsAutodiscovery' => true,
'awsCustomerRoleArn' => '<string>',
'awsEnableS3Autodiscovery' => true,
'awsFormalIamRoleArn' => '<string>',
'awsAutodiscoveryRegions' => [
'<string>'
]
],
'gcp' => [
'gcpProjectId' => '<string>',
'gcpServiceAccountEmail' => '<string>',
'gcpWorkloadIdentityPoolProvider' => '<string>',
'awsFormalRoleArn' => '<string>',
'securityKey' => '<string>',
'gcpRoles' => [
'<string>'
],
'gcpAllowGcsAccess' => true,
'gcpGcsBuckets' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
HttpResponse<String> response = Unirest.post("https://api.joinformal.com/core.v1.IntegrationCloudService/UpdateCloudIntegrationV2")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cloud\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"active\": true,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"aws\": {\n \"url\": \"<string>\",\n \"awsFormalId\": \"<string>\",\n \"awsAccountId\": \"<string>\",\n \"awsFormalIamRole\": \"<string>\",\n \"awsFormalHandshakeId\": \"<string>\",\n \"templateBody\": \"<string>\",\n \"awsFormalUserName\": \"<string>\",\n \"awsFormalPingbackArn\": \"<string>\",\n \"awsFormalStackName\": \"<string>\",\n \"awsCloudRegion\": \"<string>\",\n \"awsTemplateVersion\": \"<string>\",\n \"awsS3BucketArn\": \"<string>\",\n \"awsEnableEksAutodiscovery\": true,\n \"awsEnableRdsAutodiscovery\": true,\n \"awsEnableRedshiftAutodiscovery\": true,\n \"awsAllowS3Access\": true,\n \"awsEnableEc2Autodiscovery\": true,\n \"awsEnableEcsAutodiscovery\": true,\n \"awsCustomerRoleArn\": \"<string>\",\n \"awsEnableS3Autodiscovery\": true,\n \"awsFormalIamRoleArn\": \"<string>\",\n \"awsAutodiscoveryRegions\": [\n \"<string>\"\n ]\n },\n \"gcp\": {\n \"gcpProjectId\": \"<string>\",\n \"gcpServiceAccountEmail\": \"<string>\",\n \"gcpWorkloadIdentityPoolProvider\": \"<string>\",\n \"awsFormalRoleArn\": \"<string>\",\n \"securityKey\": \"<string>\",\n \"gcpRoles\": [\n \"<string>\"\n ],\n \"gcpAllowGcsAccess\": true,\n \"gcpGcsBuckets\": [\n \"<string>\"\n ]\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.joinformal.com/core.v1.IntegrationCloudService/UpdateCloudIntegrationV2")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cloud\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"active\": true,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"aws\": {\n \"url\": \"<string>\",\n \"awsFormalId\": \"<string>\",\n \"awsAccountId\": \"<string>\",\n \"awsFormalIamRole\": \"<string>\",\n \"awsFormalHandshakeId\": \"<string>\",\n \"templateBody\": \"<string>\",\n \"awsFormalUserName\": \"<string>\",\n \"awsFormalPingbackArn\": \"<string>\",\n \"awsFormalStackName\": \"<string>\",\n \"awsCloudRegion\": \"<string>\",\n \"awsTemplateVersion\": \"<string>\",\n \"awsS3BucketArn\": \"<string>\",\n \"awsEnableEksAutodiscovery\": true,\n \"awsEnableRdsAutodiscovery\": true,\n \"awsEnableRedshiftAutodiscovery\": true,\n \"awsAllowS3Access\": true,\n \"awsEnableEc2Autodiscovery\": true,\n \"awsEnableEcsAutodiscovery\": true,\n \"awsCustomerRoleArn\": \"<string>\",\n \"awsEnableS3Autodiscovery\": true,\n \"awsFormalIamRoleArn\": \"<string>\",\n \"awsAutodiscoveryRegions\": [\n \"<string>\"\n ]\n },\n \"gcp\": {\n \"gcpProjectId\": \"<string>\",\n \"gcpServiceAccountEmail\": \"<string>\",\n \"gcpWorkloadIdentityPoolProvider\": \"<string>\",\n \"awsFormalRoleArn\": \"<string>\",\n \"securityKey\": \"<string>\",\n \"gcpRoles\": [\n \"<string>\"\n ],\n \"gcpAllowGcsAccess\": true,\n \"gcpGcsBuckets\": [\n \"<string>\"\n ]\n }\n }\n}"

response = http.request(request)
puts response.read_body
{
  "cloud": {
    "id": "<string>",
    "name": "<string>",
    "active": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "aws": {
      "url": "<string>",
      "awsFormalId": "<string>",
      "awsAccountId": "<string>",
      "awsFormalIamRole": "<string>",
      "awsFormalHandshakeId": "<string>",
      "templateBody": "<string>",
      "awsFormalUserName": "<string>",
      "awsFormalPingbackArn": "<string>",
      "awsFormalStackName": "<string>",
      "awsCloudRegion": "<string>",
      "awsTemplateVersion": "<string>",
      "awsS3BucketArn": "<string>",
      "awsEnableEksAutodiscovery": true,
      "awsEnableRdsAutodiscovery": true,
      "awsEnableRedshiftAutodiscovery": true,
      "awsAllowS3Access": true,
      "awsEnableEc2Autodiscovery": true,
      "awsEnableEcsAutodiscovery": true,
      "awsCustomerRoleArn": "<string>",
      "awsEnableS3Autodiscovery": true,
      "awsFormalIamRoleArn": "<string>",
      "awsAutodiscoveryRegions": [
        "<string>"
      ]
    },
    "gcp": {
      "gcpProjectId": "<string>",
      "gcpServiceAccountEmail": "<string>",
      "gcpWorkloadIdentityPoolProvider": "<string>",
      "awsFormalRoleArn": "<string>",
      "securityKey": "<string>",
      "gcpRoles": [
        "<string>"
      ],
      "gcpAllowGcsAccess": true,
      "gcpGcsBuckets": [
        "<string>"
      ]
    }
  }
}
{
"code": "invalid_request",
"message": "Invalid request parameters",
"details": {}
}
{
"code": "unauthorized",
"message": "Authentication required"
}
{
"code": "forbidden",
"message": "Insufficient permissions to perform this action"
}
{
"code": "not_found",
"message": "Resource not found"
}
{
"code": "internal_error",
"message": "An internal error occurred"
}

Authorizations

X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json
cloud
cloud · object
required

Exactly one of these fields is required: aws or gcp.

Response

Success

cloud
cloud · object

Exactly one of these fields is required: aws or gcp.