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

# Rename a component

> Rename an active component while reserving its previous exact name as an alias.



## OpenAPI

````yaml /openapi.json post /components/{componentId}/rename
openapi: 3.2.0
info:
  title: Sazabi Public API
  version: 1.0.0
  description: >
    Public REST API for Sazabi. Authenticate using a secret API key in the
    Authorization header.


    ## Pagination


    This API uses two pagination strategies depending on the endpoint type:


    ### Cursor-Based Pagination (List Endpoints)


    List endpoints (threads, messages, keys) use cursor-based pagination for
    efficient, consistent results:


    - **Parameters**: `limit` (items per page, default 50, max 100), `cursor`
    (opaque pagination token)

    - **Response**: Includes `nextCursor` field - pass this as `cursor` in the
    next request

    - **End of results**: When `nextCursor` is `null`, there are no more results

    - **Example**: `GET
    /v1/threads?limit=20&cursor=01234567-89ab-cdef-0123-456789abcdef`


    ### Page-Based Pagination (Search Endpoints)


    Search endpoints use page-based pagination due to the underlying search
    engine:


    - **Parameters**: `limit` (items per page, default 20, max 100), `page`
    (1-indexed page number)

    - **Response**: Includes `pagination` object with `page`, `limit`,
    `totalResults`, `totalPages`

    - **Example**: `GET /v1/search/threads?q=error&limit=10&page=2`
servers:
  - url: https://api.sazabi.com/v1
    description: Production
security: []
tags:
  - name: 'section: Send data'
    summary: Send data
    kind: nav
  - name: 'section: Detect issues'
    summary: Detect issues
    kind: nav
  - name: 'section: Triage issues'
    summary: Triage issues
    kind: nav
  - name: 'section: Ask Sazabi'
    summary: Ask Sazabi
    kind: nav
  - name: 'section: Explore logs'
    summary: Explore logs
    kind: nav
  - name: 'section: Ship fixes'
    summary: Ship fixes
    kind: nav
  - name: 'section: Integrations'
    summary: Integrations
    kind: nav
  - name: 'section: Organization and access'
    summary: Organization and access
    kind: nav
  - name: 'section: Billing'
    summary: Billing
    kind: nav
  - name: 'section: Webhooks and events'
    summary: Webhooks and events
    kind: nav
  - name: 'section: CLI onboarding support'
    summary: CLI onboarding support
    kind: nav
  - name: Log Sources
    summary: Log Sources
    kind: nav
    parent: 'section: Send data'
  - name: Log Streams
    summary: Log Streams
    kind: nav
    parent: 'section: Send data'
  - name: Public Keys
    summary: Public Keys
    kind: nav
    parent: 'section: Send data'
  - name: Signals
    summary: Signals
    kind: nav
    parent: 'section: Detect issues'
  - name: Issues
    summary: Issues
    kind: nav
    parent: 'section: Triage issues'
  - name: Components
    summary: Components
    kind: nav
    parent: 'section: Triage issues'
  - name: Notification delivery rules
    summary: Notification delivery rules
    kind: nav
    parent: 'section: Triage issues'
  - name: Notification channels
    summary: Notification channels
    kind: nav
    parent: 'section: Triage issues'
  - name: Tasks
    summary: Tasks
    kind: nav
    parent: 'section: Triage issues'
  - name: Task creation rules
    summary: Task creation rules
    kind: nav
    parent: 'section: Triage issues'
  - name: Task status mapping
    summary: Task status mapping
    kind: nav
    parent: 'section: Triage issues'
  - name: Work Items
    summary: Work Items
    kind: nav
    parent: 'section: Triage issues'
  - name: Threads
    summary: Threads
    kind: nav
    parent: 'section: Ask Sazabi'
  - name: Messages
    summary: Messages
    kind: nav
    parent: 'section: Ask Sazabi'
  - name: Runs
    summary: Runs
    kind: nav
    parent: 'section: Ask Sazabi'
  - name: Search
    summary: Search
    kind: nav
    parent: 'section: Ask Sazabi'
  - name: Memory
    summary: Memory
    kind: nav
    parent: 'section: Ask Sazabi'
  - name: Artifacts
    summary: Artifacts
    kind: nav
    parent: 'section: Ask Sazabi'
  - name: Tool permissions
    summary: Tool permissions
    kind: nav
    parent: 'section: Ask Sazabi'
  - name: Sandbox Environment Variables
    summary: Sandbox Environment Variables
    kind: nav
    parent: 'section: Ask Sazabi'
  - name: Sandbox Init Script
    summary: Sandbox Init Script
    kind: nav
    parent: 'section: Ask Sazabi'
  - name: Logs
    summary: Logs
    kind: nav
    parent: 'section: Explore logs'
  - name: Dashboards
    summary: Dashboards
    kind: nav
    parent: 'section: Explore logs'
  - name: AgentDispatches
    summary: AgentDispatches
    kind: nav
    parent: 'section: Ship fixes'
  - name: Pull Requests
    summary: Pull Requests
    kind: nav
    parent: 'section: Ship fixes'
  - name: Repos
    summary: Repos
    kind: nav
    parent: 'section: Ship fixes'
  - name: Integrations
    summary: Integrations
    kind: nav
    parent: 'section: Integrations'
  - name: MCP Connectors
    summary: MCP Connectors
    kind: nav
    parent: 'section: Integrations'
  - name: Connected Accounts
    summary: Connected Accounts
    kind: nav
    parent: 'section: Integrations'
  - name: Sandbox CLIs
    summary: Sandbox CLIs
    kind: nav
    parent: 'section: Integrations'
  - name: Auth
    summary: Auth
    kind: nav
    parent: 'section: Organization and access'
  - name: Organizations
    summary: Organizations
    kind: nav
    parent: 'section: Organization and access'
  - name: Projects
    summary: Projects
    kind: nav
    parent: 'section: Organization and access'
  - name: Members
    summary: Members
    kind: nav
    parent: 'section: Organization and access'
  - name: Teams
    summary: Teams
    kind: nav
    parent: 'section: Organization and access'
  - name: SSO
    summary: SSO
    kind: nav
    parent: 'section: Organization and access'
  - name: Secret Keys
    summary: Secret Keys
    kind: nav
    parent: 'section: Organization and access'
  - name: Support Tickets
    summary: Support Tickets
    kind: nav
    parent: 'section: Organization and access'
  - name: Billing
    summary: Billing
    kind: nav
    parent: 'section: Billing'
  - name: Webhooks
    summary: Webhooks
    kind: nav
    parent: 'section: Webhooks and events'
  - name: Webhook events
    summary: Webhook events
    kind: nav
    parent: 'section: Webhooks and events'
  - name: Onboarding
    summary: Onboarding
    kind: nav
    parent: 'section: CLI onboarding support'
  - name: Onboarding Tasks
    summary: Onboarding Tasks
    kind: nav
    parent: 'section: CLI onboarding support'
  - name: Recommendations
    summary: Recommendations
    kind: nav
    parent: 'section: CLI onboarding support'
