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

# Criar regra de grupo de segurança

> Adiciona uma regra de permissão com estado ao grupo de segurança. Quando vários grupos de segurança se aplicam a uma interface, suas regras de permissão são unificadas.


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


## OpenAPI

````yaml /pt/api-reference/specs/network.yaml post /v1/security-groups/{security_group_id}/rules
openapi: 3.0.3
info:
  title: API da Basaltic Network
  version: 1.0.0
  description: >
    A superfície da VPC — redes e sub-redes, interfaces, tabelas de rotas,
    grupos de segurança, internet, NAT e gateways somente de saída e IPs
    flutuantes.


    As entradas de relacionamento usam um campo de referência: UUID, CRN ou um
    nome exato quando a solicitação fornece seu escopo pai necessário.Sub-redes
    e tabelas de rotas são escopo de VPC; interfaces são escopo de
    sub-rede.<vpc>/subnet/<subnet>, vpc/<vpc>/route-table/<table>, e
    vpc/<vpc>/subnet/<subnet>/interface/<interface>. Os nomes são imutáveis.
    Campos de solicitação desconhecidos e parâmetros de lista são rejeitados.
    Referências vazias fornecidas são inválidas e as pesquisas com falha nunca
    retornam a outro tipo de referência.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://network.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
paths:
  /v1/security-groups/{security_group_id}/rules:
    post:
      tags:
        - Networking
      summary: Criar regra de grupo de segurança
      description: >
        Adiciona uma regra de permissão com estado ao grupo de segurança. Quando
        vários grupos de segurança se aplicam a uma interface, suas regras de
        permissão são unificadas.
      operationId: createSecurityGroupRule
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
        - $ref: '#/components/parameters/SecurityGroupId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityGroupRuleCreateRequest'
      responses:
        '201':
          description: Regra criada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityGroupRuleResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: >-
        Chave opcional gerada pelo cliente que torna uma criação segura para
        reprodução. A reintentar uma solicitação com a mesma chave retorna o
        resultado original literalmente em vez de criar um recurso duplicado. A
        reutilização de uma chave com um corpo de solicitação diferente é
        rejeitada (422); uma solicitação cuja chave ainda está sendo processada
        retorna 409. Os registros são honrados por 24 horas. Use um UUID ou
        token exclusivo semelhante.
      required: false
      schema:
        type: string
        maxLength: 255
      example: 550e8400-e29b-41d4-a716-446655440000
    SecurityGroupId:
      name: security_group_id
      in: path
      description: ID do grupo de segurança
      required: true
      schema:
        type: string
        format: uuid
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    SecurityGroupRuleCreateRequest:
      type: object
      additionalProperties: false
      required:
        - direction
        - protocol
      properties:
        description:
          type: string
          example: Allow inbound HTTPS
        direction:
          $ref: '#/components/schemas/SecurityGroupRuleDirection'
        ethertype:
          allOf:
            - $ref: '#/components/schemas/SecurityGroupRuleEthertype'
          default: ipv4
        protocol:
          $ref: '#/components/schemas/SecurityGroupRuleProtocol'
        port_min:
          type: integer
          minimum: 0
          maximum: 65535
          nullable: true
          example: 443
        port_max:
          type: integer
          minimum: 0
          maximum: 65535
          nullable: true
          example: 443
        remote_cidr:
          type: string
          nullable: true
          example: 0.0.0.0/0
        source_security_group:
          type: string
          example: d1b6f3a8-4c2e-4a9d-8f7b-1e5c3a2d9b4f
          description: >-
            UUID do grupo de segurança, CRN ou nome exato do escopo da conta.
            Exclusivo com remote_cidr.
    SecurityGroupRuleResponse:
      type: object
      properties:
        rule:
          $ref: '#/components/schemas/SecurityGroupRule'
    SecurityGroupRuleDirection:
      type: string
      enum:
        - ingress
        - egress
    SecurityGroupRuleEthertype:
      type: string
      enum:
        - ipv4
        - ipv6
    SecurityGroupRuleProtocol:
      type: string
      enum:
        - tcp
        - udp
        - icmp
        - all
    SecurityGroupRule:
      type: object
      required:
        - id
        - security_group_id
        - direction
        - ethertype
        - protocol
        - created_at
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        security_group_id:
          type: string
          format: uuid
          example: d1b6f3a8-4c2e-4a9d-8f7b-1e5c3a2d9b4f
        description:
          type: string
          example: Allow inbound HTTPS
        direction:
          $ref: '#/components/schemas/SecurityGroupRuleDirection'
        ethertype:
          $ref: '#/components/schemas/SecurityGroupRuleEthertype'
        protocol:
          $ref: '#/components/schemas/SecurityGroupRuleProtocol'
        port_min:
          type: integer
          minimum: 0
          maximum: 65535
          nullable: true
          description: Necessário quando o protocolo é tcp/udp; ignorado caso contrário.
          example: 443
        port_max:
          type: integer
          minimum: 0
          maximum: 65535
          nullable: true
          example: 443
        remote_cidr:
          type: string
          nullable: true
          description: >
            CIDR de origem (entrada) ou destination_cidr (saída). Deve
            corresponder ao tipo de éter da regra. Exclusivo com
            source_security_group_id.
          example: 0.0.0.0/0
        source_security_group_id:
          type: string
          format: uuid
          nullable: true
          description: >
            Origem (entrada) ou destination_cidr (saída) é "qualquer carga de
            trabalho neste SG". O tráfego é correspondido pela associação ao
            grupo de segurança nomeado. Exclusivo com remote_cidr.
          example: d1b6f3a8-4c2e-4a9d-8f7b-1e5c3a2d9b4f
        created_at:
          type: string
          format: date-time
          readOnly: true
    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
    Conflict:
      description: Conflito de recursos (por exemplo, já existe, estado inválido)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: CONFLICT
              message: Resource with this name already exists
              request_id: 550e8400-e29b-41d4-a716-446655440000
    UnprocessableEntity:
      description: >
        A solicitação está bem formada, mas não pode ser processada conforme
        enviada. Nas operações que aceitam `Idempotency-Key` este é o caso de
        reutilização de chave: a chave foi vista pela primeira vez com uma carga
        de solicitação diferente, então reproduzir o resultado armazenado
        responderia a uma pergunta que o chamador não fez.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: IDEMPOTENCY_KEY_REUSED
              message: >-
                This Idempotency-Key was already used with a different request
                payload
              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.