> ## Documentation Index > Fetch the complete documentation index at: https://docs.rafftechnologies.com/llms.txt > Use this file to discover all available pages before exploring further. # Reserve a floating IP > Reserve a floating public IP. The IP is allocated immediately and held for your account until you release it. ## Billing Reserved IPs are billed. For subscription accounts the IP price is charged from the account balance up front for the chosen `billing_period` (default monthly): - **Insufficient balance** for the subscription returns `402`. Top up the balance and retry. For pay-as-you-go (PAYG) accounts no upfront charge happens — usage accrues hourly. Updated May 8, 2026 ## OpenAPI ````yaml POST /api/v1/ips/reserve openapi: 3.0.3 info: title: Raff API description: > REST API for managing cloud infrastructure on Raff. ## Authentication Most endpoints require authentication via API key. Catalog endpoints under `/api/v1/public/` are open and require no authentication. ### API Key Authentication Include your API key in the `X-API-Key` header: ``` curl -H "X-API-Key: YOUR_API_KEY" https://api.rafftechnologies.com/api/v1/vms ``` ## Catalog Use the public catalog endpoints to discover available regions, OS templates, and pricing plans before creating resources: - `GET /api/v1/public/regions` — list available regions - `GET /api/v1/public/templates` — list OS templates (use the `id` as `template_id` when creating a VM) - `GET /api/v1/public/pricing/vm` — list VM pricing plans (use the `id` as `pricing_id` when creating a VM) - `GET /api/v1/public/pricing/volume` — volume storage pricing - `GET /api/v1/public/pricing/snapshot` — snapshot storage pricing - `GET /api/v1/public/pricing/backup` — backup storage pricing - `GET /api/v1/public/pricing/ip` — IP address pricing version: 1.0.0 contact: name: Raff Technologies url: https://rafftechnologies.com servers: - url: https://api.rafftechnologies.com description: Production security: - ApiKeyAuth: [] tags: - name: Catalog description: >- Discover available regions, OS templates, and pricing plans. No authentication required. - name: Health description: Health check endpoints - name: Projects description: Organize resources into projects for billing and access control - name: Virtual Machines description: Create, manage, and control virtual machines - name: Networking description: >- Attach and detach VPCs, floating IPs, and security groups to VM network interfaces - name: Snapshots description: Point-in-time copies of VMs and volumes for quick rollback or cloning - name: Backups description: Scheduled and on-demand VM backups with restore capability - name: Backup Schedules description: Recurring daily or weekly backup schedules attached to a VM - name: SSH Keys description: Manage account-level SSH keys for VM provisioning - name: Members description: Account-level members — invite, list, update role, remove - name: Project Members description: Members of a specific project — same model as Members but project-scoped - name: Roles description: Custom roles bundling account or project permissions - name: Permissions description: List the catalog of permission strings used by roles - name: API Keys description: Create and manage API keys for programmatic access - name: Invitations description: Create and cancel email-based invitations to join the account or a project paths: /api/v1/ips/reserve: post: tags: - Networking summary: Reserve a floating IP description: > Reserve a floating public IP. The IP is allocated immediately and held for your account until you release it. ## Billing Reserved IPs are billed. For subscription accounts the IP price is charged from the account balance up front for the chosen `billing_period` (default monthly): - **Insufficient balance** for the subscription returns `402`. Top up the balance and retry. For pay-as-you-go (PAYG) accounts no upfront charge happens — usage accrues hourly. operationId: reserveIP parameters: - $ref: '#/components/parameters/ProjectIDHeader' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/ReserveIPRequest' responses: '201': description: IP reserved content: application/json: schema: type: object properties: success: type: boolean data: $ref: '#/components/schemas/FloatingIP' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/InsufficientBalance' '403': $ref: '#/components/responses/BillingValidationFailed' components: parameters: ProjectIDHeader: name: X-Project-ID in: header required: true description: >- Project ID. Required for all mutating operations (create, delete, power actions, resize). schema: type: string format: uuid schemas: ReserveIPRequest: type: object description: Optional fields for IP reservation. Send an empty body to use defaults. properties: type: type: string enum: - IPv4 - IPv6 default: IPv4 description: IP family to reserve. Defaults to IPv4. region: type: string enum: - us-east description: Region. Defaults to the project's default region. billing_period: type: string enum: - monthly - yearly - twenty_four_month default: monthly description: Subscription billing period. Ignored for PAYG accounts. FloatingIP: type: object description: A floating public IP address. required: - id - ip_address - type - status - reserved properties: id: type: string format: uuid description: IP identifier. account_id: type: string format: uuid project_id: type: string format: uuid created_by: type: string format: uuid description: User who reserved the IP. ip_address: type: string description: The IP address. example: 203.0.113.42 type: type: string enum: - IPv4 - IPv6 description: IP family. status: type: string enum: - free - in-use description: | - `free` — IP is in the pool, not currently attached to any VM. - `in-use` — currently attached to a VM. reserved: type: boolean description: > Whether the IP is reserved (held for the account regardless of VM attachment). A reserved IP can be either `free` (held but not attached) or `in-use` (held and attached). region: type: string enum: - us-east created_at: type: string format: date-time updated_at: type: string format: date-time Error: type: object properties: error: type: string message: type: string BillingError: type: object description: >- Billing validation error response. Returned when the account is not in good standing for paid operations. required: - error - reason properties: error: type: string example: Billing validation failed message: type: string example: Payment failed. Please update your payment method. reason: type: string description: > Machine-readable reason code: - `banned` — account has been suspended - `failed` — last payment failed; balance top-up needed - `no_billing_customer` — billing has not been set up for this account enum: - banned - failed - no_billing_customer responses: BadRequest: description: Invalid request parameters content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Authentication required content: application/json: schema: $ref: '#/components/schemas/Error' InsufficientBalance: description: > Account balance is insufficient for this operation. Top up the balance and retry. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Payment Required message: Insufficient balance for subscription BillingValidationFailed: description: | Billing validation failed. The account is not in good standing. Check the `reason` field: - `banned` — account suspended - `failed` — last payment failed; top up the account balance - `no_billing_customer` — billing not set up content: application/json: schema: $ref: '#/components/schemas/BillingError' securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: API key for authentication. Each key is bound to a specific account. ````