> ## Documentation Index > Fetch the complete documentation index at: https://docs.storiza.store/llms.txt > Use this file to discover all available pages before exploring further. # Reinstall VPS instance by ID > Reinstalls the VPS operating system, optionally switching template, image version, template inputs and login credentials. This is the only way to change them: they are applied while the image is being built, so an existing server cannot adopt a new set without being rebuilt. Credentials follow the same rule as ordering -- a `vmPassword`, an `sshKeyId`, or both, and Windows requires a password and refuses keys. Fields you omit keep their current value; pass `null` to clear one. **Everything on the disk is destroyed.** **Required API key permission:** `vps:write` ## OpenAPI ````yaml /openapi.json post /vps/{vmId}/reinstall openapi: 3.0.0 info: title: Storiza API version: '1.0' description: Manage Storiza servers, apps and subscriptions programmatically. servers: - url: https://api.storiza.store security: - bearerAuth: [] tags: - name: Servers description: Create, order, renew and upgrade VPS servers, and read their details. - name: Server power & commands description: >- Start, stop, reboot and force-stop a server, check its status and run commands on it. - name: Server settings description: >- Rename a server, reinstall its operating system and follow its installation. - name: Server firewall description: Turn a server's firewall on or off and manage its rules. - name: Server metrics description: CPU, memory, disk and network usage, now and over time. - name: Server backups description: Order the backup add-on, and take, list and delete backups. - name: Server snapshots description: Take, list and delete snapshots of a server. - name: Server sharing description: A share link that lets someone else open the server. - name: Server catalog description: >- Plans, operating systems, categories, datacenters and backup plans. Public — no key needed. - name: Apps description: >- Deploy, order, renew and configure apps — game servers, databases and bots. - name: App lifecycle & console description: >- Start, stop, restart and kill an app, read its output and metrics, and send it commands. - name: App files description: >- Read, write, move and delete the files in an app's volume, and its SFTP access. - name: App backups description: Back up an app, download a backup, and restore from one. - name: App domains description: Your own domains for an app, and their DNS verification. - name: App groups description: Private networks that let your apps reach each other by hostname. - name: App catalog description: Templates, plans and locations for apps. - name: Subscriptions description: What you pay for, how often it renews, and stopping or resuming it. - name: Payments description: >- Follow a payment after an order, and the methods and currencies you can pay with. - name: Account description: Your profile, and a summary of everything you own. - name: SSH keys description: Public keys you can install on new Linux servers. paths: /vps/{vmId}/reinstall: post: tags: - Server settings summary: Reinstall VPS instance by ID description: >- Reinstalls the VPS operating system, optionally switching template, image version, template inputs and login credentials. This is the only way to change them: they are applied while the image is being built, so an existing server cannot adopt a new set without being rebuilt. Credentials follow the same rule as ordering -- a `vmPassword`, an `sshKeyId`, or both, and Windows requires a password and refuses keys. Fields you omit keep their current value; pass `null` to clear one. **Everything on the disk is destroyed.** **Required API key permission:** `vps:write` parameters: - schema: type: string format: uuid required: true name: vmId in: path requestBody: content: application/json: schema: type: object properties: templateId: type: string hostname: type: string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?$ templateImageSlug: type: string minLength: 1 inputs: type: object additionalProperties: nullable: true sshKeyId: type: string nullable: true format: uuid vmPassword: type: string nullable: true minLength: 8 maxLength: 64 pattern: ^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[^A-Za-z0-9]) responses: '200': description: VPS reinstall process has been initiated content: application/json: schema: type: object properties: success: type: boolean enum: - true message: type: string enum: - VPS reinstall process has been initiated data: type: object properties: {} required: - success - message - data '400': description: >- Provide a vmPassword, an sshKeyId, or both | Windows servers require a vmPassword | Windows servers cannot be provisioned with an SSH key | VPS must be in active state to reinstall it | This VPS has been suspended due to abuse and cannot be managed | VPS has expired and cannot be started | VPS cannot be started because the owner account is suspended | Failed to reinstall VPS content: application/json: schema: type: object properties: success: type: boolean enum: - false type: type: string code: type: string error: type: string details: nullable: true required: - success - type - code - error examples: vpsCredentialsRequired: summary: Provide a vmPassword, an sshKeyId, or both value: success: false type: API code: VPS_CREDENTIALS_REQUIRED error: Provide a vmPassword, an sshKeyId, or both vpsPasswordRequired: summary: Windows servers require a vmPassword value: success: false type: API code: VPS_PASSWORD_REQUIRED error: Windows servers require a vmPassword vpsSshKeyNotSupported: summary: Windows servers cannot be provisioned with an SSH key value: success: false type: API code: VPS_SSH_KEY_NOT_SUPPORTED error: Windows servers cannot be provisioned with an SSH key vpsNotActiveForReinstall: summary: VPS must be in active state to reinstall it value: success: false type: API code: BAD_REQUEST error: VPS must be in active state to reinstall it vpsSuspended: summary: >- This VPS has been suspended due to abuse and cannot be managed value: success: false type: API code: VPS_SUSPENDED error: >- This VPS has been suspended due to abuse and cannot be managed vpsExpired: summary: VPS has expired and cannot be started value: success: false type: API code: VPS_EXPIRED error: VPS has expired and cannot be started vpsOwnerSuspended: summary: VPS cannot be started because the owner account is suspended value: success: false type: API code: VPS_OWNER_SUSPENDED error: >- VPS cannot be started because the owner account is suspended reinstallFailed: summary: Failed to reinstall VPS value: success: false type: API code: BAD_REQUEST error: Failed to reinstall VPS '401': description: >- Authentication required | Authentication required: use session or shareToken content: application/json: schema: type: object properties: success: type: boolean enum: - false type: type: string code: type: string error: type: string details: nullable: true required: - success - type - code - error examples: authenticationRequired: summary: Authentication required value: success: false type: API code: AUTHENTICATION_ERROR error: Authentication required vpsAuthenticationRequired: summary: 'Authentication required: use session or shareToken' value: success: false type: API code: AUTHENTICATION_ERROR error: 'Authentication required: use session or shareToken' '403': description: Account is banned | Account is suspended | Insufficient permissions content: application/json: schema: type: object properties: success: type: boolean enum: - false type: type: string code: type: string error: type: string details: nullable: true required: - success - type - code - error examples: accountBanned: summary: Account is banned value: success: false type: API code: ACCOUNT_BANNED error: Account is banned accountSuspended: summary: Account is suspended value: success: false type: API code: ACCOUNT_SUSPENDED error: Account is suspended insufficientPermissions: summary: Insufficient permissions value: success: false type: API code: AUTHORIZATION_ERROR error: Insufficient permissions '404': description: VPS not found | SSH key not found | Template not found content: application/json: schema: type: object properties: success: type: boolean enum: - false type: type: string code: type: string error: type: string details: nullable: true required: - success - type - code - error examples: vpsNotFound: summary: VPS not found value: success: false type: API code: NOT_FOUND error: VPS not found sshKeyNotFound: summary: SSH key not found value: success: false type: API code: SSH_KEY_NOT_FOUND error: SSH key not found templateNotFound: summary: Template not found value: success: false type: API code: NOT_FOUND error: Template not found '422': description: Validation error content: application/json: schema: type: object properties: success: type: boolean enum: - false type: type: string enum: - API code: type: string enum: - VALIDATION_ERROR error: type: string enum: - Validation error details: type: object additionalProperties: type: object properties: _errors: type: array items: type: string required: - success - type - code - error - details example: success: false type: API code: VALIDATION_ERROR error: Validation error details: _errors: - The whole schema has some validation problems some_field: _errors: - This field has some validation problem '500': description: Internal Server Error content: application/json: schema: type: object properties: success: type: boolean enum: - false type: type: string enum: - API code: type: string enum: - INTERNAL_ERROR error: type: string enum: - Internal server error details: nullable: true required: - success - type - code - error example: success: false type: API code: INTERNAL_ERROR error: Internal server error security: - bearerAuth: [] components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- An API key from the Storiza dashboard (API & Integrations), sent as `Authorization: Bearer stz_…`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.