Portainer

Portainer Status API

Information about the Portainer instance

Documentation GitHub OpenAPI

Operations 1

GET /status Check Portainer status #

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-status-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 Status API
  version: 2.39.1
servers:
- url: /api
tags:
- description: Information about the Portainer instance
  name: Status
paths:
  /status:
    get:
      deprecated: true
      description: 'Deprecated: use the `/system/status` endpoint instead.

        Retrieve Portainer status

        **Access policy**: public'
      operationId: StatusInspect
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/system.status'
      summary: Check Portainer status
      tags:
      - Status
components:
  schemas:
    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