---
title: "POST /api/ee/remote-sync/test-connection"
method: POST
path: "/api/ee/remote-sync/test-connection"
tags: ["/api/ee/remote-sync"]
---

# POST /api/ee/remote-sync/test-connection

`POST /api/ee/remote-sync/test-connection`

## Request

- Base URL: `` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/ee/remote-sync/test-connection`
- Auth: API key in header `X-API-Key`

Test whether the Remote Sync credentials can reach the git repository.

  When called with an empty body, validates the currently saved URL and token. When the body provides
  `remote-sync-url` or `remote-sync-token`, those override the saved values — useful for verifying a
  new Personal Access Token before saving. An obfuscated token (matching the existing token's masked
  representation) is treated as "unchanged" and the stored token value is used for the test.

  Only validates connection and authentication; branch existence is not checked here.

  Returns `{:status :success}` on success. On failure, returns a 400 with a user-friendly error
  message describing the connection problem.

  Requires superuser permissions.

## Request body

- object
  - `remote-sync-token` string, nullable
  - `remote-sync-url` string, nullable

## Response `2XX`

Successful response

- object
  - `status` 'success', required

## Other responses

- `4XX`: Client error response
- `5XX`: Server error response

## Changes

- **2026-11-04** `2e178f5a7934`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/metabase/apis/metabase-api/changes/api/ee/remote-sync/test-connection/post.md)

---

[API](https://skmtc.dev/metabase/apis/metabase-api.md) - [All operations](https://skmtc.dev/metabase/apis/metabase-api/llms.txt) - [OpenAPI document](https://skmtc.dev/metabase/apis/metabase-api/revisions/2e178f5a7934?raw)