Portainer

Portainer Docker API

Manage Docker resources

Documentation GitHub OpenAPI

Operations 3

GET /docker/{environmentId}/containers/{containerId}/gpus Fetch container gpus data #

GET /docker/{environmentId}/dashboard Get counters for the dashboard #

GET /docker/{environmentId}/images Fetch images #

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:portainer-docker-api"

All apis

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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 Docker API
  version: 2.39.1
servers:
- url: /api
tags:
- description: Manage Docker resources
  name: docker
paths:
  /docker/{environmentId}/containers/{containerId}/gpus:
    get:
      description: '**Access policy**:'
      operationId: dockerContainerGpusInspect
      parameters:
      - description: Environment identifier
        in: path
        name: environmentId
        required: true
        schema:
          type: integer
      - description: Container identifier
        in: path
        name: containerId
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/containers.containerGpusResponse'
        '400':
          description: Bad request
        '404':
          description: Environment or container not found
        '500':
          description: Internal server error
      security:
      - jwt: []
      summary: Fetch container gpus data
      tags:
      - docker
  /docker/{environmentId}/dashboard:
    get:
      description: '**Access policy**: restricted'
      operationId: dockerDashboard
      parameters:
      - description: Environment identifier
        in: path
        name: environmentId
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/docker.dashboardResponse'
        '400':
          description: Bad request
        '500':
          description: Internal server error
      security:
      - jwt: []
      summary: Get counters for the dashboard
      tags:
      - docker
  /docker/{environmentId}/images:
    get:
      description: '**Access policy**:'
      operationId: dockerImagesList
      parameters:
      - description: Environment identifier
        in: path
        name: environmentId
        required: true
        schema:
          type: integer
      - description: Include image usage information
        in: query
        name: withUsage
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/images.ImageResponse'
                type: array
        '400':
          description: Bad request
        '500':
          description: Internal server error
      security:
      - jwt: []
      summary: Fetch images
      tags:
      - docker
components:
  schemas:
    docker.dashboardResponse:
      properties:
        containers:
          $ref: '#/components/schemas/stats.ContainerStats'
        images:
          $ref: '#/components/schemas/docker.imagesCounters'
        networks:
          type: integer
        services:
          type: integer
        stacks:
          type: integer
        volumes:
          type: integer
      type: object
    stats.ContainerStats:
      properties:
        healthy:
          type: integer
        running:
          type: integer
        stopped:
          type: integer
        total:
          type: integer
        unhealthy:
          type: integer
      type: object
    containers.containerGpusResponse:
      properties:
        gpus:
          type: string
      type: object
    images.ImageResponse:
      properties:
        created:
          type: integer
        id:
          type: string
        nodeName:
          type: string
        size:
          type: integer
        tags:
          items:
            type: string
          type: array
        used:
          description: 'Used is true if the image is used by at least one container

            supplied only when withUsage is true'
          type: boolean
      type: object
    docker.imagesCounters:
      properties:
        size:
          type: integer
        total:
          type: integer
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey
    jwt:
      in: header
      name: Authorization
      type: apiKey