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

# List allow/deny list entries

> Returns a paginated list of allow/deny entries for the caller's tenant, filtered by `list` (allow|deny).



## OpenAPI

````yaml get /api/v1/settings/allow_deny_entries
openapi: 3.0.0
info:
  contact: {}
  title: Ocean Security API
  version: 1.0.0
  description: Ocean Security API for threat detection and security metrics
servers:
  - url: https://api.ocean.security
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Threats
    description: Operations for retrieving threat information
  - name: Metrics
    description: Security metrics and analytics endpoints
paths:
  /api/v1/settings/allow_deny_entries:
    get:
      tags:
        - Settings
      summary: List allow/deny list entries
      description: >-
        Returns a paginated list of allow/deny entries for the caller's tenant,
        filtered by `list` (allow|deny).
      parameters:
        - description: Authentication API Key
          in: header
          name: X-Api-Key
          required: true
          schema:
            type: string
        - description: 'Filter entries by list: allow or deny'
          in: query
          name: list
          required: true
          schema:
            type: string
        - description: 1-based page index (default 1)
          in: query
          name: page
          schema:
            type: integer
        - description: Page size (default 50, max 200)
          in: query
          name: page_size
          schema:
            type: integer
        - description: Substring match on identifier value
          in: query
          name: q
          schema:
            type: string
      responses:
        '200':
          description: Paginated entries
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ocean_api_common.BaseResponse-controllers_settings_allow_deny_ListAllowDenyEntriesResult
        '400':
          description: Invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.ErrorResponse'
components:
  schemas:
    ocean_api_common.BaseResponse-controllers_settings_allow_deny_ListAllowDenyEntriesResult:
      properties:
        results:
          $ref: >-
            #/components/schemas/controllers_settings_allow_deny.ListAllowDenyEntriesResult
        status:
          type: integer
      type: object
    types.ErrorResponse:
      properties:
        error:
          type: string
      type: object
    controllers_settings_allow_deny.ListAllowDenyEntriesResult:
      properties:
        items:
          items:
            $ref: >-
              #/components/schemas/controllers_settings_allow_deny.AllowDenyEntry
          type: array
        page:
          type: integer
        page_size:
          type: integer
        total:
          type: integer
      type: object
    controllers_settings_allow_deny.AllowDenyEntry:
      properties:
        comment:
          type: string
        created_at:
          type: string
        created_by:
          type: string
        entry_type:
          $ref: '#/components/schemas/controllers_settings_allow_deny.EntryType'
        id:
          type: string
        list:
          $ref: '#/components/schemas/controllers_settings_allow_deny.ListKind'
        value:
          type: string
        verdict_scope:
          $ref: '#/components/schemas/controllers_settings_allow_deny.Scope'
      type: object
    controllers_settings_allow_deny.EntryType:
      enum:
        - domain
        - ip
        - email_address
      type: string
      x-enum-varnames:
        - EntryTypeDomain
        - EntryTypeIP
        - EntryTypeEmail
    controllers_settings_allow_deny.ListKind:
      enum:
        - allow
        - deny
      type: string
      x-enum-varnames:
        - ListAllow
        - ListDeny
    controllers_settings_allow_deny.Scope:
      enum:
        - global
        - graymail
      type: string
      x-enum-varnames:
        - ScopeGlobal
        - ScopeGraymail
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: API key for authentication

````