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

# Rename a team

> Changes the team's display name; the team id and home region never
change. Requires the `settings:write` permission. Renaming to the
current name succeeds without recording an audit event. Names are
unique within a region: a name already in use returns `409` with code
`team_name_unavailable`.




## OpenAPI

````yaml https://api.superserve.ai/openapi.yaml patch /teams/{team_id}
openapi: 3.1.0
info:
  title: Superserve API
  version: 0.1.0
  description: >
    Superserve provides sandbox infrastructure to run AI agents in the cloud.
    Powered by Firecracker MicroVMs.


    ## Sandbox lifecycle


    ```

    active <--> paused --> deleted

    ```


    A sandbox is `active` when running and `paused` after being paused. Resuming

    a paused sandbox returns it to `active`. Deleting releases all resources.


    | Endpoint | What it does |

    |----------|-------------|

    | `POST /sandboxes` | Create a new sandbox (optionally `from_template`) |

    | `PATCH /sandboxes/:id` | Partially update a running sandbox (e.g. network
    rules) |

    | `POST /sandboxes/:id/pause` | Snapshot full state, suspend the VM |

    | `POST /sandboxes/:id/resume` | Restore from snapshot, continue where it
    left off |

    | `DELETE /sandboxes/:id` | Delete sandbox and all resources |


    ## Sandbox environment


    By default sandboxes boot from the curated `superserve/base` template
    (Ubuntu 24.04,

    1 vCPU, 1 GB RAM, 8 GB disk, with Python 3.12, Node.js 22, npm, git, curl,

    and build-essential pre-installed). Callers can override with any template

    name (e.g. `superserve/python-3.11`, `superserve/node-22`) or a team-owned
    template UUID

    via the `from_template` field on `POST /sandboxes`.


    ## Files and commands


    `/files`, `/exec`, and `/exec/stream` run against a single sandbox and use

    its `X-Access-Token` (returned by create, resume, and activate), not the

    team API key. Two host forms reach them:


    - `https://sandbox.superserve.ai/...` with `X-Superserve-Sandbox-Id:
    <sandbox_id>`.

    - `https://boxd-{sandbox_id}.sandbox.superserve.ai/...` — no routing header
    needed.
  contact:
    name: Superserve Team
  license:
    name: Proprietary
servers:
  - url: https://api.superserve.ai
    description: Production
security: []
paths:
  /teams/{team_id}:
    parameters:
      - name: team_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    patch:
      tags:
        - RBAC
      summary: Rename a team
      description: |
        Changes the team's display name; the team id and home region never
        change. Requires the `settings:write` permission. Renaming to the
        current name succeeds without recording an audit event. Names are
        unique within a region: a name already in use returns `409` with code
        `team_name_unavailable`.
      operationId: renameTeam
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 64
                  description: Trimmed before validation; control characters are rejected.
              required:
                - name
      responses:
        '200':
          description: Team renamed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamRenameResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
      security:
        - apiKey: []
components:
  schemas:
    TeamRenameResponse:
      type: object
      required:
        - id
        - name
        - home_region
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        home_region:
          type: string
    Error:
      type: object
      description: >
        Error envelope. `error.code` is a stable, machine-readable identifier

        (e.g. `bad_request`, `not_found`, `conflict`, `sandbox_pausing`,

        `rate_limited`, `too_many_builds`, `too_many_templates`,
        `too_many_sandboxes`,

        `image_pull_failed`, `step_failed`, `snapshot_failed`,

        `start_cmd_failed`, `ready_cmd_failed`, `capacity_unavailable`,

        `build_timed_out`, `infrastructure_failed`, `build_failed`).

        `error.message` is human-readable and may change between releases;

        clients should branch on `code`, not `message`.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Caller is authenticated but not allowed to perform the action
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Conflict:
      description: Operation conflicts with the resource's current state
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key

````

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