Skip to main content
PATCH
/
connections
/
{nameOrID}
Patch Connection
curl --request PATCH \
  --url https://use.hoop.dev/api/connections/{nameOrID} \
  --header 'Content-Type: application/json' \
  --data '{
  "access_mode_connect": "enabled",
  "access_mode_exec": "enabled",
  "access_mode_runbooks": "enabled",
  "access_schema": "enabled",
  "agent_id": "1837453e-01fc-46f3-9e4c-dcf22d395393",
  "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",
  "redact_types": [
    "EMAIL_ADDRESS"
  ],
  "resource_name": "pgdemo",
  "reviewers": [
    "dba-group"
  ],
  "secret": {},
  "subtype": "postgres",
  "tags": [
    "prod"
  ],
  "type": "database"
}'
{
  "access_mode_connect": "enabled",
  "access_mode_exec": "enabled",
  "access_mode_runbooks": "enabled",
  "access_schema": "enabled",
  "agent_id": "1837453e-01fc-46f3-9e4c-dcf22d395393",
  "command": [
    "/bin/bash"
  ],
  "connection_tags": {
    "environment": "prod",
    "tier": "frontend"
  },
  "default_database": "<string>",
  "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",
  "managed_by": "",
  "name": "pgdemo",
  "redact_enabled": true,
  "redact_types": [
    "EMAIL_ADDRESS"
  ],
  "resource_name": "pgdemo",
  "reviewers": [
    "dba-group"
  ],
  "secret": {},
  "status": "online",
  "subtype": "postgres",
  "tags": [
    "prod"
  ],
  "type": "database"
}

Path Parameters

​
nameOrID
string
required

Body

application/json
​
access_mode_connect
enum<string>
Available options:
enabled,
disabled
​
access_mode_exec
enum<string>
Available options:
enabled,
disabled
​
access_mode_runbooks
enum<string>
Available options:
enabled,
disabled
​
access_schema
enum<string>
Available options:
enabled,
disabled
​
agent_id
string<uuid>
Example:
​
command
string[]
Example:
​
connection_tags
object
Example:
​
guardrail_rules
string[]
Example:
​
jira_issue_template_id
string
Example:
​
redact_types
string[]
Example:
​
resource_name
string
Example:
​
reviewers
string[]
Example:
​
secret
object
​
subtype
string
Example:
​
tags
string[]
Example:
​
type
enum<string>
Available options:
database,
application,
custom
Example:

Response

​
access_mode_connect
enum<string>
required
Available options:
enabled,
disabled
​
access_mode_exec
enum<string>
required
Available options:
enabled,
disabled
​
access_mode_runbooks
enum<string>
required
Available options:
enabled,
disabled
​
access_schema
enum<string>
required
Available options:
enabled,
disabled
​
agent_id
string<uuid>
required
Example:
​
name
string
required
Example:
​
type
enum<string>
required
Available options:
database,
application,
custom
Example:
​
command
string[]
Example:
​
connection_tags
object
Example:
​
default_database
string
​
guardrail_rules
string[]
Example:
​
id
string<uuid>
Example:
​
jira_issue_template_id
string
Example:
​
managed_by
string
Example:
​
redact_enabled
boolean
​
redact_types
string[]
Example:
​
resource_name
string
Example:
​
reviewers
string[]
Example:
​
secret
object
​
status
enum<string>
Available options:
online,
offline
​
subtype
string
Example:
​
tags
string[]
Example: