---
title: "Validate and atomically rotate a managed connection credential."
method: POST
path: "/v1/workspaces/{workspaceId}/connections/{connectionId}/credential"
---

# Validate and atomically rotate a managed connection credential.

`POST /v1/workspaces/{workspaceId}/connections/{connectionId}/credential`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/connections/{connectionId}/credential`
- Auth: HTTP bearer

## Headers

- `Idempotency-Key` string, required

## Request body

- ConnectionCredential
  - `api_key` string, required: API key or provider service-account JSON.
  - `display_name` string
  - `config` object

## Response `200`

Idempotent replay of a previous rotation.

- object
  - `data` Connection, required
    - `id` string, uuid, required
    - `adapter_key` string, required
    - `category` 'email' | 'customer' | 'product' | 'work' | 'data', required
    - `display_name` string, required
    - `status` 'pending_validation' | 'active' | 'error' | 'disabled', required
    - `auth_kind` 'api_key' | 'oauth2' | 'service_account' | 'none', required
    - `freshness_mode` 'webhook' | 'poll' | 'on_demand' | 'hybrid', required
    - `capabilities` string[], required
    - `resource_scope` object, required
    - `config` object, required: Non-secret adapter configuration such as a cloud host and project ID.
    - `active_credential_version` integer, nullable
    - `external_account_id` string, nullable
    - `external_account_name` string, nullable
    - `last_validated_at` string, date-time, nullable
    - `last_success_at` string, date-time, nullable
    - `last_error_code` string, nullable
    - `disabled_at` string, date-time, nullable
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `201`: Credential validated and rotated.

---

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