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

# Upgrade one host

> Requires `host.upgrade`. Records the desired version and pushes it to the host if connected; an offline host receives it on reconnect. Idempotent — a host already on the target is a no-op.




## OpenAPI

````yaml /custos/openapi.yaml post /hosts/{id}/upgrade
openapi: 3.1.0
info:
  title: Custos control-plane API
  version: 0.1.0
  description: >
    Seed specification. The auth, identity, key, host-list, and grant endpoints
    below are

    complete; the remaining control-plane endpoints are still being transcribed.
servers:
  - url: https://custos.example.com
    description: Your control plane
security:
  - bearerAuth: []
tags:
  - name: Auth
    description: Login, token refresh, and logout.
  - name: Identity
    description: The authenticated user.
  - name: Keys
    description: A user's SSH public keys.
  - name: Credentials
    description: Stored secrets, sealed at rest and audited on every read.
  - name: Permission requests
    description: Time-boxed access requests for gated credentials.
  - name: Sets
    description: >-
      Secret sets — an app's .env, either deployable (private) or team-shared
      (public).
  - name: Hosts
    description: Enrolled machines.
  - name: Health
    description: Liveness and readiness probes.
  - name: Notifications
    description: In-app notifications for the signed-in user.
  - name: Rotation reviews
    description: Credential rotation checklists raised when a user is suspended or removed.
  - name: Audit
    description: Install-wide trails.
  - name: Users
    description: Accounts and their lifecycle.
  - name: Invitations
    description: Onboarding new accounts.
  - name: Groups
    description: Resource groups — a grant on a group cascades to everything in it.
  - name: Grants
    description: Permission grants.
  - name: Enrollment
    description: Admitting a machine to the fleet. Daemon-facing.
  - name: Upgrades
    description: Rolling the daemon fleet forward.
paths:
  /hosts/{id}/upgrade:
    post:
      tags:
        - Upgrades
      summary: Upgrade one host
      description: >
        Requires `host.upgrade`. Records the desired version and pushes it to
        the host if connected; an offline host receives it on reconnect.
        Idempotent — a host already on the target is a no-op.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - version
              properties:
                version:
                  type: string
                  pattern: ^v[0-9]+\.[0-9]+\.[0-9]+$
                  examples:
                    - v1.2.3
      responses:
        '200':
          description: What happened for this host
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeOutcome'
        '400':
          description: Version does not look like vX.Y.Z
        '403':
          description: Missing `host.upgrade`
        '404':
          description: Not found
        '409':
          description: Host not active
        '422':
          description: That release does not exist, or is incomplete
        '502':
          description: Release catalog unreachable
components:
  schemas:
    UpgradeOutcome:
      type: object
      properties:
        host_id:
          type: string
          format: uuid
        hostname:
          type: string
        outcome:
          type: string
          enum:
            - pushed
            - already-current
            - offline-queued
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        An opaque access token from /login or /refresh. Tokens are checked
        against the database on every request, so revocation is immediate.

````

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