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

# Create a private network in a server's location

> ### Overview

Creates a private network in this server's location. Send `name` and optionally a private `subnet`. Attach the server separately after creation.

### Permissions

Requires the `network.update` (Change networking) permission for the selected team. Resources outside that team return 404.



## OpenAPI

````yaml https://console.advinservers.com/docs/openapi.json post /servers/{server}/private-networks
openapi: 3.1.0
info:
  title: API reference
  version: 1.0.0
  description: >-
    Use this API to manage your team's servers, networks, backups, and other
    resources.


    ## Authentication


    Create an API key under **API Keys** and send it as a bearer token with
    every request:


    ```

    Authorization: Bearer {YOUR_API_KEY}

    Accept: application/json

    ```


    Copy the key when you create it. It cannot be shown again. Revoking a key
    takes effect immediately.


    ## Permissions


    Give each key only the permissions it needs. Every endpoint lists the
    required permission.


    Permissions cover servers and other resources in the key's team.


    ## Team scope


    A key can access resources in the team selected when it was created. This
    includes servers,

    snapshots, backups, firewall groups, images, SSH keys, scripts, networks and
    addresses.

    Resources in other teams return `404 Not Found`. Create a separate key for
    each team.


    The key determines the team for every request. Legacy keys that had no team
    are assigned

    to the account's first owned team.


    ## Actions that need the panel


    API keys cannot do the following, even with every permission. Sign in to the
    panel in a

    browser to do them:


    - Create, edit or revoke API keys

    - Edit the IP groups that restrict API keys

    - End signed-in sessions

    - Change two-factor authentication

    - Change the account's email address

    - Accept or decline team invitations

    - Switch or leave a team


    This keeps a leaked key from widening its own access or locking you out of
    your account.


    ## Source IP restrictions


    A key can be restricted to one or more IP groups. Requests from other
    addresses are rejected.


    ## Requests and responses


    Each endpoint lists its path, query, header, and body parameters. Examples
    use fictional data.


    Single records use JSON objects. Collections use JSON arrays unless the
    endpoint supports pagination. Timestamps use ISO 8601 in UTC.


    Error responses include `message`. Validation errors also include an
    `errors` object for each field. Each endpoint lists its status codes.


    ## Audit log


    Every API request, including reads, is recorded in the account audit log
    with the key that made it.
servers:
  - url: https://console.advinservers.com/api/v1/client
security:
  - http: []
tags:
  - name: Account
    description: Billing contact details and account setup progress.
  - name: Account activity
    description: Actions performed in the current team by people and API keys.
  - name: Servers
    description: >-
      Order and list servers, read their state and resource use, open a console,
      and control power.
  - name: Server settings
    description: >-
      Rename a server, rebuild it, and change its hardware, media, resolvers and
      credentials.
  - name: Backups
    description: Scheduled server copies stored separately from the server.
  - name: Snapshots
    description: >-
      Take, restore and move server snapshots. Snapshots are kept in snapshot
      storage that the team buys by the GiB.
  - name: Firewall groups
    description: Reusable sets of firewall rules, and the servers they apply to.
  - name: IP groups
    description: Reusable source address lists for firewall rules.
  - name: Server firewall
    description: >-
      Read default traffic policies and rules managed outside your firewall
      groups.
  - name: IP addresses
    description: Manage floating IPs and server address assignments.
  - name: Private networks
    description: Connect servers over a private network in the same location.
  - name: Reverse DNS
    description: Set the hostnames returned by IP address lookups.
  - name: DDoS protection
    description: Configure attack filtering for server addresses.
  - name: Bandwidth
    description: Buy extra bandwidth and share it between servers or location pools.
  - name: SSH keys
    description: Public keys the account can install on a server when it is built.
  - name: Setup scripts
    description: Scripts the account can run on a server when it is built.
  - name: ISO images
    description: ISO images you have downloaded, and the servers they are mounted on.
  - name: Server upgrades
    description: Change an existing server's plan.
  - name: Checkout
    description: Choose a payment method and pay for a purchase.
  - name: Invoices
    description: View and pay account invoices.
  - name: Billing
    description: Manage service renewals, payment methods and account credit.
  - name: Transfers
    description: Move resources between teams or transfer ownership.
  - name: Teams
    description: Manage the team assigned to your API key.
  - name: Team members
    description: Invite people and manage their team access.
  - name: Team roles
    description: Define the permissions granted to team members.
  - name: Team activity
    description: View actions performed in a team.
  - name: Support tickets
    description: >-
      Open, read, reply to and close support tickets. Tickets belong to the
      account holder and are not shared with team members.
