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

# Switch Console Display

> Switches a Linux server to the QXL display its console needs. **This restarts
the server once**, so ask your customer first. A server that needs no switch,
such as a Windows server or one switched before, answers `200` with
`restarting: false` and is not touched.

Open a console session once the restart has finished, which usually takes
under a minute. The server must be running.




## OpenAPI

````yaml put /servers/{server}/console/display
openapi: 3.1.0
info:
  title: APIFiddle Sample Definition
  version: 0.0.0
  description: Example workspace
servers:
  - url: https://rdp.sh/api/v1
    description: Default production endpoint.
security: []
paths:
  /servers/{server}/console/display:
    put:
      summary: Switch the console display
      description: >
        Switches a Linux server to the QXL display its console needs. **This
        restarts

        the server once**, so ask your customer first. A server that needs no
        switch,

        such as a Windows server or one switched before, answers `200` with

        `restarting: false` and is not touched.


        Open a console session once the restart has finished, which usually
        takes

        under a minute. The server must be running.
      operationId: switchServerConsoleDisplay
      parameters:
        - $ref: '#/components/parameters/server'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: SwitchServerConsoleDisplayReady
                properties:
                  status:
                    type: boolean
                    examples:
                      - true
                  restarting:
                    type: boolean
                    examples:
                      - false
                  message:
                    type: string
                    examples:
                      - The console display is ready.
          description: The server needs no switch and was left alone.
        '202':
          content:
            application/json:
              schema:
                type: object
                title: SwitchServerConsoleDisplayAccepted
                properties:
                  status:
                    type: boolean
                    examples:
                      - true
                  restarting:
                    type: boolean
                    examples:
                      - true
                  message:
                    type: string
                    examples:
                      - The server is restarting onto the console display.
          description: The server is restarting onto the console display.
        '403':
          content:
            application/json:
              schema:
                type: object
                title: SwitchServerConsoleDisplayUnauthorized
                properties:
                  status:
                    type: boolean
                    examples:
                      - false
                  error:
                    type: string
                    examples:
                      - This action is unauthorized
          description: User does not own the server.
        '404':
          description: Server not found.
        '409':
          content:
            application/json:
              schema:
                type: object
                title: SwitchServerConsoleDisplayConflict
                properties:
                  status:
                    type: boolean
                    examples:
                      - false
                  error:
                    type: string
                    examples:
                      - >-
                        The server could not be restarted onto the console
                        display. It keeps running as it was. Please try again in
                        a few minutes.
          description: >
            The server is stopped, could not be restarted (it keeps running as
            it was),

            or is suspended or busy.
        '429':
          description: |
            Too many power actions. This counts towards the limit of
            `POST /servers/{server}/power/{state}`: 6 a minute per server.
      security:
        - Authorization: []
components:
  parameters:
    server:
      in: path
      name: server
      schema:
        type: string
      required: true
  securitySchemes:
    Authorization:
      in: header
      name: Authorization
      type: apiKey
      description: |
        Your API key as it is, without `Bearer`. API access is off for new
        accounts: until it is turned on under Settings > API, every request
        answers `403` with `API access is turned off for this account. Turn it
        on under Settings > API.` If the account lists allowed IPs, a request
        from any other address answers `403` with `This API key is not allowed
        from <address>`.

````

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