Patch Connection

Patch Connection

curl --request PATCH \
  --url https://use.hoop.dev/api/connections/{nameOrID} \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "1837453e-01fc-46f3-9e4c-dcf22d395393",
  "attributes": [
    "production",
    "pii"
  ],
  "command": [
    "/bin/bash"
  ],
  "connection_tags": {
    "environment": "prod",
    "tier": "frontend"
  },
  "guardrail_rules": [
    "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
    "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD"
  ],
  "jira_issue_template_id": "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD",
  "mandatory_metadata_fields": [
    "environment",
    "tier"
  ],
  "mcp_oauth_flow_id": "7c8a1234-5678-9abc-def0-123456789abc",
  "redact_types": [
    "EMAIL_ADDRESS"
  ],
  "reviewers": [
    "dba-group"
  ],
  "secret": {},
  "subtype": "postgres",
  "tags": [
    "prod"
  ],
  "type": "database"
}
'

import requests

url = "https://use.hoop.dev/api/connections/{nameOrID}"

payload = {
    "agent_id": "1837453e-01fc-46f3-9e4c-dcf22d395393",
    "attributes": ["production", "pii"],
    "command": ["/bin/bash"],
    "connection_tags": {
        "environment": "prod",
        "tier": "frontend"
    },
    "guardrail_rules": ["5701046A-7B7A-4A78-ABB0-A24C95E6FE54", "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD"],
    "jira_issue_template_id": "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD",
    "mandatory_metadata_fields": ["environment", "tier"],
    "mcp_oauth_flow_id": "7c8a1234-5678-9abc-def0-123456789abc",
    "redact_types": ["EMAIL_ADDRESS"],
    "reviewers": ["dba-group"],
    "secret": {},
    "subtype": "postgres",
    "tags": ["prod"],
    "type": "database"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_id: '1837453e-01fc-46f3-9e4c-dcf22d395393',
    attributes: ['production', 'pii'],
    command: ['/bin/bash'],
    connection_tags: {environment: 'prod', tier: 'frontend'},
    guardrail_rules: ['5701046A-7B7A-4A78-ABB0-A24C95E6FE54', 'B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD'],
    jira_issue_template_id: 'B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD',
    mandatory_metadata_fields: ['environment', 'tier'],
    mcp_oauth_flow_id: '7c8a1234-5678-9abc-def0-123456789abc',
    redact_types: ['EMAIL_ADDRESS'],
    reviewers: ['dba-group'],
    secret: {},
    subtype: 'postgres',
    tags: ['prod'],
    type: 'database'
  })
};

