---
title: "Get the ip allow list for organization"
url: "https://nov18-dev.movespot.fyi/apis/konnect-organizations-3/versions/0fabbb32-5b59-4682-8ca3-0695a9f4759c/operations/get-ip-allow-list"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-organizations-3/versions/0fabbb32-5b59-4682-8ca3-0695a9f4759c.md

# Get the ip allow list for organization

`GET` `/organizations/{organizationId}/ip-allow-list`

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

Gets the ip allow list configuration for an organization.

## Path parameters

- `organizationId` (string, uuid, required) - UUID representing an organization.

## Responses

- `200` - The organization's ip allow list configuration.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Organizations
  version: 3.0.0
servers:
  - url: https://global.api.konghq.com/v3
    description: Global Base URL
paths:
  /organizations/{organizationId}/ip-allow-list:
    parameters:
      - $ref: "#/components/parameters/OrganizationIdParameter"
    get:
      operationId: get-ip-allow-list
      summary: Get the ip allow list for organization
      description: |
        Gets the ip allow list configuration for an organization.
      responses:
        "200":
          $ref: "#/components/responses/OrganizationSourceIPRestriction"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Organizations
security:
  - serviceAccessToken: []
components:
  parameters:
    OrganizationIdParameter:
      name: organizationId
      in: path
      description: UUID representing an organization.
      required: true
      schema:
        $ref: "#/components/schemas/OrganizationId"
  responses:
    OrganizationSourceIPRestriction:
      description: The organization's ip allow list configuration.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OrganizationSourceIPRestriction"
          examples:
            Example:
              value:
                enabled: true
                allowed_ips:
                  - 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:
    OrganizationId:
      description: UUID representing an organization.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    OrganizationSourceIPRestriction:
      type: object
      properties:
        enabled:
          $ref: "#/components/schemas/SourceIPEnabled"
        allowed_ips:
          $ref: "#/components/schemas/AllowedIPs"
      additionalProperties: false
      required:
        - enabled
        - allowed_ips
      title: Organization Source IP Restriction
    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
    SourceIPEnabled:
      description: Whether ip allow list is enabled for the organization.
      type: boolean
      example: true
      default: false
    AllowedIPs:
      description: The list of allowed ips for the organization.
      type: array
      items:
        type: string
      example:
        - 192.168.1.1
        - 192.168.1.0/22
      maxItems: 1000
      minItems: 1
      uniqueItems: true
    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
  securitySchemes:
    serviceAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |
        The Service access token is meant to be used between internal services.
```