paths:
  /servers/{server}/private-networks:
    post:
      tags:
        - Private networks
      summary: Create a private network in a server's location
      description: >-
        ### Overview


        Creates a private network in this server's location. Send `name` and
        optionally a private `subnet`. Attach the server separately after
        creation.


        ### Permissions


        Requires the `network.update` (Change networking) permission for the
        selected team. Resources outside that team return 404.
      operationId: convoy.client.servers.privateNetwork.store
      parameters:
        - name: server
          in: path
          required: true
          description: The server UUID
          schema:
            type: string
            examples:
              - ecc6f4f1
          example: ecc6f4f1
      requestBody:
        description: >-
          Send a JSON object containing the fields below. Required fields are
          marked in the schema.
        required: true
        content:
          application/json:
            schema:
              examples:
                - name: Lambda Complex staging
                  subnet: 10.24.1.0/24
              allOf:
                - $ref: >-
                    #/components/schemas/Convoy.Http.Requests.Client.Servers.PrivateNetworks.StorePrivateNetworkRequest
      responses:
        '200':
          description: The record, as a JSON object. There is no envelope.
          content:
            application/json:
              schema:
                examples:
                  - id: 5220f263-0e8e-4917-bf4f-4cae109ca4c5
                    name: Lambda Complex staging
                    subnet: 10.24.1.0/24
                    location: Kansas City, MO
                    attached: false
                    attachment_status: null
                    members: []
                    created_at: '2026-09-14T16:42:09+00:00'
                allOf:
                  - $ref: '#/components/schemas/PrivateNetworkData'
        '401':
          description: >-
            The key was missing, malformed, revoked, or belongs to an account
            that no longer exists.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Unauthenticated.
                required:
                  - message
        '403':
          description: >-
            Access denied. Check the key's team, permissions and allowed IP
            addresses. Some actions, such as managing API keys, require a
            browser session. The response message explains the reason.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - >-
                        This API key is not allowed to do that in this team. It
                        needs the "snapshot.delete" permission.
                required:
                  - message
        '404':
          description: >-
            The resource was not found in the selected team. Resources in
            another account or team also return 404.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Not found.
                required:
                  - message
        '422':
          description: >-
            A field is missing or invalid, or the resource cannot accept this
            change in its current state. Check `message` for details. Field
            validation also includes an `errors` object keyed by field name.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: >-
                      A summary of the validation error or the reason the change
                      was refused.
                    examples:
                      - The name field is required.
                  errors:
                    type: object
                    description: Validation errors grouped by field name.
                    additionalProperties:
                      type: array
                      items:
                        type: string
                required:
                  - message
        '429':
          description: >-
            Too many requests. The `Retry-After` header says how many seconds to
            wait. Limits are per account, so several keys on one account share
            them.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Too Many Attempts.
                required:
                  - message