fetch('https://use.hoop.dev/api/connections/{nameOrID}', 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://use.hoop.dev/api/connections/{nameOrID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'agent_id' => '1837453e-01fc-46f3-9e4c-dcf22d395393',
    'attributes' => [
        'production',
        'pii'
    ],
    'command' => [
        '/bin/bash'
    ],
    'connection_tags' => [
        'environment' => 'prod',
        'tier' => 'frontend'
    ],
    'guardrail_rules' => [
        '5701046A-7B7A-4A78-ABB0-A24C95E6FE54',
        'B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD'
    ],
    'jira_issue_template_id' => 'B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD',
    'mandatory_metadata_fields' => [
        'environment',
        'tier'
    ],
    'mcp_oauth_flow_id' => '7c8a1234-5678-9abc-def0-123456789abc',
    'redact_types' => [
        'EMAIL_ADDRESS'
    ],
    'reviewers' => [
        'dba-group'
    ],
    'secret' => [
        
    ],
    'subtype' => 'postgres',
    'tags' => [
        'prod'
    ],
    'type' => 'database'
  ]),
  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://use.hoop.dev/api/connections/{nameOrID}"

	payload := strings.NewReader("{\n  \"agent_id\": \"1837453e-01fc-46f3-9e4c-dcf22d395393\",\n  \"attributes\": [\n    \"production\",\n    \"pii\"\n  ],\n  \"command\": [\n    \"/bin/bash\"\n  ],\n  \"connection_tags\": {\n    \"environment\": \"prod\",\n    \"tier\": \"frontend\"\n  },\n  \"guardrail_rules\": [\n    \"5701046A-7B7A-4A78-ABB0-A24C95E6FE54\",\n    \"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD\"\n  ],\n  \"jira_issue_template_id\": \"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD\",\n  \"mandatory_metadata_fields\": [\n    \"environment\",\n    \"tier\"\n  ],\n  \"mcp_oauth_flow_id\": \"7c8a1234-5678-9abc-def0-123456789abc\",\n  \"redact_types\": [\n    \"EMAIL_ADDRESS\"\n  ],\n  \"reviewers\": [\n    \"dba-group\"\n  ],\n  \"secret\": {},\n  \"subtype\": \"postgres\",\n  \"tags\": [\n    \"prod\"\n  ],\n  \"type\": \"database\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://use.hoop.dev/api/connections/{nameOrID}")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"1837453e-01fc-46f3-9e4c-dcf22d395393\",\n  \"attributes\": [\n    \"production\",\n    \"pii\"\n  ],\n  \"command\": [\n    \"/bin/bash\"\n  ],\n  \"connection_tags\": {\n    \"environment\": \"prod\",\n    \"tier\": \"frontend\"\n  },\n  \"guardrail_rules\": [\n    \"5701046A-7B7A-4A78-ABB0-A24C95E6FE54\",\n    \"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD\"\n  ],\n  \"jira_issue_template_id\": \"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD\",\n  \"mandatory_metadata_fields\": [\n    \"environment\",\n    \"tier\"\n  ],\n  \"mcp_oauth_flow_id\": \"7c8a1234-5678-9abc-def0-123456789abc\",\n  \"redact_types\": [\n    \"EMAIL_ADDRESS\"\n  ],\n  \"reviewers\": [\n    \"dba-group\"\n  ],\n  \"secret\": {},\n  \"subtype\": \"postgres\",\n  \"tags\": [\n    \"prod\"\n  ],\n  \"type\": \"database\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://use.hoop.dev/api/connections/{nameOrID}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_id\": \"1837453e-01fc-46f3-9e4c-dcf22d395393\",\n  \"attributes\": [\n    \"production\",\n    \"pii\"\n  ],\n  \"command\": [\n    \"/bin/bash\"\n  ],\n  \"connection_tags\": {\n    \"environment\": \"prod\",\n    \"tier\": \"frontend\"\n  },\n  \"guardrail_rules\": [\n    \"5701046A-7B7A-4A78-ABB0-A24C95E6FE54\",\n    \"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD\"\n  ],\n  \"jira_issue_template_id\": \"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD\",\n  \"mandatory_metadata_fields\": [\n    \"environment\",\n    \"tier\"\n  ],\n  \"mcp_oauth_flow_id\": \"7c8a1234-5678-9abc-def0-123456789abc\",\n  \"redact_types\": [\n    \"EMAIL_ADDRESS\"\n  ],\n  \"reviewers\": [\n    \"dba-group\"\n  ],\n  \"secret\": {},\n  \"subtype\": \"postgres\",\n  \"tags\": [\n    \"prod\"\n  ],\n  \"type\": \"database\"\n}"

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

