Supabase Network API

openapi: 3.2.0
info:
  title: Supabase Management Network 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: Network
  description: Manage network restrictions, bans, and SSL enforcement.
paths:
  /projects/{ref}/network-bans:
    get:
      operationId: listNetworkBans
      summary: List network bans
      description: Returns a list of IP addresses that are currently banned from accessing the project due to abusive traffic patterns such as multiple failed authentication attempts.
      tags:
      - Network
      parameters:
      - $ref: '#/components/parameters/ProjectRef'
      responses:
        '200':
          description: Successfully retrieved network bans
          content:
            application/json:
              schema:
                type: object
                properties:
                  banned_ipv4_addresses:
                    type: array
                    items:
                      type: string
                      format: ipv4
                    description: List of banned IPv4 addresses
        '401':
          description: Unauthorized
    delete:
      operationId: removeNetworkBans
      summary: Remove network bans
      description: Removes specified IP addresses from the project's network ban list, allowing them to access the project again.
      tags:
      - Network
      parameters:
      - $ref: '#/components/parameters/ProjectRef'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ipv4_addresses:
                  type: array
                  items:
                    type: string
                    format: ipv4
      responses:
        '200':
          description: Network bans removed
        '401':
          description: Unauthorized
  /projects/{ref}/network-restrictions:
    get:
      operationId: getNetworkRestrictions
      summary: Get network restrictions
      description: Retrieves the network restriction configuration for a project, which controls which IP addresses or CIDR ranges are allowed to connect to the database.
      tags:
      - Network
      parameters:
      - $ref: '#/components/parameters/ProjectRef'
      responses:
        '200':
          description: Successfully retrieved network restrictions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkRestrictions'
        '401':
          description: Unauthorized
    post:
      operationId: updateNetworkRestrictions
      summary: Update network restrictions
      description: Updates the allowed IP addresses or CIDR ranges that can connect to the project database.
      tags:
      - Network
      parameters:
      - $ref: '#/components/parameters/ProjectRef'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkRestrictions'
      responses:
        '200':
          description: Network restrictions updated
        '400':
          description: Bad request - invalid CIDR
        '401':
          description: Unauthorized
components:
  schemas:
    NetworkRestrictions:
      type: object
      properties:
        dbAllowedCidrs:
          type: array
          items:
            type: string
          description: List of CIDR ranges allowed to connect to the database
  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