Supabase Secrets API

openapi: 3.2.0
info:
  title: Supabase Management Secrets API
  description: The Supabase Management API provides programmatic access to manage Supabase projects and organizations. It supports operations for creating, updating, and deleting projects, managing database configurations, retrieving project API keys, controlling organization membership, deploying Edge Functions, managing secrets, configuring custom domains, and monitoring project health. Authentication is handled via personal access tokens or OAuth2 tokens.
  version: 1.0.0
  contact:
    name: Supabase Support
    url: https://supabase.com/support
  termsOfService: https://supabase.com/terms
servers:
- url: https://api.supabase.com/v1
  description: Production Server
security:
- bearerAuth: []
tags:
- name: Secrets
  description: Manage project secrets used by Edge Functions and other services.
paths:
  /projects/{ref}/secrets:
    get:
      operationId: listSecrets
      summary: List project secrets
      description: Returns a list of all encrypted secrets stored for a project. Secret values are not returned, only their names.
      tags:
      - Secrets
      parameters:
      - $ref: '#/components/parameters/ProjectRef'
      responses:
        '200':
          description: Successfully retrieved secrets
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Secret'
        '401':
          description: Unauthorized
        '404':
          description: Project not found
    post:
      operationId: createSecrets
      summary: Create project secrets
      description: Creates one or more encrypted secrets for the project. These secrets are available to Edge Functions as environment variables.
      tags:
      - Secrets
      parameters:
      - $ref: '#/components/parameters/ProjectRef'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CreateSecretRequest'
      responses:
        '201':
          description: Secrets created successfully
        '400':
          description: Bad request
        '401':
          description: Unauthorized
    delete:
      operationId: deleteSecrets
      summary: Delete project secrets
      description: Deletes one or more secrets from the project by their names.
      tags:
      - Secrets
      parameters:
      - $ref: '#/components/parameters/ProjectRef'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: Secrets deleted successfully
        '401':
          description: Unauthorized
components:
  schemas:
    Secret:
      type: object
      properties:
        name:
          type: string
          description: Name of the secret
    CreateSecretRequest:
      type: object
      required:
      - name
      - value
      properties:
        name:
          type: string
          description: Name for the secret
        value:
          type: string
          description: Secret value
  parameters:
    ProjectRef:
      name: ref
      in: path
      required: true
      description: The unique reference ID for the project, found in the project settings or URL.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Personal access token or OAuth2 token for authentication. Generate tokens from the Supabase Dashboard under Account > Access Tokens.
externalDocs:
  description: Supabase Management API Documentation
  url: https://supabase.com/docs/reference/api/introduction