{
  "agent_id": "1837453e-01fc-46f3-9e4c-dcf22d395393",
  "name": "pgdemo",
  "type": "database",
  "access_max_duration": 3600,
  "attributes": [
    "production",
    "pii"
  ],
  "command": [
    "/bin/bash"
  ],
  "connection_tags": {
    "environment": "prod",
    "tier": "frontend"
  },
  "default_database": "<string>",
  "effective_features": {
    "access_request": {
      "command": true,
      "jit": false,
      "legacy_reviewers": false
    },
    "ai_session_analyzer": false,
    "data_masking": true,
    "guardrails": true,
    "jira_templates": false,
    "mandatory_metadata": false
  },
  "force_approve_groups": [
    "sre-team"
  ],
  "guardrail_rules": [
    "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
    "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD"
  ],
  "id": "5364ec99-653b-41ba-8165-67236e894990",
  "jira_issue_template_id": "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD",
  "jit_access_duration_sec": 1800,
  "managed_attributes": [
    "hoop_protection_profile-soc2_type2"
  ],
  "managed_by": "",
  "mandatory_metadata_fields": [
    "environment",
    "tier"
  ],
  "mcp_oauth_flow_id": "7c8a1234-5678-9abc-def0-123456789abc",
  "mcp_oauth_granted": true,
  "mcp_oauth_warning": "the oauth login authorized https://a.example/mcp but the connection points at https://b.example/mcp",
  "min_review_approvals": 2,
  "redact_enabled": true,
  "redact_types": [
    "EMAIL_ADDRESS"
  ],
  "resource_name": "pgdemo",
  "reviewers": [
    "dba-group"
  ],
  "secret": {},
  "secrets_updated_at": "2025-01-15T10:30:00Z",
  "subtype": "postgres",
  "tags": [
    "prod"
  ]
}

{
  "message": "the error description"
}

{
  "message": "the error description"
}

{
  "message": "the error description"
}

{
  "message": "the error description"
}

PATCH

connections

{nameOrID}

Patch Connection

curl --request PATCH \
  --url https://use.hoop.dev/api/connections/{nameOrID} \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "1837453e-01fc-46f3-9e4c-dcf22d395393",
  "attributes": [
    "production",
    "pii"
  ],
  "command": [
    "/bin/bash"
  ],
  "connection_tags": {
    "environment": "prod",
    "tier": "frontend"
  },
  "guardrail_rules": [
    "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
    "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD"
  ],
  "jira_issue_template_id": "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD",
  "mandatory_metadata_fields": [
    "environment",
    "tier"
  ],
  "mcp_oauth_flow_id": "7c8a1234-5678-9abc-def0-123456789abc",
  "redact_types": [
    "EMAIL_ADDRESS"
  ],
  "reviewers": [
    "dba-group"
  ],
  "secret": {},
  "subtype": "postgres",
  "tags": [
    "prod"
  ],
  "type": "database"
}
'

import requests

url = "https://use.hoop.dev/api/connections/{nameOrID}"

payload = {
    "agent_id": "1837453e-01fc-46f3-9e4c-dcf22d395393",
    "attributes": ["production", "pii"],
    "command": ["/bin/bash"],
    "connection_tags": {
        "environment": "prod",
        "tier": "frontend"
    },
    "guardrail_rules": ["5701046A-7B7A-4A78-ABB0-A24C95E6FE54", "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD"],
    "jira_issue_template_id": "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD",
    "mandatory_metadata_fields": ["environment", "tier"],
    "mcp_oauth_flow_id": "7c8a1234-5678-9abc-def0-123456789abc",
    "redact_types": ["EMAIL_ADDRESS"],
    "reviewers": ["dba-group"],
    "secret": {},
    "subtype": "postgres",
    "tags": ["prod"],
    "type": "database"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_id: '1837453e-01fc-46f3-9e4c-dcf22d395393',
    attributes: ['production', 'pii'],
    command: ['/bin/bash'],
    connection_tags: {environment: 'prod', tier: 'frontend'},
    guardrail_rules: ['5701046A-7B7A-4A78-ABB0-A24C95E6FE54', 'B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD'],
    jira_issue_template_id: 'B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD',
    mandatory_metadata_fields: ['environment', 'tier'],
    mcp_oauth_flow_id: '7c8a1234-5678-9abc-def0-123456789abc',
    redact_types: ['EMAIL_ADDRESS'],
    reviewers: ['dba-group'],
    secret: {},
    subtype: 'postgres',
    tags: ['prod'],
    type: 'database'
  })
};

