connections_read

GET

/connections/{id}

const url = 'https://api.canopyhq.dev/connections/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.canopyhq.dev/connections/example \
  --header 'Authorization: Bearer <token>'

Authorizations

console_token

Parameters

Path Parameters

required

string

The connection, by the name the tenant gave it.

Responses

200

The connection, with the catalog captured when it was last linked and where it stands.

application/json

object

auth

One of:

null
object

null

catalog

required

object

key

additional properties

A tool as advertised by its MCP server. An absent output schema stays absent.

object

description

required

string

input_schema

required

output_schema

One of:

null
unknown

null

endpoint

required

string

name

required

The tenant’s readable namespace for this connection’s tools.

string

result_limit

One of:

null
string

null

A byte count written with an optional binary unit, such as 16KiB.

string

state

Where a connection stands: linked with its catalog, or waiting on the owner to authorize it. A linked connection whose token set was refused and could not be refreshed reads as needing authorization again.

string

Allowed values: linked authorizing needs_authorization

timeout

string | null

Example

{
  "auth": {
    "kind": "bearer"
  },
  "state": "linked"
}

401

No console token, or one that did not verify.

404

The tenant owns no connection by that name.