---
title: "Create Virtual Users from a NeoLoad project archive"
method: POST
path: "/design/imports/neoload/{projectId}"
tags: ["Design - Virtual Users - Imports"]
---

# Create Virtual Users from a NeoLoad project archive

`POST /design/imports/neoload/{projectId}`

## Request

- Base URL: `https://api.octoperf.com`
- URL: `https://api.octoperf.com/design/imports/neoload/{projectId}`
- Auth: none declared

## Path parameters

- `projectId` string, required

## Query parameters

- `providerId` string
- `location` string

## Request body

- object
  - `file` string, binary, required

## Response `200`

OK

- NeoLoadImportResult
  - `virtualUsers` VirtualUser[]
    - `id` string
    - `userId` string
    - `projectId` string
    - `name` string
    - `description` string
    - `children` Action[], nullable
      - `enabled` boolean
      - `children` Action[]
      - `id` string
    - `created` string, date-time
    - `lastModified` string, date-time
    - `type` 'JMETER' | 'WEB_DRIVER' | 'FRAGMENTS' | 'PLAYWRIGHT' | 'K6'
    - `tags` string[], nullable
  - `scenarios` Scenario[]
    - `id` string, nullable
    - `userId` string, nullable
    - `projectId` string, nullable
    - `name` string
    - `description` string, nullable
    - `userProfiles` UserProfile[], nullable
      - `id` string, nullable
      - `name` string, nullable
      - `virtualUserId` string
      - `providerId` string
      - `location` string
      - `load` unknown
      - `memory` MemorySettings
        - `vuMb` number, double
      - `iterations` integer
      - `engine` unknown
    - `mode` 'STANDARD' | 'FUNCTIONAL', nullable
    - `created` string, date-time, nullable
    - `lastModified` string, date-time, nullable
    - `tags` string[], nullable
  - `assessment` NeoLoadProjectAssessment
    - `projectName` string
    - `productVersion` string
    - `portability` 'MECHANICAL' | 'ASSISTED' | 'MOSTLY_MANUAL' | 'EMPTY'
    - `inventory` NeoLoadInventory
      - `virtualUsers` integer
      - `containers` integer
      - `pages` integer
      - `httpRequests` integer
      - `pluginRequests` integer
      - `extractors` integer
      - `assertions` integer
      - `delays` integer
      - `controlFlows` integer
      - `scripts` integer
      - `customActions` integer
      - `variables` integer
      - `servers` integer
      - `populations` integer
      - `scenarios` integer
      - `monitoredHosts` integer
    - `virtualUsers` NeoLoadVirtualUserSummary[]
      - `name` string
      - `httpRequests` integer
      - `pluginRequests` integer
      - `containers` integer
      - `scripts` integer
      - `customActions` integer
      - `portability` 'MECHANICAL' | 'ASSISTED' | 'MOSTLY_MANUAL' | 'EMPTY'
    - `plugins` NeoLoadPluginUsage[]
      - `plugin` string
      - `requests` integer
    - `unconverted` NeoLoadUnconverted[]
      - `kind` 'PLUGIN_REQUEST' | 'JAVASCRIPT_ACTION' | 'TRY_CATCH' | 'FORK' | 'STOP_VIRTUAL_USER' | 'CUSTOM_ACTION' | 'SERIALIZED_VARIABLE' | 'ENCRYPTED_VARIABLE' | 'GENERATED_VARIABLE' | 'SERVER_CREDENTIALS' | 'RENDEZVOUS_POLICY' | 'CONTAINER_EXECUTION' | 'MISSING_DATA_FILE' | 'BINARY_BODY' | 'WAIT_UNTIL' | 'HTTP_PUSH' | 'MEDIA_STREAM' | 'SOAP_ENVELOPE' | 'WEBSOCKET_PUSH' | 'MONITOR' | 'SLA_THRESHOLD' | 'SLA_PROFILE' | 'XPATH_ASSERTION' | 'USER_PATH_SEQUENCE' | 'SWITCH_FALL_THROUGH' | 'PREDEFINED_VARIABLE' | 'UNKNOWN_ELEMENT' | 'CONVERSION_FAILED' | 'CORRELATION_CANDIDATE' | 'COLUMN_MAPPING'
      - `tag` string
      - `uid` string
      - `virtualUser` string
      - `marker` string
      - `facts` unknown
  - `unconverted` NeoLoadUnconverted[]
    - `kind` 'PLUGIN_REQUEST' | 'JAVASCRIPT_ACTION' | 'TRY_CATCH' | 'FORK' | 'STOP_VIRTUAL_USER' | 'CUSTOM_ACTION' | 'SERIALIZED_VARIABLE' | 'ENCRYPTED_VARIABLE' | 'GENERATED_VARIABLE' | 'SERVER_CREDENTIALS' | 'RENDEZVOUS_POLICY' | 'CONTAINER_EXECUTION' | 'MISSING_DATA_FILE' | 'BINARY_BODY' | 'WAIT_UNTIL' | 'HTTP_PUSH' | 'MEDIA_STREAM' | 'SOAP_ENVELOPE' | 'WEBSOCKET_PUSH' | 'MONITOR' | 'SLA_THRESHOLD' | 'SLA_PROFILE' | 'XPATH_ASSERTION' | 'USER_PATH_SEQUENCE' | 'SWITCH_FALL_THROUGH' | 'PREDEFINED_VARIABLE' | 'UNKNOWN_ELEMENT' | 'CONVERSION_FAILED' | 'CORRELATION_CANDIDATE' | 'COLUMN_MAPPING'
    - `tag` string
    - `uid` string
    - `virtualUser` string
    - `marker` string
    - `facts` unknown

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `429`: Too Many Requests

## Changes

- **2026-11-03** `637a8f8ce8cf`: 1 info
  - api operation id `h` removed and replaced with `o_3`
- **2026-10-30** `fc0ab021d8d3`: 1 info
  - api operation id `S_1` removed and replaced with `h`
- **2026-10-29** `6fb7a9d5eb1c`: 1 info
  - api operation id `v_4` removed and replaced with `S_1`
- **2026-10-28** `6fc0f4ece308`: 1 info
  - api operation id `l_2` removed and replaced with `v_4`
- **2026-10-27** `d04c0ffc592f`: 1 info
  - api operation id `d_4` removed and replaced with `l_2`

[Operation history](https://skmtc.dev/octoperf/apis/octoperf-api/changes/design/imports/neoload/:projectId/post.md)

---

[API](https://skmtc.dev/octoperf/apis/octoperf-api.md) - [All operations](https://skmtc.dev/octoperf/apis/octoperf-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octoperf/apis/octoperf-api/revisions/637a8f8ce8cf?raw)