fetch('https://use.hoop.dev/api/connections/{nameOrID}', 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://use.hoop.dev/api/connections/{nameOrID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'agent_id' => '1837453e-01fc-46f3-9e4c-dcf22d395393',
    'attributes' => [
        'production',
        'pii'
    ],
    'command' => [
        '/bin/bash'
    ],
    'connection_tags' => [
        'environment' => 'prod',
        'tier' => 'frontend'
    ],
    'guardrail_rules' => [
        '5701046A-7B7A-4A78-ABB0-A24C95E6FE54',
        'B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD'
    ],
    'jira_issue_template_id' => 'B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD',
    'mandatory_metadata_fields' => [
        'environment',
        'tier'
    ],
    'mcp_oauth_flow_id' => '7c8a1234-5678-9abc-def0-123456789abc',
    'redact_types' => [
        'EMAIL_ADDRESS'
    ],
    'reviewers' => [
        'dba-group'
    ],
    'secret' => [
        
    ],
    'subtype' => 'postgres',
    'tags' => [
        'prod'
    ],
    'type' => 'database'
  ]),
  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://use.hoop.dev/api/connections/{nameOrID}"

	payload := strings.NewReader("{\n  \"agent_id\": \"1837453e-01fc-46f3-9e4c-dcf22d395393\",\n  \"attributes\": [\n    \"production\",\n    \"pii\"\n  ],\n  \"command\": [\n    \"/bin/bash\"\n  ],\n  \"connection_tags\": {\n    \"environment\": \"prod\",\n    \"tier\": \"frontend\"\n  },\n  \"guardrail_rules\": [\n    \"5701046A-7B7A-4A78-ABB0-A24C95E6FE54\",\n    \"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD\"\n  ],\n  \"jira_issue_template_id\": \"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD\",\n  \"mandatory_metadata_fields\": [\n    \"environment\",\n    \"tier\"\n  ],\n  \"mcp_oauth_flow_id\": \"7c8a1234-5678-9abc-def0-123456789abc\",\n  \"redact_types\": [\n    \"EMAIL_ADDRESS\"\n  ],\n  \"reviewers\": [\n    \"dba-group\"\n  ],\n  \"secret\": {},\n  \"subtype\": \"postgres\",\n  \"tags\": [\n    \"prod\"\n  ],\n  \"type\": \"database\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://use.hoop.dev/api/connections/{nameOrID}")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"1837453e-01fc-46f3-9e4c-dcf22d395393\",\n  \"attributes\": [\n    \"production\",\n    \"pii\"\n  ],\n  \"command\": [\n    \"/bin/bash\"\n  ],\n  \"connection_tags\": {\n    \"environment\": \"prod\",\n    \"tier\": \"frontend\"\n  },\n  \"guardrail_rules\": [\n    \"5701046A-7B7A-4A78-ABB0-A24C95E6FE54\",\n    \"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD\"\n  ],\n  \"jira_issue_template_id\": \"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD\",\n  \"mandatory_metadata_fields\": [\n    \"environment\",\n    \"tier\"\n  ],\n  \"mcp_oauth_flow_id\": \"7c8a1234-5678-9abc-def0-123456789abc\",\n  \"redact_types\": [\n    \"EMAIL_ADDRESS\"\n  ],\n  \"reviewers\": [\n    \"dba-group\"\n  ],\n  \"secret\": {},\n  \"subtype\": \"postgres\",\n  \"tags\": [\n    \"prod\"\n  ],\n  \"type\": \"database\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://use.hoop.dev/api/connections/{nameOrID}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_id\": \"1837453e-01fc-46f3-9e4c-dcf22d395393\",\n  \"attributes\": [\n    \"production\",\n    \"pii\"\n  ],\n  \"command\": [\n    \"/bin/bash\"\n  ],\n  \"connection_tags\": {\n    \"environment\": \"prod\",\n    \"tier\": \"frontend\"\n  },\n  \"guardrail_rules\": [\n    \"5701046A-7B7A-4A78-ABB0-A24C95E6FE54\",\n    \"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD\"\n  ],\n  \"jira_issue_template_id\": \"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD\",\n  \"mandatory_metadata_fields\": [\n    \"environment\",\n    \"tier\"\n  ],\n  \"mcp_oauth_flow_id\": \"7c8a1234-5678-9abc-def0-123456789abc\",\n  \"redact_types\": [\n    \"EMAIL_ADDRESS\"\n  ],\n  \"reviewers\": [\n    \"dba-group\"\n  ],\n  \"secret\": {},\n  \"subtype\": \"postgres\",\n  \"tags\": [\n    \"prod\"\n  ],\n  \"type\": \"database\"\n}"

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