paths:
  /components/{componentId}/rename:
    post:
      tags:
        - Components
      summary: Rename a component
      description: >-
        Rename an active component while reserving its previous exact name as an
        alias.
      operationId: components.rename
      parameters:
        - name: componentId
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Active component ID to rename.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                requestId:
                  type: string
                  format: uuid
                  description: Project-scoped idempotency key for this exact rename.
                reason:
                  type: string
                  minLength: 1
                  description: Customer-visible audit reason for renaming the component.
              required:
                - name
                - requestId
                - reason
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  component:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      projectId:
                        type: string
                        format: uuid
                      name:
                        type: string
                      slug:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: >-
                          Canonical machine identifier (lower-case [a-z0-9._-]),
                          or null when not assigned.
                      description:
                        anyOf:
                          - type: string
                          - type: 'null'
                      teamId:
                        anyOf:
                          - type: string
                            format: uuid
                          - type: 'null'
                        description: >-
                          Owning team ID, or null when the component is
                          unassigned.
                      teamName:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: >-
                          Owning team name, or null when the component is
                          unassigned.
                      origin:
                        enum:
                          - user_declared
                          - code_detected
                          - log_observed
                        type: string
                      lifecycle:
                        enum:
                          - active
                          - inactive
                          - merged
                        type: string
                      observationState:
                        enum:
                          - observed
                          - stale
                          - unobserved
                        type: string
                      registryRevision:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      canonicalComponentId:
                        type: string
                        format: uuid
                      mergedIntoComponentId:
                        anyOf:
                          - type: string
                            format: uuid
                          - type: 'null'
                      currentStatus:
                        enum:
                          - operational
                          - degraded
                          - outage
                        type: string
                        description: Current health status of this component.
                      firstSeenAt:
                        type: string
                        format: date-time
                      lastSeenAt:
                        type: string
                        format: date-time
                      deletedAt:
                        anyOf:
                          - type: string
                            format: date-time
                          - type: 'null'
                        description: >-
                          Timestamp when this component became inactive or was
                          deleted, if any.
                      inactiveAt:
                        anyOf:
                          - type: string
                            format: date-time
                          - type: 'null'
                        description: Timestamp when this component became inactive, if any.
                      inactiveReason:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: Reason recorded when this component became inactive.
                      legacyStateUnknown:
                        type: boolean
                        description: >-
                          True only for migration-era inactive rows whose
                          deactivation authority is unknown.
                    required:
                      - id
                      - projectId
                      - name
                      - slug
                      - description
                      - teamId
                      - teamName
                      - origin
                      - lifecycle
                      - observationState
                      - registryRevision
                      - canonicalComponentId
                      - mergedIntoComponentId
                      - currentStatus
                      - firstSeenAt
                      - lastSeenAt
                      - deletedAt
                      - inactiveAt
                      - inactiveReason
                      - legacyStateUnknown
                required:
                  - component

````

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