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

# Change the globally unique frontend path slug.

> 
    Atomically reserves the requested slug, checks for collisions and updates
    the global instance configuration using optimistic version control.
    Real changes are limited to one every 30 days and append an immutable audit
    event in the same transaction.
    Only activeUrl returned by this operation is the canonical working frontend
    link. Earlier slugs remain reserved for this instance but are not aliases.

    ROLES: INSTANCE_ADMIN
    USER: true
    SERVICE ACCOUNT: true
    



## OpenAPI

````yaml /api-reference/openapi.json put /api/v1/config/instance/slug
openapi: 3.0.0
info:
  title: RevoEngine Platform API
  description: Official RevoEngine Platform API documentation.
  version: 1.5.8
  contact:
    name: Support
    email: support@revoengine.com
  termsOfService: https://docs.revoengine.com/tos
servers:
  - url: https://api.revoengine.com
    description: Production
security: []
tags:
  - name: Accounts
    description: Users, service accounts, API keys, status, and platform access.
    externalDocs:
      description: Identity and access guide
      url: https://docs.revoengine.com/operate/identity-and-access
  - name: Activity
    description: Snapshot-backed activity and version history.
    externalDocs:
      description: Observability guide
      url: https://docs.revoengine.com/operate/observability
  - name: Agent Memory
    description: Administrative access to durable Agent memory.
    externalDocs:
      description: Agent memory and workspaces guide
      url: https://docs.revoengine.com/ai/memory-and-workspaces
  - name: Agent Plugins
    description: Agent plugin definitions, synchronization, testing, and lifecycle.
    externalDocs:
      description: Agent plugins guide
      url: https://docs.revoengine.com/ai/plugins
  - name: Agents
    description: >-
      Agent definitions, runs, sessions, inboxes, memory, tools, workspaces, and
      lifecycle.
    externalDocs:
      description: Autonomous Agents guide
      url: https://docs.revoengine.com/ai/agents
  - name: Assistant
    description: >-
      Assistant threads, messages, responses, goals, reports, sharing,
      attachments, and control.
    externalDocs:
      description: Assistant guide
      url: https://docs.revoengine.com/ai/assistant
  - name: Automation
    description: >-
      Jobs, templates, schedules, events, webhooks, execution history, and
      lifecycle.
    externalDocs:
      description: Automation guide
      url: https://docs.revoengine.com/operate/automation
  - name: Chat
    description: Collaborative chat threads, messages, reactions, uploads, and attachments.
    externalDocs:
      description: Team Chat guide
      url: https://docs.revoengine.com/operate/chat
  - name: Component deployments
    description: >-
      Custom Node.js runtime deployment attempts, readiness, activation, and
      rollback.
    externalDocs:
      description: Custom Node.js guide
      url: https://docs.revoengine.com/build/custom-nodejs
  - name: Components
    description: Components, elements, versions, validation, activation, and lifecycle.
    externalDocs:
      description: Components guide
      url: https://docs.revoengine.com/build/components
  - name: Config
    description: Instance configuration, usage, logs, and cache administration.
    externalDocs:
      description: Instance settings guide
      url: https://docs.revoengine.com/platform/instance-settings
  - name: Database Cache
    description: Instance Database cache values and statistics.
    externalDocs:
      description: Database Cache guide
      url: https://docs.revoengine.com/operate/database-cache
  - name: Database Views
    description: Database Views, previews, refreshes, exports, and controlled data actions.
    externalDocs:
      description: Database Views guide
      url: https://docs.revoengine.com/operate/database-views
  - name: Databases
    description: Database definitions, data, audits, exports, cloning, and lifecycle.
    externalDocs:
      description: Databases guide
      url: https://docs.revoengine.com/operate/databases
  - name: Endpoints
    description: >-
      Endpoint definitions, activation, validation, generated OpenAPI, and
      statistics.
    externalDocs:
      description: Endpoints guide
      url: https://docs.revoengine.com/operate/endpoints
  - name: Files
    description: Compatibility file listing, preview, download, and deletion operations.
    externalDocs:
      description: Files compatibility guide
      url: https://docs.revoengine.com/operate/files
  - name: Groups
    description: Groups, membership, avatars, and lifecycle.
    externalDocs:
      description: Groups guide
      url: https://docs.revoengine.com/operate/groups
  - name: Me
    description: Current user profile, keys, avatar, and session information.
    externalDocs:
      description: Authentication guide
      url: https://docs.revoengine.com/developers/authentication
  - name: Preferences
    description: User and instance preference values.
    externalDocs:
      description: Platform UI guide
      url: https://docs.revoengine.com/platform/ui-tour
  - name: Role Groups
    description: Role groups, members, assigned roles, and lifecycle.
    externalDocs:
      description: Permissions guide
      url: https://docs.revoengine.com/operate/permissions
  - name: Roles
    description: Available platform roles and role details.
    externalDocs:
      description: Permissions guide
      url: https://docs.revoengine.com/operate/permissions
  - name: Search
    description: Cross-domain search over objects visible to the caller.
    externalDocs:
      description: Search and discovery guide
      url: https://docs.revoengine.com/platform/search
  - name: Secrets
    description: >-
      Secret definitions, revisions, activation, reveal, disable, and
      destruction.
    externalDocs:
      description: Secrets guide
      url: https://docs.revoengine.com/operate/secrets
  - name: Share
    description: >-
      Short-lived authenticated links to supported application routes and grid
      state.
    externalDocs:
      description: Platform API share-link guide
      url: >-
        https://docs.revoengine.com/developers/platform-api#share-application-context
  - name: Storage
    description: >-
      Storage workspaces, folders, objects, upload sessions, signed access, and
      lifecycle.
    externalDocs:
      description: Storage guide
      url: https://docs.revoengine.com/operate/storage