{
  "agent_id": "1837453e-01fc-46f3-9e4c-dcf22d395393",
  "name": "pgdemo",
  "type": "database",
  "access_max_duration": 3600,
  "attributes": [
    "production",
    "pii"
  ],
  "command": [
    "/bin/bash"
  ],
  "connection_tags": {
    "environment": "prod",
    "tier": "frontend"
  },
  "default_database": "<string>",
  "effective_features": {
    "access_request": {
      "command": true,
      "jit": false,
      "legacy_reviewers": false
    },
    "ai_session_analyzer": false,
    "data_masking": true,
    "guardrails": true,
    "jira_templates": false,
    "mandatory_metadata": false
  },
  "force_approve_groups": [
    "sre-team"
  ],
  "guardrail_rules": [
    "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
    "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD"
  ],
  "id": "5364ec99-653b-41ba-8165-67236e894990",
  "jira_issue_template_id": "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD",
  "jit_access_duration_sec": 1800,
  "managed_attributes": [
    "hoop_protection_profile-soc2_type2"
  ],
  "managed_by": "",
  "mandatory_metadata_fields": [
    "environment",
    "tier"
  ],
  "mcp_oauth_flow_id": "7c8a1234-5678-9abc-def0-123456789abc",
  "mcp_oauth_granted": true,
  "mcp_oauth_warning": "the oauth login authorized https://a.example/mcp but the connection points at https://b.example/mcp",
  "min_review_approvals": 2,
  "redact_enabled": true,
  "redact_types": [
    "EMAIL_ADDRESS"
  ],
  "resource_name": "pgdemo",
  "reviewers": [
    "dba-group"
  ],
  "secret": {},
  "secrets_updated_at": "2025-01-15T10:30:00Z",
  "subtype": "postgres",
  "tags": [
    "prod"
  ]
}

{
  "message": "the error description"
}

{
  "message": "the error description"
}

{
  "message": "the error description"
}

{
  "message": "the error description"
}

Path Parameters

nameOrID

string

required

The name or ID of the resource

Body

application/json

The request body resource with fields to update

access_mode_connect

enum<string>

Toggle Port Forwarding

enabled - Enable to perform port forwarding for this connection
disabled - Disable port forwarding for this connection

Available options:

enabled,

disabled

access_mode_exec

enum<string>

Toggle Ad Hoc Executions

enabled - Enable to run ad-hoc executions for this connection
disabled - Disable ad-hoc executions for this connection

Available options:

enabled,

disabled

access_mode_runbooks

enum<string>

Toggle Ad Hoc Runbooks Executions

enabled - Enable to run runbooks for this connection
disabled - Disable runbooks execution for this connection

Available options:

enabled,

disabled

access_schema

enum<string>

Toggle Introspection Schema

enabled - Enable the instrospection schema in the webapp
disabled - Disable the instrospection schema in the webapp

Available options:

enabled,

disabled

agent_id

string<uuid>

The agent associated with this connection

Example:

"1837453e-01fc-46f3-9e4c-dcf22d395393"

attributes

string[]

