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

# Restart serverhosts

> Ask one or more serverhosts to restart themselves without updating and without stopping their servers.
Every serverhost must belong to the network; if any is unknown, none is restarted.
The response reports per serverhost whether it acknowledged the request, so it is 200 even when some did not.



## OpenAPI

````yaml https://controller.simplecloud.app/swagger/doc.json post /v0/serverhosts/restart
openapi: 3.1.0
info:
  contact:
    name: SimpleCloud support
    url: https://discord.simplecloud.app
  description: >-
    Manage Minecraft networks, server groups, persistent servers, players, and
    plugins. Authenticate with Authorization: Bearer <JWT> or
    X-Network-Credential: <network password or JWT>. Bearer authentication takes
    precedence when both headers are supplied. Network-scoped operations also
    require X-Network-ID. JWT permissions and network membership restrict
    access; network passwords grant full access to their network, except that
    they cannot read the audit log. Registration requires an existing
    credential; password authentication also requires its existing network ID.
    The admin endpoint requires an admin JWT. Credential verification accepts
    credentials in the request body without authentication headers.
  title: SimpleCloud Controller API
  version: '1.0'
servers:
  - url: https://controller.simplecloud.app/
security: []
externalDocs:
  description: ''
  url: ''
paths:
  /v0/serverhosts/restart:
    post:
      tags:
        - serverhosts
      summary: Restart serverhosts
      description: >-
        Ask one or more serverhosts to restart themselves without updating and
        without stopping their servers.

        Every serverhost must belong to the network; if any is unknown, none is
        restarted.

        The response reports per serverhost whether it acknowledged the request,
        so it is 200 even when some did not.
      operationId: restart_serverhosts
      parameters:
        - description: Network ID
          in: header
          name: X-Network-ID
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/models.RestartServerhostsRequest'
              summary: request
              description: Serverhosts to restart
        description: Serverhosts to restart
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.RestartServerhostsResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.ErrorResponse'
          description: Internal Server Error
      security:
        - BearerAuth: []
        - NetworkCredential: []
components:
  schemas:
    models.RestartServerhostsRequest:
      description: >-
        Request to restart one or more serverhosts without stopping their
        servers
      properties:
        serverhost_ids:
          example:
            - 123e4567-e89b-12d3-a456-426614174000
          items:
            type: string
          type: array
          uniqueItems: false
      type: object
    models.RestartServerhostsResponse:
      description: Response with one result per requested serverhost, in request order
      properties:
        results:
          items:
            $ref: '#/components/schemas/models.ServerhostRestartResult'
          type: array
          uniqueItems: false
      type: object
    models.ErrorResponse:
      description: Generic error response
      properties:
        error:
          type: string
      type: object
    models.ServerhostRestartResult:
      description: >-
        Whether a serverhost acknowledged the restart request. An acknowledgment
        means it received the request, not that it restarts: a serverhost
        ignores the request while an update or restart is running or during a
        cooldown after one started.
      properties:
        acknowledged:
          example: true
          type: boolean
        error:
          example: serverhost is not connected or does not support restarts
          type: string
        host_name:
          example: ServerHost-1
          type: string
        serverhost_id:
          example: 123e4567-e89b-12d3-a456-426614174000
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      description: >-
        JWT sent in Authorization: Bearer <token>. Access depends on the token's
        network membership and permissions. The admin endpoint requires admin
        claims.
      scheme: bearer
      type: http
    NetworkCredential:
      description: >-
        Network password or signed JWT. Password authentication also requires
        X-Network-ID and grants full access to that network, except the audit
        log. JWT permissions still apply.
      in: header
      name: X-Network-Credential
      type: apiKey

````

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