Edit a set of AWS credentials

PUT /organization/{organizationId}/aws/credentials/{credentialsId}

Edit a set of AWS credentials

cURL

curl --request PUT \
  --url https://api.qovery.com/organization/{organizationId}/aws/credentials/{credentialsId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "AWS_ROLE",
  "name": "<string>",
  "role_arn": "<string>"
}
'

import requests

url = "https://api.qovery.com/organization/{organizationId}/aws/credentials/{credentialsId}"

payload = {
    "type": "AWS_ROLE",
    "name": "<string>",
    "role_arn": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({type: 'AWS_ROLE', name: '<string>', role_arn: '<string>'})
};

fetch('https://api.qovery.com/organization/{organizationId}/aws/credentials/{credentialsId}', 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://api.qovery.com/organization/{organizationId}/aws/credentials/{credentialsId}",
  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([
    'type' => 'AWS_ROLE',
    'name' => '<string>',
    'role_arn' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.qovery.com/organization/{organizationId}/aws/credentials/{credentialsId}"

	payload := strings.NewReader("{\n  \"type\": \"AWS_ROLE\",\n  \"name\": \"<string>\",\n  \"role_arn\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	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://api.qovery.com/organization/{organizationId}/aws/credentials/{credentialsId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"AWS_ROLE\",\n  \"name\": \"<string>\",\n  \"role_arn\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/organization/{organizationId}/aws/credentials/{credentialsId}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"AWS_ROLE\",\n  \"name\": \"<string>\",\n  \"role_arn\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "access_key_id": "<string>",
  "object_type": "AWS"
}

Authorizations

bearerAuthApiKeyAuth

Authorization · string · header · required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

organizationId · string<uuid> · required

Organization ID

credentialsId · string<uuid> · required

Credentials ID

Body

application/json

Option 1

Option 2

Option 3

Option 4

type · enum<string> · required

Available options: AWS_ROLE

name · string · required

role_arn · string · required

Response

200

application/json

Edit a set of AWS credentials

AwsStaticClusterCredentials

ScalewayClusterCredentials

GenericClusterCredentials

AwsRoleClusterCredentials

EksAnywhereVsphereClusterCredentials

AzureStaticClusterCredentials

GcpStaticClusterCredentials

GcpWorkloadIdentityFederationClusterCredentials

id · string<uuid> · required

name · string · required

access_key_id · string · required

object_type · enum<string> · required

Available options: AWS