Create

POST /api/v3/gateways

cURL

cURL

curl --request POST \
  --url https://us.infisical.com/api/v3/gateways \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "authMethod": {
    "method": "aws",
    "stsEndpoint": "https://sts.amazonaws.com/",
    "allowedPrincipalArns": "",
    "allowedAccountIds": ""
  }
}
'

import requests

url = "https://us.infisical.com/api/v3/gateways"

payload = {
    "name": "<string>",
    "authMethod": {
        "method": "aws",
        "stsEndpoint": "https://sts.amazonaws.com/",
        "allowedPrincipalArns": "",
        "allowedAccountIds": ""
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    authMethod: {
      method: 'aws',
      stsEndpoint: 'https://sts.amazonaws.com/',
      allowedPrincipalArns: '',
      allowedAccountIds: ''
    }
  })
};

fetch('https://us.infisical.com/api/v3/gateways', 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://us.infisical.com/api/v3/gateways",
  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([
    'name' => '<string>',
    'authMethod' => [
        'method' => 'aws',
        'stsEndpoint' => 'https://sts.amazonaws.com/',
        'allowedPrincipalArns' => '',
        'allowedAccountIds' => ''
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://us.infisical.com/api/v3/gateways"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"authMethod\": {\n    \"method\": \"aws\",\n    \"stsEndpoint\": \"https://sts.amazonaws.com/\",\n    \"allowedPrincipalArns\": \"\",\n    \"allowedAccountIds\": \"\"\n  }\n}")

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

	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.post("https://us.infisical.com/api/v3/gateways")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"authMethod\": {\n    \"method\": \"aws\",\n    \"stsEndpoint\": \"https://sts.amazonaws.com/\",\n    \"allowedPrincipalArns\": \"\",\n    \"allowedAccountIds\": \"\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v3/gateways")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"authMethod\": {\n    \"method\": \"aws\",\n    \"stsEndpoint\": \"https://sts.amazonaws.com/\",\n    \"allowedPrincipalArns\": \"\",\n    \"allowedAccountIds\": \"\"\n  }\n}"

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

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "canRevoke": true,
  "authMethod": {
    "method": "aws",
    "config": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "stsEndpoint": "<string>",
      "allowedPrincipalArns": "<string>",
      "allowedAccountIds": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  },
  "identityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "heartbeat": "2023-11-07T05:31:56Z",
  "heartbeatTTL": 123
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

Body

application/json

name · string · required

Name of the gateway.

Required string length: 1 - 64

authMethod · object · required

Auth method to configure on the gateway. aws carries the AWS allowlists; token is configurationless and requires a separate POST /v3/gateways/:id/token call to mint the bootstrap token.

Option 1

Option 2

Show child attributes

Response

200

application/json

Default Response

id · string<uuid> · required

name · string · required

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

canRevoke · boolean · required

authMethod · object · required

Option 1

Option 2

Option 3

Show child attributes

identityId · string<uuid> | null

heartbeat · string<date-time> | null

heartbeatTTL · number | null