Skip to main content
GET
/
connections
List Connections
curl --request GET \
  --url https://use.hoop.dev/api/connections
[
  {
    "access_mode_connect": "enabled",
    "access_mode_exec": "enabled",
    "access_mode_runbooks": "enabled",
    "access_schema": "enabled",
    "agent_id": "1837453e-01fc-46f3-9e4c-dcf22d395393",
    "name": "pgdemo",
    "type": "database",
    "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": "",
    "redact_enabled": true,
    "redact_types": [
      "EMAIL_ADDRESS"
    ],
    "resource_name": "pgdemo",
    "reviewers": [
      "dba-group"
    ],
    "secret": {},
    "status": "online",
    "subtype": "postgres",
    "tags": [
      "prod"
    ]
  }
]

Query Parameters

​
agent_id
string<uuid>

Filter by agent id

​
tags
string<string>

DEPRECATED: Filter by tags, separated by comma

​
tag_selector
string<string>

Selector tags to fo filter on, supports '=' and '!=' (e.g. key1=value1,key2=value2)

​
search
string<string>

Search by name, type, or subtype

​
type
string<string>

Filter by type

​
subtype
string<string>

Filter by subtype

​
managed_by
string<string>

Filter by managed by

​
connection_ids
string<string>

Filter by specific connection IDs, separated by comma

​
page_size
integer<int>

Maximum number of items to return (1-100). When provided, enables pagination

​
page
integer<int>

Page number (1-based). When provided, enables pagination

Response

Returns array of Connection objects

​
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"

​
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.
Example:
{ "environment": "prod", "tier": "frontend" }
​
default_database
string

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

​
guardrail_rules
string[]

The guard rail association id rules

Example:
[
  "5701046A-7B7A-4A78-ABB0-A24C95E6FE54",
  "B19BBA55-8646-4D94-A40A-C3AFE2F4BAFD"
]
​
id
string<uuid>

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"

​
managed_by
string

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:

""

​
redact_enabled
boolean

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

​
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"]
​
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"}
​
status
enum<string>

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"

​
tags
string[]

DEPRECATED: Tags to classify the connection

Example:
["prod"]