Attributes associated with this connection

Example:

["production", "pii"]

command

string[]

Is the shell command that is going to be executed when interacting with this connection. This value is required if the connection is going to be used from the Webapp.

Example:

["/bin/bash"]

connection_tags

object

Tags to identify the connection

keys must contain between 1 and 64 alphanumeric characters, it may include (-), (_), (/), or (.) characters and it must not end with (-), (/) or (-).
values must contain between 1 and 256 alphanumeric characters, it may include space, (-), (_), (/), (+), (@), (:), (=) or (.) characters.

Show child attributes

Example:

{ "environment": "prod", "tier": "frontend" }

guardrail_rules

string[]

The guard rail association id rules

Example:

[
  "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
  "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD"
]

jira_issue_template_id

string

The jira issue templates ids associated to the connection

Example:

"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD"

mandatory_metadata_fields

string[]

MandatoryMetadataFields are fields that must be present in the metadata for this connection for every session.

Example:

["environment", "tier"]

mcp_oauth_flow_id

string

MCPOAuthFlowID adopts a completed MCP OAuth login into a durable grant for this connection. Write-only, and only meaningful for the "mcpproxy" subtype. See Connection.MCPOAuthFlowID for the full rationale.

PATCH needs it for the same reason POST and PUT do, and more urgently: re-authorizing an EXISTING connection is the only way to replace a credential the provider has expired, and the edit screen speaks PATCH. Without this the browser could obtain a fresh token but never hand over the flow that owns its refresh token, so every re-authorization would freeze another token destined to expire exactly like the last one.

Example:

"7c8a1234-5678-9abc-def0-123456789abc"

redact_types

string[]

Redact Types is a list of info types that will used to redact the output of the connection. Possible values are described in the DLP documentation: https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference

Example:

["EMAIL_ADDRESS"]

reviewers

string[]

Reviewers is a list of groups that will review the connection before the user could execute it

Example:

["dba-group"]

secret

object

Secrets are environment variables that are going to be exposed in the runtime of the connection:

{ envvar:[env-key]: [base64-val] } - Expose the value as environment variable
{ filesystem:[env-key]: [base64-val] } - Expose the value as a temporary file path creating the value in the filesystem

The value could also represent an integration with a external provider:

{ envvar:[env-key]: _aws:[secret-name]:[secret-key] } - Obtain the value dynamically in the AWS secrets manager and expose as environment variable
{ envvar:[env-key]: _envjson:[json-env-name]:[json-env-key] } - Obtain the value dynamically from a JSON env in the agent runtime. Example: MYENV={"KEY": "val"}

Show child attributes

subtype

string

Sub Type is the underline implementation of the connection:

postgres - Implements Postgres protocol
mysql - Implements MySQL protocol
mongodb - Implements MongoDB Wire Protocol
mssql - Implements Microsoft SQL Server Protocol
oracledb - Implements Oracle Database Protocol
tcp - Forwards a TCP connection
ssh - Forwards a SSH connection
httpproxy - Forwards a HTTP connection
dynamodb - AWS DynamoDB experimental integration
cloudwatch - AWS CloudWatch experimental integration

Example:

"postgres"

Response

access_mode_connect

enum<string>

required

Toggle Port Forwarding

enabled - Enable to perform port forwarding for this connection
disabled - Disable port forwarding for this connection

Available options:

enabled,

disabled

access_mode_exec

enum<string>

required

Toggle Ad Hoc Executions

enabled - Enable to run ad-hoc executions for this connection
disabled - Disable ad-hoc executions for this connection

Available options:

enabled,

disabled

access_mode_runbooks

enum<string>

required

Toggle Ad Hoc Runbooks Executions

enabled - Enable to run runbooks for this connection
disabled - Disable runbooks execution for this connection

Available options:

enabled,

disabled

access_schema

enum<string>

required

Toggle Introspection Schema

enabled - Enable the instrospection schema in the webapp
disabled - Disable the instrospection schema in the webapp

