Portainer

Portainer System API

Manage Portainer system

Documentation GitHub OpenAPI

Operations 5

GET /system/info Retrieve system info #

GET /system/nodes Retrieve the count of nodes #

GET /system/status Check Portainer status #

POST /system/upgrade Upgrade Portainer to BE #

GET /system/version Check for portainer updates #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/portainer-system-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  contact:
    email: info@portainer.io
  description: Portainer API is an HTTP API served by Portainer.
  license:
    name: zlib
    url: https://github.com/portainer/portainer/blob/develop/LICENSE
  title: PortainerCE System API
  version: 2.39.1
servers:
- url: /api
tags:
- description: Manage Portainer system
  name: System
paths:
  /system/info:
    get:
      description: '**Access policy**: authenticated'
      operationId: systemInfo
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/system.systemInfoResponse'
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Retrieve system info
      tags:
      - System
  /system/nodes:
    get:
      description: '**Access policy**: authenticated'
      operationId: systemNodesCount
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/system.nodesCountResponse'
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Retrieve the count of nodes
      tags:
      - System
  /system/status:
    get:
      description: 'Retrieve Portainer status

        **Access policy**: public'
      operationId: systemStatus
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/system.status'
      summary: Check Portainer status
      tags:
      - System
  /system/upgrade:
    post:
      description: 'Upgrade Portainer to BE

        **Access policy**: administrator'
      operationId: systemUpgrade
      responses:
        '204':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/system.status'
      summary: Upgrade Portainer to BE
      tags:
      - System
  /system/version:
    get:
      description: 'Check if portainer has an update available

        **Access policy**: authenticated'
      operationId: systemVersion
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/system.versionResponse'
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Check for portainer updates
      tags:
      - System
components:
  schemas:
    platform.ContainerPlatform:
      enum:
      - Docker
      - Docker Standalone
      - Docker Swarm
      - Kubernetes
      - Podman
      type: string
      x-enum-varnames:
      - PlatformDocker
      - PlatformDockerStandalone
      - PlatformDockerSwarm
      - PlatformKubernetes
      - PlatformPodman
    build.BuildInfo:
      properties:
        BuildNumber:
          type: string
        GitCommit:
          type: string
        GoVersion:
          type: string
        ImageTag:
          type: string
        NodejsVersion:
          type: string
        PnpmVersion:
          type: string
        WebpackVersion:
          type: string
      type: object
    system.nodesCountResponse:
      properties:
        nodes:
          type: integer
      type: object
    build.DependenciesInfo:
      properties:
        ComposeVersion:
          type: string
        DockerVersion:
          type: string
        HelmVersion:
          type: string
        KubectlVersion:
          type: string
      type: object
    system.versionResponse:
      properties:
        Build:
          $ref: '#/components/schemas/build.BuildInfo'
        DatabaseVersion:
          type: string
        Dependencies:
          $ref: '#/components/schemas/build.DependenciesInfo'
        LatestVersion:
          description: The latest version available
          example: 2.0.0
          type: string
        Runtime:
          $ref: '#/components/schemas/build.RuntimeInfo'
        ServerEdition:
          example: CE/EE
          type: string
        ServerVersion:
          type: string
        UpdateAvailable:
          description: Whether portainer has an update available
          example: false
          type: boolean
        VersionSupport:
          example: STS/LTS
          type: string
      type: object
    system.systemInfoResponse:
      properties:
        agents:
          type: integer
        edgeAgents:
          type: integer
        platform:
          $ref: '#/components/schemas/platform.ContainerPlatform'
      type: object
    build.RuntimeInfo:
      properties:
        Env:
          items:
            type: string
          type: array
      type: object
    system.status:
      properties:
        InstanceID:
          description: Server Instance ID
          example: 299ab403-70a8-4c05-92f7-bf7a994d50df
          type: string
        Version:
          description: Portainer API version
          example: 2.0.0
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey
    jwt:
      in: header
      name: Authorization
      type: apiKey