---
title: "Connect a provider"
method: POST
path: "/v1/admin/connections"
---

# Connect a provider

`POST /v1/admin/connections`

## Request

- Base URL: `https://api.octapi.app`
- URL: `https://api.octapi.app/v1/admin/connections`
- Auth: HTTP bearer

## Request body

- object
  - `provider` string, required
  - `external_id` string, nullable
  - `display_name` string, nullable
  - `credentials` object

## Response `200`

Default Response

- object
  - `id` string, required
  - `status` string, required
  - `live` boolean, required

---

[API](https://skmtc.dev/octapi/apis/octapi-api.md) · [All operations](https://skmtc.dev/octapi/apis/octapi-api/llms.txt) · [OpenAPI document](https://skmtc.dev/octapi/apis/octapi-api/revisions/580afda787d2?raw)