components:
  schemas:
    Convoy.Http.Requests.Client.Servers.PrivateNetworks.StorePrivateNetworkRequest:
      type: object
      examples:
        - name: Lambda Complex staging
          subnet: 10.24.1.0/24
      properties:
        name:
          type: string
          description: The name shown to customers.
          pattern: ^[\w\-. ]+$
          minLength: 1
          maxLength: 64
        subnet:
          type:
            - string
            - 'null'
          description: The value of `subnet`.
      required:
        - name
      title: >-
        Convoy.Http.Requests.Client.Servers.PrivateNetworks.StorePrivateNetworkRequest
    PrivateNetworkData:
      type: object
      description: >-
        An isolated segment carrying traffic between the account's own servers
        in one city.
      examples:
        - id: 5220f263-0e8e-4917-bf4f-4cae109ca4c5
          name: Sector C backbone
          subnet: 10.24.0.0/24
          location: Kansas City, MO
          attached: true
          attachment_status: attached
          members:
            - server_id: ecc6f4f1-c89b-4dce-a20b-a330641c5b0b
              uuid_short: ecc6f4f1
              name: lambda-core
              hostname: lambda-core.blackmesa.example.com
              template_name: Ubuntu 24.04
              template_icon_url: https://img.icons8.com/color/48/ubuntu.png
              windows: false
              nic_index: 1
              ip_address: 10.24.0.10
              status: attached
              is_current: true
            - server_id: 304e1794-a5b7-41f2-9a20-c0d444eb6683
              uuid_short: 304e1794
              name: sector-c-db
              hostname: sector-c-db.blackmesa.example.com
              template_name: Debian 13
              template_icon_url: https://img.icons8.com/color/48/debian.png
              windows: false
              nic_index: 1
              ip_address: 10.24.0.11
              status: attached
              is_current: false
          created_at: '2026-05-11T09:20:47+00:00'
      properties:
        id:
          type: string
          description: The id ID.
          examples:
            - 5220f263-0e8e-4917-bf4f-4cae109ca4c5
        name:
          type: string
          description: The name shown to customers.
          examples:
            - Sector C backbone
        subnet:
          type:
            - string
            - 'null'
          description: >-
            The range members are addressed out of, and below, the address each
            one holds on it.
          examples:
            - 10.24.0.0/24
        location:
          type:
            - string
            - 'null'
          description: >-
            The network's city name, shared by locations in the same city. Used
            in the account-wide network list.
          examples:
            - Kansas City, MO
        attached:
          type: boolean
          description: Whether the requested server is attached to this network.
          examples:
            - true
        attachment_status:
          type:
            - string
            - 'null'
          description: >-
            The requested server's attachment status, or null when it is not
            attached.
          enum:
            - attaching
            - attached
            - detaching
            - null
          examples:
            - attached
        members:
          type: array
          description: The value of `members`.
          examples:
            - - server_id: ecc6f4f1-c89b-4dce-a20b-a330641c5b0b
                uuid_short: ecc6f4f1
                name: lambda-core
                hostname: lambda-core.blackmesa.example.com
                template_name: Ubuntu 24.04
                template_icon_url: https://img.icons8.com/color/48/ubuntu.png
                windows: false
                nic_index: 1
                ip_address: 10.24.0.10
                status: attached
                is_current: true
              - server_id: 304e1794-a5b7-41f2-9a20-c0d444eb6683
                uuid_short: 304e1794
                name: sector-c-db
                hostname: sector-c-db.blackmesa.example.com
                template_name: Debian 13
                template_icon_url: https://img.icons8.com/color/48/debian.png
                windows: false
                nic_index: 1
                ip_address: 10.24.0.11
                status: attached
                is_current: false
          items:
            $ref: '#/components/schemas/PrivateNetworkMemberData'
        created_at:
          type:
            - string
            - 'null'
          description: The date and time for created at, in UTC.
          examples:
            - '2026-05-11T09:20:47+00:00'
      required:
        - id
        - name
        - subnet
        - location
        - attached
        - attachment_status
        - members
        - created_at
      title: PrivateNetworkData
    PrivateNetworkMemberData:
      type: object
      description: One machine on a private network's segment.
      examples:
        - server_id: ecc6f4f1-c89b-4dce-a20b-a330641c5b0b
          uuid_short: ecc6f4f1
          name: lambda-core
          hostname: lambda-core.blackmesa.example.com
          template_name: Ubuntu 24.04
          template_icon_url: https://img.icons8.com/color/48/ubuntu.png
          windows: false
          nic_index: 1
          ip_address: 10.24.0.10
          status: attached
          is_current: true
      properties:
        server_id:
          type:
            - string
            - 'null'
          description: The server id ID.
          examples:
            - ecc6f4f1-c89b-4dce-a20b-a330641c5b0b
        uuid_short:
          type:
            - string
            - 'null'
          description: The value of `uuid_short`.
          examples:
            - ecc6f4f1
        name:
          type:
            - string
            - 'null'
          description: The name shown to customers.
          examples:
            - lambda-core
        hostname:
          type:
            - string
            - 'null'
          description: The fully qualified hostname.
          examples:
            - lambda-core.blackmesa.example.com
        template_name:
          type:
            - string
            - 'null'
          description: >-
            Enough to draw the machine the way every other list of servers draws
            it, and withheld with the name for the same reason.
          examples:
            - Ubuntu 24.04
        template_icon_url:
          type:
            - string
            - 'null'
          description: The value of `template_icon_url`.
          examples:
            - https://img.icons8.com/color/48/ubuntu.png
        windows:
          type: boolean
          description: The value of `windows`.
          examples:
            - false
        nic_index:
          type:
            - integer
            - 'null'
          description: The value of `nic_index`.
          examples:
            - 1
        ip_address:
          type:
            - string
            - 'null'
          description: The value of `ip_address`.
          examples:
            - 10.24.0.10
        status:
          type: string
          description: The value of `status`.
          enum:
            - attaching
            - attached
            - detaching
          examples:
            - attached
        is_current:
          type: boolean
          description: Whether this is the requested server.
          examples:
            - true
      required:
        - server_id
        - uuid_short
        - name
        - hostname
        - template_name
        - template_icon_url
        - windows
        - nic_index
        - ip_address
        - status
        - is_current
      title: PrivateNetworkMemberData
  securitySchemes:
    http:
      type: http
      description: >-
        Your API key, sent as a bearer token. Create one in the control panel
        under API Keys, give it only the permissions the integration needs, and
        copy it when it is created. It cannot be shown again. Each key is
        restricted to one owned team. The key determines the team for every
        request.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.