Connections
Update Connection
Authentication
Connections
AWS
Guard Rails
Server Management
Jira
Organization Management
Reports
User Management
Sessions
Connections
Update Connection
Update a connection resource.
PUT
/
connections
/
{nameOrID}
curl --request PUT \
--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"
},
"default_database": "<string>",
"guardrail_rules": [
"5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD"
],
"jira_issue_template_id": "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD",
"name": "pgdemo",
"redact_enabled": true,
"redact_types": [
"EMAIL_ADDRESS"
],
"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"
],
"reviewers": [
"dba-group"
],
"secret": {},
"status": "online",
"subtype": "postgres",
"tags": [
"prod"
],
"type": "database"
}
Path Parameters
The name or ID of the resource
Body
application/json
The request body resource
The body is of type object
.
Response
200
application/json
OK
The response is of type object
.
curl --request PUT \
--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"
},
"default_database": "<string>",
"guardrail_rules": [
"5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
"B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD"
],
"jira_issue_template_id": "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD",
"name": "pgdemo",
"redact_enabled": true,
"redact_types": [
"EMAIL_ADDRESS"
],
"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"
],
"reviewers": [
"dba-group"
],
"secret": {},
"status": "online",
"subtype": "postgres",
"tags": [
"prod"
],
"type": "database"
}