Available options:

enabled,

disabled

agent_id

string<uuid>

required

The agent associated with this connection

Example:

"1837453e-01fc-46f3-9e4c-dcf22d395393"

name

string

required

Name of the connection. This attribute is immutable when updating it

Example:

"pgdemo"

type

enum<string>

required

Type represents the main type of the connection:

database - Database protocols
application - Custom applications
custom - Shell applications

Available options:

database,

application,

custom

Example:

"database"

access_max_duration

integer

Maximum duration in seconds for JIT access sessions on this connection

Example:

3600

attributes

string[]

Attributes associated with this connection. Includes Hoop-managed attributes (e.g. the active protection profile attribute); omitting a managed name on update detaches the connection from it.

Example:

["production", "pii"]

command

string[]

Is the shell command that is going to be executed when interacting with this connection. This value is required if the connection is going to be used from the Webapp.

Example:

["/bin/bash"]

connection_tags

object

Tags to identify the connection

keys must contain between 1 and 64 alphanumeric characters, it may include (-), (_), (/), or (.) characters and it must not end with (-), (/) or (-).
values must contain between 1 and 256 alphanumeric characters, it may include space, (-), (_), (/), (+), (@), (:), (=) or (.) characters.

Show child attributes

Example:

{ "environment": "prod", "tier": "frontend" }

default_database

string

Default databases returns the configured value of the attribute secrets->'DB'

effective_features

object

EffectiveFeatures reports which features will actually act on this connection, resolving attribute-based associations as well as direct ones.

Null means "unknown", never "nothing is active" — the two must not be confused by a caller deciding whether to warn a user. It is null on the list endpoint, which does not resolve it, and on the detail endpoint when resolution failed (the gateway logs the failure).

Deliberately not omitempty: an absent key and an explicit null are different contracts, and the one documented here is null.

Show child attributes

force_approve_groups

string[]

Groups that can force approve reviews for this connection

Example:

["sre-team"]

guardrail_rules

string[]

The guard rail association id rules

Example:

[
  "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
  "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD"
]

string<uuid>

read-only

Unique ID of the resource

Example:

"5364ec99-653b-41ba-8165-67236e894990"

jira_issue_template_id

string

The jira issue templates ids associated to the connection

Example:

"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD"

jit_access_duration_sec

integer

JitAccessDurationSec is the fixed access duration in seconds enforced by a JIT access request rule. When set, the user cannot choose a custom duration and must request access for this exact window.

Example:

1800

managed_attributes

string[]

read-only

Hoop-managed attributes associated with this connection (e.g. the active protection profile attribute). Computed on reads; manage the association through the attributes field.

Example:

["hoop_protection_profile-soc2_type2"]

managed_by

string

read-only

Managed By is a read only field that indicates who is managing this resource. When this attribute is set, this resource is considered immutable

Example:

""

mandatory_metadata_fields

string[]

MandatoryMetadataFields are fields that must be present in the metadata for this connection for every session.

Example:

["environment", "tier"]

mcp_oauth_flow_id

string

MCPOAuthFlowID adopts a completed MCP OAuth login into a durable grant for this connection. Write-only, and only meaningful for the "mcpproxy" subtype.

The login runs before the connection exists, so the token it obtained is keyed by the flow rather than by connection. Passing the flow id here at save time joins the two: the gateway stores the refresh token against this connection and renews the access token at every session open, instead of relying on the frozen HEADER_AUTHORIZATION value alone, which stops working when the provider's token expires.

Write-only is enforced by ToOpenApi, which never populates this field — not by a struct tag. swag reads readonly and has no writeonly counterpart (field_parser.go only consults readOnlyTag), so the tag that used to sit here was inert and the published spec advertised the field as readable. The omitempty keeps it out of every response body.

Example:

"7c8a1234-5678-9abc-def0-123456789abc"

mcp_oauth_granted