externalDocs:
  description: Documentation
  url: https://docs.revoengine.com
paths:
  /api/v1/config/instance/slug:
    put:
      tags:
        - Config
      summary: Change the globally unique frontend path slug.
      description: |2-

            Atomically reserves the requested slug, checks for collisions and updates
            the global instance configuration using optimistic version control.
            Real changes are limited to one every 30 days and append an immutable audit
            event in the same transaction.
            Only activeUrl returned by this operation is the canonical working frontend
            link. Earlier slugs remain reserved for this instance but are not aliases.

            ROLES: INSTANCE_ADMIN
            USER: true
            SERVICE ACCOUNT: true
            
      operationId: ConfigController_updateInstanceSlug
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateInstanceSlugDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateInstanceSlugResponseDto'
        '409':
          description: >-
            The slug is reserved by another instance, the supplied version is
            stale or the 30-day cooldown is active.
      security:
        - bearer: []
components:
  schemas:
    UpdateInstanceSlugDto:
      type: object
      properties:
        slug:
          type: string
          description: >-
            New globally unique frontend path identifier. The returned activeUrl
            is the only canonical link after the update. Previously used slugs
            remain reserved for this instance but are not active aliases. After
            activation, another change is blocked for 30 days.
          example: tenant-production
          minLength: 6
          maxLength: 30
          pattern: ^[a-z][a-z0-9-]{4,28}[a-z0-9]$
        acknowledgeUrlChange:
          type: boolean
          description: >-
            Must be true to confirm that earlier slug links will stop resolving
            and another real slug change will be blocked for 30 days.
          example: true
          enum:
            - true
        version:
          type: number
          description: >-
            Current global instance configuration version used for optimistic
            concurrency control.
          example: 12
          minimum: 0
      required:
        - slug
        - acknowledgeUrlChange
        - version
    UpdateInstanceSlugResponseDto:
      type: object
      properties:
        instanceId:
          type: string
          description: >-
            Internal instance UUID. API authorization and backend state continue
            to use this identifier.
          example: 159836b3-a831-4c8c-bb7d-c9b91b455a7c
        slug:
          type: string
          description: Current frontend path identifier after the transaction commits.
          example: tenant-production
        previousSlug:
          type: string
          description: Previous active slug, or null when the instance did not have one.
          example: tenant-stage
          nullable: true
        activeUrl:
          type: string
          description: >-
            Canonical frontend link that is active after the update. Earlier
            slug links are not aliases and stop resolving.
          example: https://app.revoengine.com/tenant-production
        slugChangedAt:
          type: string
          description: >-
            Timestamp when this slug became active, or null when an unchanged
            legacy slug has no recorded activation time.
          example: '2026-09-18T10:00:00.000Z'
          format: date-time
          nullable: true
        nextSlugChangeAt:
          type: string
          description: >-
            Earliest timestamp at which another slug change is allowed, or null
            when no cooldown has started.
          example: '2026-10-18T10:00:00.000Z'
          format: date-time
          nullable: true
        version:
          type: number
          description: Global instance configuration version after the update.
          example: 13
      required:
        - instanceId
        - slug
        - previousSlug
        - activeUrl
        - slugChangedAt
        - nextSlugChangeAt
        - version
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      description: Bearer JWT token or API Key (sk-*).
      type: http

````