openapi: 3.2.0
info:
  title: Pebble system info API
  version: v1
tags:
- name: System Info
paths:
  /v1/system-info:
    get:
      summary: Get system information
      description: Get information about the Pebble daemon and the boot ID of the system.
      tags:
      - System Info
      responses:
        '200':
          description: System information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSystemInfoResponse'
              example:
                type: sync
                status-code: 200
                status: OK
                result:
                  boot-id: e14ed96e-5a98-4402-80f7-d19dd949eac3
                  http-address: :4000
                  https-address: :4443
                  version: v1.17.0
      operationId: getV1SystemInfo
      x-operation-id-source: derived
components:
  schemas:
    BaseResponse:
      type: object
      properties:
        type:
          type: string
          description: Response type, "sync".
        status-code:
          type: integer
          description: HTTP response status code.
        status:
          type: string
          description: 'The description of the HTTP status code.


            See the [IANA list](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml).

            '
    GetSystemInfoResponse:
      allOf:
      - $ref: '#/components/schemas/BaseResponse'
      - type: object
        properties:
          result:
            $ref: '#/components/schemas/systemInfo'
    systemInfo:
      type: object
      properties:
        boot-id:
          type: string
          description: A unique string that represents this boot of the server.
        http-address:
          type: string
          description: Address the HTTP server is listening on, for example `:4000`. Only present if the daemon was started with the `--http` argument.
        version:
          type: string
          description: Version of the Pebble daemon.
      required:
      - boot-id
      - version