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

# Preview updating a plugin

> Resolves the plugin's source again and reports the revision and commit it would move to and the MCP servers that update would add, remove or change. Writes nothing.



## OpenAPI

````yaml api-reference/openapi.v1.json POST /plugins/{pluginID}/update-preview
openapi: 3.1.0
info:
  title: Aether Public API
  version: 0.1.0
  description: >-
    The versioned, public Aether REST API. Authenticate with an `aether_`
    platform API key or a session token.
servers:
  - url: https://api.runaether.dev/v1
security:
  - bearerAuth: []
paths:
  /plugins/{pluginID}/update-preview:
    post:
      tags:
        - plugins
      summary: Preview updating a plugin
      description: >-
        Resolves the plugin's source again and reports the revision and commit
        it would move to and the MCP servers that update would add, remove or
        change. Writes nothing.
      operationId: previewPluginUpdate
      parameters:
        - in: path
          name: pluginID
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PluginUpdatePreviewResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/OrgAuthorizationErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/PluginErrorResponse'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable
components:
  schemas:
    PluginUpdatePreviewResponse:
      additionalProperties: false
      properties:
        update:
          $ref: '#/components/schemas/PluginUpdatePreview'
      required:
        - update
      type: object
    ErrorResponse:
      additionalProperties: false
      properties:
        code:
          type: string
        error:
          minLength: 1
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
      required:
        - error
      type: object
    OrgAuthorizationErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - org_membership_required
            - org_role_insufficient
            - org_suspended
            - account_deleting
          type: string
        error:
          minLength: 1
          type: string
      required:
        - error
        - code
      type: object
    PluginErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - plugin_request_invalid
            - plugin_source_address_refused
            - plugin_source_not_public
            - plugin_source_unreachable
            - plugin_source_not_found
            - plugin_source_unsupported
            - plugin_source_too_large
            - plugin_source_invalid
            - plugin_server_probe_failed
            - plugin_server_key_taken
            - plugin_name_taken
            - plugin_moved
            - plugin_update_conflicts_with_enablement
            - mcp_credential_policy_required
            - mcp_credential_policy_not_applicable
            - mcp_credential_policy_org_unavailable
          type: string
        conflicts:
          items:
            $ref: '#/components/schemas/PluginKeyHolder'
          type: array
        error:
          minLength: 1
          type: string
      required:
        - error
        - code
        - conflicts
      type: object
    PluginUpdatePreview:
      additionalProperties: false
      properties:
        added:
          items:
            discriminator:
              mapping:
                remote:
                  $ref: '#/components/schemas/PluginAddedRemoteServer'
                stdio_unavailable:
                  $ref: '#/components/schemas/PluginStdioServer'
              propertyName: kind
            oneOf:
              - $ref: '#/components/schemas/PluginAddedRemoteServer'
              - $ref: '#/components/schemas/PluginStdioServer'
          type: array
        changed_remote:
          items:
            $ref: '#/components/schemas/PluginRemoteServerChange'
          type: array
        changed_stdio:
          items:
            $ref: '#/components/schemas/PluginStdioServerChange'
          type: array
        commit:
          type: string
        needs_credential:
          type: boolean
        removed:
          items:
            type: string
          type: array
        revision:
          description: >-
            The installed plugin's revision: a digest of everything it took from
            its source.
          type: string
        support:
          $ref: '#/components/schemas/PluginSupport'
        to_commit:
          type: string
        to_revision:
          description: The revision its source resolves to now.
          type: string
      required:
        - revision
        - to_revision
        - commit
        - to_commit
        - added
        - removed
        - changed_remote
        - changed_stdio
        - needs_credential
        - support
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    PluginKeyHolder:
      additionalProperties: false
      properties:
        key:
          type: string
        plugin:
          type:
            - string
            - 'null'
        source:
          enum:
            - manual
            - aether
            - plugin
          type: string
      required:
        - key
        - source
        - plugin
      type: object
    PluginAddedRemoteServer:
      additionalProperties: false
      properties:
        auth:
          enum:
            - none
            - static_secret
            - oauth
          type: string
        key:
          type: string
        kind:
          enum:
            - remote
          type: string
        url:
          type: string
      required:
        - kind
        - key
        - url
        - auth
      type: object
    PluginStdioServer:
      additionalProperties: false
      properties:
        args:
          items:
            type: string
          type: array
        command:
          type: string
        key:
          type: string
        kind:
          enum:
            - stdio_unavailable
          type: string
      required:
        - kind
        - key
        - command
        - args
      type: object
    PluginRemoteServerChange:
      additionalProperties: false
      properties:
        drops_connections:
          description: >-
            A new URL or auth deletes the server's connections, each entered for
            the URL and auth it was connected to; new headers alone keep them.
          type: boolean
        from:
          $ref: '#/components/schemas/PluginRemoteServerConfig'
        key:
          type: string
        to:
          $ref: '#/components/schemas/PluginRemoteServerConfig'
      required:
        - key
        - from
        - to
        - drops_connections
      type: object
    PluginStdioServerChange:
      additionalProperties: false
      properties:
        from:
          $ref: '#/components/schemas/PluginStdioServerConfig'
        key:
          type: string
        to:
          $ref: '#/components/schemas/PluginStdioServerConfig'
      required:
        - key
        - from
        - to
      type: object
    PluginSupport:
      additionalProperties: false
      properties:
        claude_code:
          items:
            enum:
              - skills
              - commands
              - agents
              - hooks
              - mcp_servers
            type: string
          type: array
        codex:
          items:
            enum:
              - skills
              - commands
              - agents
              - hooks
              - mcp_servers
            type: string
          type: array
      required:
        - claude_code
        - codex
      type: object
    PluginRemoteServerConfig:
      additionalProperties: false
      properties:
        auth:
          enum:
            - none
            - static_secret
            - oauth
          type: string
        headers:
          additionalProperties:
            type: string
          description: The headers the plugin sets on every request.
          type: object
        url:
          type: string
      required:
        - url
        - headers
        - auth
      type: object
    PluginStdioServerConfig:
      additionalProperties: false
      properties:
        args:
          items:
            type: string
          type: array
        command:
          type: string
        env:
          additionalProperties:
            type: string
          type: object
      required:
        - command
        - args
        - env
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````