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

# Add IP to whitelist

> Adds an IP address to the project allowlist. Once any address is whitelisted, requests from other addresses are rejected.



## OpenAPI

````yaml POST /v1/projects/ip-whitelist
openapi: 3.1.0
info:
  title: Convexity Infra API
  version: 1.0.0
  description: >-
    REST API reference for Convexity Infra: the backend services your business
    integrates to build and operate on-chain products. Every response is wrapped
    in a `{ status, message, data }` envelope and authorized with an OAuth 2.0
    bearer token minted by Auth-Edge.
  contact:
    name: Convexity Infra
    url: https://withconvexity.com
    email: infra@withconvexity.com
servers:
  - url: https://api.convexity.tools
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Auth-Edge
    description: >-
      OAuth 2.0 token issuance. Exchange a project API key for a short-lived
      bearer token that authorizes every other Infra API call.
  - name: Projects
    description: >-
      Manage the calling project itself: rotate its API key pair and control
      which IP addresses may authenticate with it.
  - name: Payments
    description: >-
      List project and subscription payments, and mint virtual bank accounts
      (via KoraPay) for wallet top-ups and subscriptions.
  - name: Products
    description: >-
      Browse the products and capabilities available to your project. Each
      product maps to a plan and a set of capability keys.
  - name: Subscriptions
    description: List available plans and manage your project's subscriptions.
  - name: Wallet
    description: >-
      HD wallet lifecycle, balances, transfers, transaction signing, and
      supported-chain discovery. Wallets are scoped to the business in your
      token: accessing another business's wallet returns `403`.


      **Capabilities**: each operation is gated on a capability granted by your
      plan; a missing one returns `403: Missing required capability:
      <capability>`.


      | Capability | Grants |

      |---|---|

      | `wallet.hd.generate` | Generate wallets. |

      | `wallet.hd.read` | List and read wallets, counts, and HD status. |

      | `wallet.hd.sign` | Sign transactions. |

      | `wallet.hd.deactivate` | Deactivate a wallet. |

      | `wallet.transfer.create` | Initiate transfers. |

      | `wallet.transfer.read` | Read transaction history and records. |

      | `wallet.balance.read` | Read the USD balance. |
  - name: Indexer
    description: >-
      Subscribe to decoded on-chain events, receive signed webhooks, and inspect
      or replay delivery logs. Every endpoint requires a token with project +
      business context and a per-operation capability.
  - name: Tokenization
    description: >-
      Issue and manage tokenized real-world assets: create tokens, mint, burn,
      transfer, manage holders and registered wallets, and run yield operations
      (coupons, distributions, claims, and principal redemption).
paths:
  /v1/projects/ip-whitelist:
    post:
      tags:
        - Projects
      summary: Add IP to whitelist
      description: >-
        Adds an IP address to the project allowlist. Once any address is
        whitelisted, requests from other addresses are rejected.
      operationId: addIpToWhitelist
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - ipAddress
              properties:
                ipAddress:
                  type: string
                  description: A valid IPv4 or IPv6 address to allow.
                label:
                  type: string
                  description: Optional human-readable label (e.g. `Production server`).
            example:
              ipAddress: 203.0.113.10
              label: Production server
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
              example:
                status: true
                message: IP whitelisted successfully
                data:
                  id: 665f0a1b2c3d4e5f60123abc
                  projectId: 66f0a1b2c3d4e5f601234567
                  ipAddress: 203.0.113.10
                  label: Production server
                  createdBy: '42'
                  createdAt: '2026-07-03T09:00:00.000Z'
                  updatedAt: '2026-07-03T09:00:00.000Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
              example:
                status: false
                message: Authorization token is missing or malformed.
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                type: object
              example:
                status: false
                message: ipAddress must be a valid IPv4 or IPv6 address
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 access token from Auth-Edge.

````