Search

Performs a search for connections and runbooks based on the provided criteria.

GET /search

Search

cURL

curl --request GET \
  --url https://use.hoop.dev/api/search

200

{
  "connections": [
    {
      "name": "pgdemo",
      "type": "database",
      "id": "5364ec99-653b-41ba-8165-67236e894990",
      "resource_name": "my-resource",
      "subtype": "postgres"
    }
  ],
  "errors": [
    "<string>"
  ],
  "resources": [
    {
      "name": "pgdemo",
      "type": "database",
      "id": "5364ec99-653b-41ba-8165-67236e894990",
      "subtype": "postgres"
    }
  ],
  "runbooks": [
    {
      "name": "myrunbooks/run-backup.runbook.sql",
      "repository": "github.com/myorg/myrunbooks"
    }
  ]
}

Query Parameters

term · string · required

Search term

Response

200

application/json

OK

connections · object[]

Connections found in the search

Show child attributes

errors · string[]

Any errors found during the search

resources · object[]

Resources found in the search

Show child attributes

runbooks · object[]

Runbooks found in the search

Show child attributes