> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boat.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Forget an account of a credential

> Delete an account; the one in use is replaced by another first.



## OpenAPI

````yaml openapi/boat-v1.yaml DELETE /credential-profiles/{profile}/accounts/{credential}/{account}
openapi: 3.1.0
info:
  title: Boat Public API v1
  version: 1.0.0
  description: >
    Public JSON API for creating, operating, prompting, observing, and exposing
    sandboxes from backend services, CI jobs, hosted workers, and Boat
    automation products.


    The v1 reference intentionally documents the developer integration surface
    only. Dashboard billing actions are not part of v1.
servers:
  - url: https://boat.dev/api/v1
security:
  - BoatBearerAuth: []
tags:
  - name: Boat
    description: >-
      Unified Boat account, setup, lifecycle, prompting, event history, desktop
      access, and SSH operations.
paths:
  /credential-profiles/{profile}/accounts/{credential}/{account}:
    parameters:
      - name: profile
        in: path
        required: true
        schema:
          type: string
        description: Profile id or name.
      - name: credential
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/CredentialId'
      - name: account
        in: path
        required: true
        schema:
          type: string
        description: The account id from the list.
    delete:
      tags:
        - Boat
      summary: Forget an account of a credential
      description: >-
        Deletes an account. For the account in use, the credential switches to
        another account first, or is removed when it was the last one. Needs an
        API key with `account.admin`.
      operationId: deleteCredentialAccount
      responses:
        '200':
          description: The accounts left.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialAccountsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    CredentialId:
      type: string
      description: >-
        One AI credential in a credential profile. The `*-api-key` ids are API
        keys you can set with `PUT
        /credential-profiles/{profile}/keys/{credential}`. The sign-ins
        (`*-subscription`) and Bedrock (`*-bedrock`) are connected on the
        dashboard Agents & Proxying page, with the profile picked at the top;
        you can remove them here.
      enum:
        - anthropic-api-key
        - openai-api-key
        - openrouter-api-key
        - llmgateway-api-key
        - deepseek-api-key
        - moonshot-api-key
        - mistral-api-key
        - claude-subscription
        - chatgpt-subscription
        - kimi-subscription
        - mistral-vibe-subscription
        - claude-bedrock
        - codex-bedrock
    CredentialAccountsResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessBase'
        - type: object
          required:
            - success
            - profileId
            - credential
            - accounts
          properties:
            success:
              type: boolean
            profileId:
              type: string
            credential:
              $ref: '#/components/schemas/CredentialId'
            accounts:
              type: array
              items:
                $ref: '#/components/schemas/CredentialAccount'
              description: >-
                In the order the accounts were added, so their numbers stay the
                same across switches. The one in use is marked `active`.
    SuccessBase:
      type: object
      required:
        - ok
        - type
      properties:
        ok:
          type: boolean
          examples:
            - true
        type:
          type: string
          description: Stable success envelope discriminator added by v1.
    CredentialAccount:
      type: object
      required:
        - id
        - label
        - active
      description: One account of a credential. Never a secret.
      properties:
        id:
          type: string
          description: The account's id. It stays the same across switches.
        label:
          type: string
          description: >-
            The account's email for a sign-in, or the key's last characters
            (…1234).
          examples:
            - you@example.com
            - …1234
        active:
          type: boolean
          description: True for the account every sandbox on the profile uses.
        addedAt:
          type: string
          format: date-time
          description: When the account was set aside (accounts not in use).
    ErrorEnvelope:
      type: object
      required:
        - ok
        - type
        - status
        - code
        - message
        - error
        - requestId
      properties:
        ok:
          type: boolean
          examples:
            - false
        type:
          type: string
          examples:
            - sandbox.error
        status:
          type: integer
          examples:
            - 409
        code:
          type: string
          examples:
            - provider_not_configured
        message:
          type: string
          examples:
            - Prompting is locked until Codex is configured on the Agents page.
        requestId:
          type: string
          examples:
            - req_01HX...
        error:
          type: object
          required:
            - code
            - message
            - status
          properties:
            code:
              type: string
            message:
              type: string
            status:
              type: integer
            details:
              type: object
              additionalProperties: true
  responses:
    BadRequest:
      description: Invalid request body or parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            invalid:
              value:
                ok: false
                type: sandbox.error
                status: 400
                code: invalid_json
                message: Request body must be valid JSON.
                error:
                  code: invalid_json
                  message: Request body must be valid JSON.
                  status: 400
                requestId: req_01HX...
    Unauthorized:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            unauthorized:
              value:
                ok: false
                type: sandbox.error
                status: 401
                code: unauthorized
                message: Unauthorized
                error:
                  code: unauthorized
                  message: Unauthorized
                  status: 401
                requestId: req_01HX...
    Forbidden:
      description: Authenticated token is not allowed to perform this action.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            forbidden:
              value:
                ok: false
                type: sandbox.error
                status: 403
                code: forbidden
                message: Forbidden
                error:
                  code: forbidden
                  message: Forbidden
                  status: 403
                requestId: req_01HX...
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    BoatBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sandbox_api_key
      description: >-
        Boat bearer token in the form `boat_...`. Service API keys authenticate
        sandbox operations.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.