> ## 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.

# Remove a credential profile credential

> Remove one API key or sign-in from a profile.



## OpenAPI

````yaml openapi/boat-v1.yaml DELETE /credential-profiles/{profile}/keys/{credential}
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}/keys/{credential}:
    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'
    delete:
      tags:
        - Boat
      summary: Remove a credential profile credential
      description: >-
        Removes one credential, an API key or a sign-in. Needs an API key with
        `account.admin`.
      operationId: deleteCredentialProfileKey
      responses:
        '200':
          description: The updated profile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialProfileResponse'
        '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
    CredentialProfileResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessBase'
        - type: object
          required:
            - success
            - profile
          properties:
            success:
              type: boolean
            profile:
              $ref: '#/components/schemas/CredentialProfile'
    SuccessBase:
      type: object
      required:
        - ok
        - type
      properties:
        ok:
          type: boolean
          examples:
            - true
        type:
          type: string
          description: Stable success envelope discriminator added by v1.
    CredentialProfile:
      type: object
      required:
        - id
        - name
        - isDefault
        - owner
        - canManage
        - connected
        - customApis
        - createdAt
        - updatedAt
      description: A named set of AI credentials. Secret values are never returned.
      properties:
        id:
          type: string
        name:
          type: string
          examples:
            - default
            - work
        isDefault:
          type: boolean
          description: >-
            True for the one profile of its owner that sandboxes get when
            nothing names a profile. The dashboard Agents page edits this
            profile.
        owner:
          type: object
          required:
            - id
            - kind
            - name
            - aiProxyEnabled
          properties:
            id:
              type: string
              description: The account that owns the profile, a person or an organization.
            kind:
              type: string
              enum:
                - personal
                - org
            name:
              type: string
            aiProxyEnabled:
              type: boolean
              description: True when the owner has the AI credentials proxy on.
        canManage:
          type: boolean
          description: >-
            True when you can change the profile. Org members use an org
            profile; org owners manage it.
        connected:
          type: array
          items:
            $ref: '#/components/schemas/CredentialId'
          description: The credentials the profile holds.
        accounts:
          type: object
          description: >-
            Credentials with several accounts, keyed by credential id. Each
            lists every account (labels only), the one in use marked `active`.
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/CredentialAccount'
        customApis:
          type: array
          items:
            type: string
          description: The names of the profile's custom APIs. Values are never returned.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    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
    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).
  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.