Update resource

PUT

api

headless

organizations

{organizationId}

resources

{resourceId}

Update resource

curl --request PUT \
  --url https://api.forge.ai/api/headless/v1/organizations/{organizationId}/resources/{resourceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Forge-Confirm: <x-forge-confirm>' \
  --header 'X-Forge-Reason: <x-forge-reason>' \
  --header 'X-Forge-Terraform-Instance: <x-forge-terraform-instance>' \
  --header 'X-Forge-Terraform-Manager: <x-forge-terraform-manager>' \
  --data '
{
  "name": "<string>",
  "upstreamHost": "<string>",
  "upstreamPort": 32768,
  "transparentRouting": true
}
'

import requests

url = "https://api.forge.ai/api/headless/v1/organizations/{organizationId}/resources/{resourceId}"

payload = {
    "name": "<string>",
    "upstreamHost": "<string>",
    "upstreamPort": 32768,
    "transparentRouting": True
}
headers = {
    "X-Forge-Reason": "<x-forge-reason>",
    "Idempotency-Key": "<idempotency-key>",
    "X-Forge-Confirm": "<x-forge-confirm>",
    "X-Forge-Terraform-Manager": "<x-forge-terraform-manager>",
    "X-Forge-Terraform-Instance": "<x-forge-terraform-instance>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'X-Forge-Reason': '<x-forge-reason>',
    'Idempotency-Key': '<idempotency-key>',
    'X-Forge-Confirm': '<x-forge-confirm>',
    'X-Forge-Terraform-Manager': '<x-forge-terraform-manager>',
    'X-Forge-Terraform-Instance': '<x-forge-terraform-instance>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    upstreamHost: '<string>',
    upstreamPort: 32768,
    transparentRouting: true
  })
};

fetch('https://api.forge.ai/api/headless/v1/organizations/{organizationId}/resources/{resourceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.forge.ai/api/headless/v1/organizations/{organizationId}/resources/{resourceId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"upstreamHost\": \"<string>\",\n  \"upstreamPort\": 32768,\n  \"transparentRouting\": true\n}")

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

	req.Header.Add("X-Forge-Reason", "<x-forge-reason>")
	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-Forge-Confirm", "<x-forge-confirm>")
	req.Header.Add("X-Forge-Terraform-Manager", "<x-forge-terraform-manager>")
	req.Header.Add("X-Forge-Terraform-Instance", "<x-forge-terraform-instance>")
	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))

}

{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "protocol": "postgres",
  "upstreamHost": "<string>",
  "upstreamPort": 32768,
  "upstreamTls": true,
  "enabled": true,
  "transparentRouting": true,
  "managementMode": "forge",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "upstreamCaPem": "<string>",
  "gatewayId": "<string>",
  "accessName": "<string>",
  "managerId": "<string>",
  "managerInstance": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Enter a Forge service-account token or delegated OAuth access token. Mintlify adds the Bearer prefix.

Headers

X-Forge-Reason

string

required

Minimum string length: 1

Idempotency-Key

string

required

Minimum string length: 1

X-Forge-Confirm

enum<boolean>

required

Available options:

true

X-Forge-Terraform-Manager

string

required

Minimum string length: 1

X-Forge-Terraform-Instance

string

required

Minimum string length: 1

Path Parameters

organizationId

string

required

resourceId

string

required

Body

application/json

name

string

required

Required string length: 1 - 128

protocol

enum<string>

required

Available options:

postgres,

mysql,

redis,

http

upstreamHost

string

required

Required string length: 3 - 253

upstreamPort

integer

required

Required range: 1 <= x <= 65535

transparentRouting

boolean

required

upstreamTls

boolean

default:true

upstreamCaPem

string

Optional public CA certificate PEM used to verify this Resource instead of system trust roots.

Maximum string length: 65536

enabled

boolean

default:true

gatewayId

string

Response

Resource updated under the owning automation manager.

string

required

organizationId

string

required

name

string

required

protocol

enum<string>

required

Available options:

postgres,

mysql,

redis,

http

upstreamHost

string

required

upstreamPort

integer

required

Required range: 1 <= x <= 65535

upstreamTls

boolean

required

enabled

boolean

required

transparentRouting

boolean

required

managementMode

enum<string>

required

Available options:

forge,

terraform

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

upstreamCaPem

string

Maximum string length: 65536

gatewayId

string

accessName

string

read-only

Required string length: 1 - 63

managerId

string

managerInstance

string

Update resource

curl --request PUT \
  --url https://api.forge.ai/api/headless/v1/organizations/{organizationId}/resources/{resourceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Forge-Confirm: <x-forge-confirm>' \
  --header 'X-Forge-Reason: <x-forge-reason>' \
  --header 'X-Forge-Terraform-Instance: <x-forge-terraform-instance>' \
  --header 'X-Forge-Terraform-Manager: <x-forge-terraform-manager>' \
  --data '
{
  "name": "<string>",
  "upstreamHost": "<string>",
  "upstreamPort": 32768,
  "transparentRouting": true
}
'

import requests

url = "https://api.forge.ai/api/headless/v1/organizations/{organizationId}/resources/{resourceId}"

payload = {
    "name": "<string>",
    "upstreamHost": "<string>",
    "upstreamPort": 32768,
    "transparentRouting": True
}
headers = {
    "X-Forge-Reason": "<x-forge-reason>",
    "Idempotency-Key": "<idempotency-key>",
    "X-Forge-Confirm": "<x-forge-confirm>",
    "X-Forge-Terraform-Manager": "<x-forge-terraform-manager>",
    "X-Forge-Terraform-Instance": "<x-forge-terraform-instance>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'X-Forge-Reason': '<x-forge-reason>',
    'Idempotency-Key': '<idempotency-key>',
    'X-Forge-Confirm': '<x-forge-confirm>',
    'X-Forge-Terraform-Manager': '<x-forge-terraform-manager>',
    'X-Forge-Terraform-Instance': '<x-forge-terraform-instance>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    upstreamHost: '<string>',
    upstreamPort: 32768,
    transparentRouting: true
  })
};

fetch('https://api.forge.ai/api/headless/v1/organizations/{organizationId}/resources/{resourceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.forge.ai/api/headless/v1/organizations/{organizationId}/resources/{resourceId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"upstreamHost\": \"<string>\",\n  \"upstreamPort\": 32768,\n  \"transparentRouting\": true\n}")

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

	req.Header.Add("X-Forge-Reason", "<x-forge-reason>")
	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-Forge-Confirm", "<x-forge-confirm>")
	req.Header.Add("X-Forge-Terraform-Manager", "<x-forge-terraform-manager>")
	req.Header.Add("X-Forge-Terraform-Instance", "<x-forge-terraform-instance>")
	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))

}

{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "protocol": "postgres",
  "upstreamHost": "<string>",
  "upstreamPort": 32768,
  "upstreamTls": true,
  "enabled": true,
  "transparentRouting": true,
  "managementMode": "forge",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "upstreamCaPem": "<string>",
  "gatewayId": "<string>",
  "accessName": "<string>",
  "managerId": "<string>",
  "managerInstance": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Guides

REST API

Update resource

Authorizations

Headers

Path Parameters

Body

Response