---
title: "Get all ip allow lists for portal"
url: "https://nov18-dev.movespot.fyi/apis/internal-kauth-admin-api-v1-1/versions/bb58fcea-1135-45ba-880d-56a1563e8969/operations/get-all-ip-allow-list-portal"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-kauth-admin-api-v1-1/versions/bb58fcea-1135-45ba-880d-56a1563e8969.md

# Get all ip allow lists for portal

`GET` `/internal/portals/{portalId}/ip-allow-list`

Operation ID: `get-all-ip-allow-list-portal`

Gets all the ip allow lists for a portal.

## Path parameters

- `portalId` (string, uuid, required) - ID of the portal.

## Responses

- `200` - The response schema for getting all ip allow lists for a portal.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal KAuth Admin API v1
  version: 1.0.8
servers:
  - url: http://admin-api.kauth.svc.cluster.local:8000/v1
    description: KAuth Admin API Internal url
  - url: http://kauth-source-ip-api.kauth.svc.cluster.local:8080/v1
    description: Source IP API Internal url
paths:
  /internal/portals/{portalId}/ip-allow-list:
    parameters:
      - $ref: "#/components/parameters/PortalId"
    get:
      operationId: get-all-ip-allow-list-portal
      summary: Get all ip allow lists for portal
      description: |
        Gets all the ip allow lists for a portal.
      responses:
        "200":
          $ref: "#/components/responses/PortalIPAllowList"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Portal IP Allow List
components:
  parameters:
    PortalId:
      schema:
        type: string
        format: uuid
      name: portalId
      in: path
      required: true
      description: ID of the portal.
  responses:
    PortalIPAllowList:
      description: The response schema for getting all ip allow lists for a portal.
      content:
        application/json:
          schema:
            type: object
            properties:
              allowed_ips:
                description: The list of allowed ips for the portal.
                type: array
                items:
                  type: string
                example:
                  - 192.168.1.1
                  - 192.168.1.0/22
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
  examples:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
```
