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

# Revoke an API key

> Soft-revokes the key (sets `revokedAt`). Idempotent — revoking an already-revoked key returns it unchanged.



## OpenAPI

````yaml openapi.json POST /api/v1/keys/{id}/revoke
openapi: 3.1.0
info:
  title: Vine API
  version: extraction.v1
  description: >-
    Provider detection and extraction service. URL in → structured business data
    out.
servers:
  - url: https://vine.getcourtyard.ai
security:
  - bearerAuth: []
paths:
  /api/v1/keys/{id}/revoke:
    post:
      summary: Revoke an API key
      description: >-
        Soft-revokes the key (sets `revokedAt`). Idempotent — revoking an
        already-revoked key returns it unchanged.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Key revoked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  key:
                    $ref: '#/components/schemas/KeyRevoked'
        '404':
          $ref: '#/components/responses/Error'
      security: []
components:
  schemas:
    KeyRevoked:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        keyPrefix:
          type: string
        revokedAt:
          type: string
          format: date-time
  responses:
    Error:
      description: Error envelope.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: vine_live_… / vine_test_… API key

````