> ## 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.

# Crie um ticket para o console serial

> Crie uma credencial de instância única de curta duração para abrir o console serial a partir de um navegador.

**Provavelmente você não precisa disso.** Qualquer cliente que possa definir cabeçalhos de solicitação — a CLI `basaltic`, ou qualquer ferramenta não-browser — autentica a atualização do WebSocket normalmente. Isso existe porque o construtor WebSocket de um navegador pega uma URL e nada mais, então não há como enviar um cabeçalho `Authorization` nele.

Passe o `ticket` retornado como um parâmetro de consulta na atualização:

```
wss://compute.<region>.basaltic.sh/v1/instances/<id>/console/serial?ticket=<ticket>
```

**O ticket é deliberadamente estreito.** Ele abre UMA instância, expira em sessenta segundos e não autoriza nada mais — porque uma credencial em um URL é gravada nos logs de acesso do proxy, e isso vale muito menos do que um token de sessão. Faça uma por conexão; não a armazene.

Ela carrega quem você é, não o que você pode fazer. Se você pode abrir este console ainda é decidido quando o soquete se conecta, contra a política como ela está então — então uma permissão revogada no minuto intermediário é honrada em vez de congelada no ticket.


<Info>
  Requer **nenhuma ação do IAM**. O acesso é decidido pelas próprias regras do endpoint, e não por uma política — consulte a descrição acima.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/compute.yaml post /v1/instances/{instance_id}/console/ticket
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/ticket:
    post:
      tags:
        - Compute
      summary: Crie um ticket para o console serial
      description: >
        Crie uma credencial de instância única de curta duração para abrir o
        console serial a partir de um navegador.


        **Provavelmente você não precisa disso.** Qualquer cliente que possa
        definir cabeçalhos de solicitação — a CLI `basaltic`, ou qualquer
        ferramenta não-browser — autentica a atualização do WebSocket
        normalmente. Isso existe porque o construtor WebSocket de um navegador
        pega uma URL e nada mais, então não há como enviar um cabeçalho
        `Authorization` nele.


        Passe o `ticket` retornado como um parâmetro de consulta na atualização:


        ```

        wss://compute.<region>.basaltic.sh/v1/instances/<id>/console/serial?ticket=<ticket>

        ```


        **O ticket é deliberadamente estreito.** Ele abre UMA instância, expira
        em sessenta segundos e não autoriza nada mais — porque uma credencial em
        um URL é gravada nos logs de acesso do proxy, e isso vale muito menos do
        que um token de sessão. Faça uma por conexão; não a armazene.


        Ela carrega quem você é, não o que você pode fazer. Se você pode abrir
        este console ainda é decidido quando o soquete se conecta, contra a
        política como ela está então — então uma permissão revogada no minuto
        intermediário é honrada em vez de congelada no ticket.
      operationId: createSerialConsoleTicket
      parameters:
        - $ref: '#/components/parameters/InstanceId'
      responses:
        '200':
          description: Um bilhete para uma sessão de console
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SerialConsoleTicket'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '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
  schemas:
    SerialConsoleTicket:
      type: object
      description: >
        Uma credencial de um tiro para abrir um console serial de um navegador.
        Passe `ticket` como um parâmetro de consulta na atualização WebSocket.
      required:
        - ticket
        - expires_at
        - expires_in
      properties:
        ticket:
          type: string
          description: >
            A credencial. Opaco — não analisar. Bom para uma instância e um
            minuto; criar uma nova por conexão em vez de armazená-la.
        expires_at:
          type: string
          format: date-time
        expires_in:
          type: integer
          description: Segundos até que expire.
          example: 60
    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
  responses:
    BadRequest:
      description: Parâmetros de solicitação inválidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_INPUT
              message: Invalid request parameters
              request_id: 550e8400-e29b-41d4-a716-446655440000
    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
  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.