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

# Abra um console serial interativo

> Atualizações para um WebSocket que carrega uma sessão interativa na porta serial da instância — o equivalente a um carrinho de crash, e a única maneira de entrar quando a rede está quebrada: um fstab ruim, um kernel errado, um grupo de segurança que bloqueou você, um disco cheio.

Bytes brutos em quadros binários, em ambas as direções. É um terminal, não um protocolo: enviar teclas, receber o que o convidado digita. Aponte um emulador de terminal para ele.

Isso o leva ao prompt de login PRÓPRIO do convidado. Não é um backdoor — as credenciais do convidado ainda são necessárias e nada aqui concede acesso além do que o próprio convidado permite.

**Autenticando a atualização.** Um cliente que pode definir cabeçalhos — a CLI `basaltic`, ou qualquer coisa que não esteja em execução em um navegador — autentica isso como qualquer outra chamada e não precisa de nada extra.

Um BROWSER não pode: o construtor WebSocket toma uma URL e nenhum cabeçalho. Para esse caso, `POST` o endpoint companheiro `/console/ticket` e passe o resultado como um parâmetro de consulta `ticket`. O ticket é deliberadamente estreito — uma instância, sessenta segundos — porque uma credencial em um URL acaba nos logs do proxy, e essa vale muito menos do que um token de sessão.

Uma sessão por instância: abrir uma segunda desconecta a primeira, em vez de intercalar as teclas de duas pessoas no mesmo terminal. Uma sessão termina após 15 minutos de inatividade, ou 4 horas, independentemente, e o quadro próximo carrega o motivo.

Requer que a instância esteja em execução.


<Info>
  Requer a ação do IAM **`compute:StartSerialConsole`**. Consulte [permissões de computação](/pt/compute/permissions) para obter a lista completa, o que cada uma abrange e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/compute.yaml get /v1/instances/{instance_id}/console/serial
openapi: 3.0.3
info:
  title: API de Basaltic Compute
  version: 1.0.0
  description: >
    Instâncias de máquina virtual e as imagens, os tipos e os pools de
    instâncias a partir dos quais elas são criadas. Abrange todo o ciclo de vida
    da instância: iniciar, parar, reiniciar, redimensionar e reinstalar.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://compute.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
paths:
  /v1/instances/{instance_id}/console/serial:
    get:
      tags:
        - Compute
      summary: Abra um console serial interativo
      description: >
        Atualizações para um WebSocket que carrega uma sessão interativa na
        porta serial da instância — o equivalente a um carrinho de crash, e a
        única maneira de entrar quando a rede está quebrada: um fstab ruim, um
        kernel errado, um grupo de segurança que bloqueou você, um disco cheio.


        Bytes brutos em quadros binários, em ambas as direções. É um terminal,
        não um protocolo: enviar teclas, receber o que o convidado digita.
        Aponte um emulador de terminal para ele.


        Isso o leva ao prompt de login PRÓPRIO do convidado. Não é um backdoor —
        as credenciais do convidado ainda são necessárias e nada aqui concede
        acesso além do que o próprio convidado permite.


        **Autenticando a atualização.** Um cliente que pode definir cabeçalhos —
        a CLI `basaltic`, ou qualquer coisa que não esteja em execução em um
        navegador — autentica isso como qualquer outra chamada e não precisa de
        nada extra.


        Um BROWSER não pode: o construtor WebSocket toma uma URL e nenhum
        cabeçalho. Para esse caso, `POST` o endpoint companheiro
        `/console/ticket` e passe o resultado como um parâmetro de consulta
        `ticket`. O ticket é deliberadamente estreito — uma instância, sessenta
        segundos — porque uma credencial em um URL acaba nos logs do proxy, e
        essa vale muito menos do que um token de sessão.


        Uma sessão por instância: abrir uma segunda desconecta a primeira, em
        vez de intercalar as teclas de duas pessoas no mesmo terminal. Uma
        sessão termina após 15 minutos de inatividade, ou 4 horas,
        independentemente, e o quadro próximo carrega o motivo.


        Requer que a instância esteja em execução.
      operationId: startSerialConsole
      parameters:
        - $ref: '#/components/parameters/InstanceId'
        - name: backlog_bytes
          in: query
          required: false
          description: >-
            Reproduza esses muitos bytes de saída já gravada antes que a saída
            ao vivo comece, então anexar a um convidado silencioso mostra por
            que ele está silencioso em vez de uma tela vazia. 0 desativa a
            repetição. Valores acima de 65536 são fixados. O replay é a cauda da
            mesma gravação que `/console/output` serve; a sessão ao vivo é a
            porta serial do convidado. As duas são fontes separadas, então a
            junção é marcada com uma linha `\r\n--- live ---\r\n`: tudo antes é
            história, tudo depois está acontecendo agora. Um guest que imprime
            no instante em que você se conecta pode ter alguns bytes em nenhum
            dos lados dessa linha — um guest silencioso, para o qual existe o
            case replay, é reproduzido exatamente.
          schema:
            type: integer
            minimum: 0
            maximum: 65536
            default: 32768
      responses:
        '101':
          description: Alternar protocolos — a sessão do console está aberta.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: A instância não está em execução, portanto, não tem console
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '426':
          description: >-
            Não é uma atualização WebSocket. Este endpoint fala somente
            WebSocket; conecte-se com um cliente WebSocket.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  parameters:
    InstanceId:
      name: instance_id
      in: path
      description: ID da instância
      required: true
      schema:
        type: string
        format: uuid
      example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    NotFound:
      description: Página não encontrada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalServerError:
      description: Erro interno do servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              request_id: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

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