---
title: "Get connection details"
method: GET
path: "/_fabric/{fabric}/_api/connections/{connection-name}"
tags: ["Connections"]
---

# Get connection details

`GET /_fabric/{fabric}/_api/connections/{connection-name}`

## Request

- The document declares no server URL.
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_fabric/:fabric/_api/connections/:connection-name/get.ts> (a function with typed inputs; its response is checked against the schema)

Get information about a specific connection to an external data source.

## Response `200`

Successfully fetched the connection.

- ConnectionResponse
  - `error` boolean, required
  - `code` integer
  - `result` Connection
    - `name` string: Name of the connection.
    - `type` string: Connection type.
    - `connector` ConnectorBase: Lightweight connector definition.
      - `name` string: Name of the connector. This is used as the ID of the connector.
      - `displayName` string: Name that can be used by GUI clients to display the connector.
      - `description` string
      - `type` string: Specifies whether the connector serves as a source or a target.
      - `version` string: Version of the connector.
    - `isEditable` boolean: Indicates whether this connection is editable or not.
    - `isInternal` boolean: Specifies whether this connection is internal or not.
    - `metadata` object: Contains the metadata of the connection. Configurations for the connector, which are set up through this connection, must be provided as key-value pairs.

## Other responses

- `401`: Failed to authenticate the request.
- `404`: Failed to find the connection.

---

[API](https://skmtc.dev/macrometa/apis/macrometa-api-reference.md) - [All operations](https://skmtc.dev/macrometa/apis/macrometa-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/macrometa/apis/macrometa-api-reference/revisions/2006b6d7f31d?raw)