boolean

read-only

MCPOAuthGranted reports that a durable MCP OAuth grant exists for this connection, so its credential is renewed from a refresh token at every session open rather than frozen at the value it was authorized with.

The edit screen cannot infer this from the env vars. A brokered OAuth login and a pasted token both end up as one HEADER_AUTHORIZATION, and MCP_AUTH collapses "oauth" to "static" because that is all the agent needs to know (see services.MCPOAuthGrantSubType). Without this field the form has to guess which mode the admin chose, guesses "static", and an OAuth connection reopens offering to replace a token it should be offering to re-authorize.

Presence only — no token, no expiry, nothing the grant holds.

Example:

true

mcp_oauth_warning

string

read-only

MCPOAuthWarning reports that the connection was saved but the MCP OAuth login named by mcp_oauth_flow_id was not attached to it. Present only on the create/update response that produced it.

The save succeeded and the connection still works on its frozen HEADER_AUTHORIZATION, so this is not an error status. What it is not is silent: without a grant the credential is never renewed, the connection stops working the moment the provider expires that token, and the admin needs to hear it at save time rather than from a failing session days later.

Example:

"the oauth login authorized https://a.example/mcp but the connection points at https://b.example/mcp"

min_review_approvals

integer

Minimum number of review approvals required to execute this connection

Example:

2

redact_enabled

boolean

When this option is enabled it will allow managing the redact types through the attribute redact_types

redact_types

string[]

Example:

["EMAIL_ADDRESS"]

resource_name

string

Resource to which this connection belongs to, it'll be created if it doesn't exist

Example:

"pgdemo"

reviewers

string[]

Reviewers is a list of groups that will review the connection before the user could execute it

Example:

["dba-group"]

secret

object

Secrets are environment variables that are going to be exposed in the runtime of the connection:

{ envvar:[env-key]: [base64-val] } - Expose the value as environment variable
{ filesystem:[env-key]: [base64-val] } - Expose the value as a temporary file path creating the value in the filesystem

The value could also represent an integration with a external provider:

{ envvar:[env-key]: _aws:[secret-name]:[secret-key] } - Obtain the value dynamically in the AWS secrets manager and expose as environment variable
{ envvar:[env-key]: _envjson:[json-env-name]:[json-env-key] } - Obtain the value dynamically from a JSON env in the agent runtime. Example: MYENV={"KEY": "val"}

Show child attributes

secrets_updated_at

string

read-only

SecretsUpdatedAt is the timestamp of the last replacement of any inline secret value for this connection. Null when no inline secret has been modified since the write-only secrets feature was introduced. References to external providers (AWS Secrets Manager, Vault, IAM RDS) do not affect this field.

Example:

"2025-01-15T10:30:00Z"

status

enum<string>

read-only

Status is a read only field that informs if the connection is available for interaction

online - The agent is connected and alive
offline - The agent is not connected

Available options:

online,

offline

subtype

string

Sub Type is the underline implementation of the connection:

postgres - Implements Postgres protocol
mysql - Implements MySQL protocol
mongodb - Implements MongoDB Wire Protocol
mssql - Implements Microsoft SQL Server Protocol
oracledb - Implements Oracle Database Protocol
tcp - Forwards a TCP connection
ssh - Forwards a SSH connection
httpproxy - Forwards a HTTP connection
dynamodb - AWS DynamoDB experimental integration
cloudwatch - AWS CloudWatch experimental integration

Example:

"postgres"

Server Management

Access Request Rules

Agents

AI Agents

AI

API Keys

Attributes

Audit Logs

Authentication

Connections

Federation

Data Masking Rules

AWS

Feature Flags

Features

Guard Rails

Jira

Machine Identities

Session Metrics

User Management

Organization Management

Plugins

Runbooks

Proxy Manager

Reports

Resources

Reviews

Rulepacks

Search

Server Logs

Sessions

SPIFFE

Path Parameters

Body

Response