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

# Get the IP allowlist

> <Note>
  **Organization Admin** permissions are required for this endpoint.
</Note>

Get the organization's IP allowlist: whether it's enforced, the Omni support and SCIM bypasses, and the allowed addresses with their notes.




## OpenAPI

````yaml /api/openapi.yaml get /v1/ip-allowlist
openapi: 3.1.0
info:
  title: Omni API
  description: >
    The Omni REST API provides programmatic access to your Omni instance for
    managing users, documents, queries, schedules, and more.  
  version: 1.0.0
  contact:
    name: Omni Support
    url: https://docs.omni.co
servers:
  - url: https://{instance}.omniapp.co/api
    description: Production
    variables:
      instance:
        default: blobsrus
        description: Your production Omni instance subdomain
  - url: https://{instance}.playground.exploreomni.dev/api
    description: Playground
    variables:
      instance:
        default: blobsrus
        description: Your playground Omni instance subdomain
security:
  - bearerAuth: []
  - orgApiKey: []
tags:
  - name: Who Am I
    description: Inspect your own user permissions
  - name: AI
    description: AI-powered query generation
  - name: AI Credit Controls
    description: Manage organization-level AI credit usage
  - name: AI Credit Usage
    description: Monitor AI credit usage
  - name: AI Evals
    description: >-
      Manage prompt sets and runs used to score AI quality against curated
      prompt suites.
  - name: AI Model Suggestions
    description: Manage AI-generated suggestions for shared models
  - name: AI Routines
    description: >-
      Manage Routines, which are scheduled, recurring AI-powered tasks that run
      automatically on your data
  - name: Apps
    description: Draft and publish app documents.
  - name: Documents v2
    description: >
      A draft-based workflow for creating and editing documents: create a
      document, patch a draft, then publish.
  - name: Documents
    description: Create, retrieve, and manage documents
  - name: API Tokens
    description: >-
      Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
      grants)
  - name: IP Allowlist
    description: Manage the organization's IP allowlist
  - name: Connections
    description: Manage database connections
  - name: Connection environments
    description: Manage connection environments database connections
  - name: Color Palettes
    description: Manage custom chart color palettes
  - name: Content
    description: Unified content retrieval (documents and folders)
  - name: Content migration
    description: Export and import dashboards
  - name: Content validator
    description: Validate content against models and perform find/replace operations
  - name: Dashboard downloads
    description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
  - name: Dashboard filters and controls
    description: Read and update dashboard filter and control default values
  - name: dbt
    description: Manage dbt configuration for connections
  - name: Document favorites
    description: Favorite and unfavorite documents
  - name: Document labels
    description: Apply and manage labels on documents
  - name: Document permissions
    description: Manage document-level access
  - name: Embed
    description: Manage embed sessions
  - name: Labels
    description: |
      Manage labels in the organization
  - name: Folders
    description: Create and organize content folders
  - name: Folder labels
    description: Apply and manage labels on folders
  - name: Folder permissions
    description: Manage folder-level access
  - name: Jobs
    description: Check status of asynchronous jobs
  - name: Models
    description: Create and manage data models
  - name: Model branches
    description: Manage model branches and merge changes
  - name: Model git configuration
    description: Manage git configuration for shared models
  - name: Queries
    description: Execute workbook queries
  - name: Schedules
    description: Create and manage scheduled tasks
  - name: Schedule recipients
    description: Manage schedule recipients
  - name: Schema refresh schedules
    description: Manage automated schema refresh schedules for connections
  - name: Skills
    description: >-
      Manage skills, the saved slash-command instructions the Omni AI assistant
      runs
  - name: Topics
    description: Retrieve topic information from models
  - name: Uploads
    description: Manage file uploads
  - name: Users
    description: Manage users
  - name: User attributes
    description: Manage user attribute definitions
  - name: User groups
    description: Manage user groups
  - name: User model roles
    description: Manage model and connection role assignments for users
  - name: User group model roles
    description: Manage model and connection role assignments for user groups
  - name: Uploads
    description: Manage CSV and spreadsheet uploads
paths:
  /v1/ip-allowlist:
    get:
      tags:
        - IP Allowlist
      summary: Get the IP allowlist
      description: >
        <Note>
          **Organization Admin** permissions are required for this endpoint.
        </Note>


        Get the organization's IP allowlist: whether it's enforced, the Omni
        support and SCIM bypasses, and the allowed addresses with their notes.
      operationId: ipAllowlistGet
      responses:
        '200':
          description: The current IP allowlist settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpAllowlist'
              example:
                enabled: true
                allowsSupport: false
                exemptsScim: true
                entries:
                  - address: 203.0.113.0/24
                    note: Boston VPN
                  - address: 198.51.100.7/32
                    note: null
        '400':
          description: Missing or malformed `Authorization` header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError400'
              examples:
                bad_auth_header:
                  summary: Malformed Authorization header
                  value:
                    error:
                      code: 400
                      message: >-
                        Bad authorization header, must be formatted as Bearer
                        <token>
        '403':
          description: Invalid API key, or the caller is not an organization admin.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError403'
              examples:
                invalid_api_key:
                  summary: Invalid bearer token
                  value:
                    error:
                      code: 403
                      message: Invalid bearer token
                not_admin:
                  summary: Not an organization admin
                  value:
                    detail: >-
                      Managing the IP allowlist requires organization admin
                      access
                    status: 403
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    IpAllowlist:
      type: object
      properties:
        allowsSupport:
          type: boolean
          description: >-
            Whether Omni support staff, signing in through Omni's own support
            login, can reach the organization from outside the list.
          example: false
        enabled:
          type: boolean
          description: >-
            Whether the allowlist is enforced. While false the entries are kept,
            but no address is blocked.
          example: true
        entries:
          type: array
          items:
            type: object
            properties:
              address:
                type: string
                description: >-
                  A public IPv4 or IPv6 address or CIDR range, as stored: always
                  network/prefix, so a single address reads 198.51.100.7/32.
                example: 203.0.113.0/24
              note:
                type: string
                nullable: true
                description: What the entry is for, or null when it has no note.
                example: Boston VPN
            required:
              - address
              - note
          description: The allowed addresses and ranges, in the order given.
        exemptsScim:
          type: boolean
          description: >-
            Whether SCIM provisioning requests (everything under /api/scim/) are
            accepted from any address. They still need an organization API key.
          example: true
      required:
        - allowsSupport
        - enabled
        - entries
        - exemptsScim
    ApiError400:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 400
      required:
        - detail
        - status
    ApiError403:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 403
      required:
        - detail
        - status
    Error:
      type: object
      properties:
        error:
          type: string
          description: HTTP response code for the error
          example: <response_code>
        message:
          type: string
          description: Detailed error description
          example: <error_reason>
  responses:
    TooManyRequests:
      description: Too Many Requests - Rate limit exceeded (60 requests/minute)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Can be either an [Organization API
        Key](/api/authentication#organization-api-keys) or [Personal Access
        Token (PAT)](/api/authentication#token-types).


        Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
    orgApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Requires an [Organization API
        Key](/api/authentication#organization-api-keys). Personal Access Tokens
        (PATs) are not supported for this endpoint.


        Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`

````

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