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

# GET /admin/api/update



## OpenAPI

````yaml /generated/openapi.json get /admin/api/update
openapi: 3.1.0
info:
  description: >-
    Forwarding, management, portal and OAuth APIs generated from Rust types.
    Input and output schemas preserve their respective Serde contracts.
    Streaming events and WebSocket messages are documented alongside HTTP
    payloads.
  title: GPROXY HTTP API
  version: 4.2.1
servers: []
security:
  - bearer: []
  - anthropicKey: []
  - googleKey: []
  - queryKey: []
paths:
  /admin/api/update:
    get:
      tags:
        - Management
      summary: GET /admin/api/update
      parameters:
        - description: Administrative scope selected by the caller.
          in: header
          name: x-gproxy-admin-scope
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output_UpdateSchedule'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output_Envelope'
          description: Gateway error
      security:
        - consoleSession: []
        - bearer: []
        - anthropicKey: []
        - googleKey: []
components:
  schemas:
    Output_UpdateSchedule:
      description: >-
        What the scheduled check has found so far, and whether there is a
        schedule.
      properties:
        automatic:
          description: >-
            Whether this instance installs what it finds without being asked.

            **Off unless an operator turned it on**, and reported either way so
            a

            console can say which.
          type: boolean
        channel:
          type: string
        interval_secs:
          description: Seconds between checks, or `None` when checking is switched off.
          format: uint64
          minimum: 0
          type:
            - integer
            - 'null'
        last_check:
          anyOf:
            - $ref: '#/components/schemas/Output_UpdateReport'
            - type: 'null'
          description: |-
            The last completed check, or `None` when none has finished yet — a
            process that started a minute ago, or one whose every check failed.
        last_error:
          description: >-
            Why the last check failed, when one did and none has since
            succeeded.

            A console shows this rather than an empty panel that looks like "no

            update available".
          type:
            - string
            - 'null'
        source:
          type: string
        verify_signature:
          type: boolean
      required:
        - last_check
        - last_error
        - interval_secs
        - automatic
        - verify_signature
        - channel
        - source
      type: object
    Output_Envelope:
      properties:
        error:
          $ref: '#/components/schemas/Output_EnvelopeBody'
      required:
        - error
      type: object
    Output_UpdateReport:
      description: One check's answer.
      properties:
        available:
          description: Whether `latest` is actually newer than `current`.
          type: boolean
        channel:
          type: string
        checked_at_ms:
          description: When this check completed, in milliseconds since the epoch.
          format: int64
          type: integer
        current:
          description: The version this process is running.
          type: string
        latest:
          description: The version the manifest offers for this channel.
          type: string
        notes:
          description: >-
            The notes themselves, when the host could fetch them. Never
            required:

            a release with no readable notes is still a release.
          type:
            - string
            - 'null'
        notes_url:
          description: Where a human reads what changed. Straight from the manifest.
          type:
            - string
            - 'null'
        restart:
          description: |-
            What the host will do to the process after an apply: `none`,
            `supervisor` or `re-exec`.
          type: string
        rollback_available:
          description: Whether a previous executable is still on disk to go back to.
          type: boolean
        source:
          type: string
        target:
          description: |-
            The artifact key the manifest was searched for, e.g.
            `x86_64-unknown-linux-gnu`.
          type: string
      required:
        - current
        - latest
        - available
        - channel
        - source
        - target
        - notes_url
        - notes
        - restart
        - rollback_available
        - checked_at_ms
      type: object
    Output_EnvelopeBody:
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      type: object
  securitySchemes:
    bearer:
      scheme: bearer
      type: http
    anthropicKey:
      in: header
      name: x-api-key
      type: apiKey
    googleKey:
      in: header
      name: x-goog-api-key
      type: apiKey
    queryKey:
      in: query
      name: key
      type: apiKey
    consoleSession:
      in: cookie
      name: gproxy_session
      type: apiKey

````

## Related topics

- [GET /admin/api/update/progress](https://gproxy.leenhawk.com/api-reference/management/get-adminapiupdateprogress.md)
- [GET /admin/api/update/announcements](https://gproxy.leenhawk.com/api-reference/management/get-adminapiupdateannouncements.md)
- [POST /admin/api/update/apply](https://gproxy.leenhawk.com/api-reference/management/post-adminapiupdateapply.md)
- [POST /admin/api/update/check](https://gproxy.leenhawk.com/api-reference/management/post-adminapiupdatecheck.md)
- [POST /admin/api/update/rollback](https://gproxy.leenhawk.com/api-reference/management/post-adminapiupdaterollback.md)


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