Portainer

Portainer Auth API

Authenticate against Portainer HTTP API

GitHub OpenAPI

Operations 3

POST /auth Authenticate #
POST /auth/logout Logout #
POST /auth/oauth/validate Authenticate with OAuth #

Documentation

📖
Documentation
https://docs.portainer.io/
📖
APIReference
https://api-docs.portainer.io/
📖
GettingStarted
https://docs.portainer.io/start

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/openapi/portainer-auth-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-auth-authenticate-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-auth-authenticate-payload-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-auth-oauth-payload-schema.json

Other Resources

🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/apis.yml

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-auth-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

portainer-auth-api-openapi.yml Raw ↑ 
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 Auth API
  version: 2.39.1
servers:
- url: /api
tags:
- description: Authenticate against Portainer HTTP API
  name: Auth
paths:
  /auth:
    post:
      description: '**Access policy**: public

        Use this environment(endpoint) to authenticate against Portainer using a username and password.'
      operationId: AuthenticateUser
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/auth.authenticateResponse'
        '400':
          description: Invalid request
        '422':
          description: Invalid Credentials
        '500':
          description: Server error
      summary: Authenticate
      tags:
      - Auth
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/auth.authenticatePayload'
        description: Credentials used for authentication
        required: true
  /auth/logout:
    post:
      description: '**Access policy**: public'
      operationId: Logout
      responses:
        '204':
          description: Success
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Logout
      tags:
      - Auth
  /auth/oauth/validate:
    post:
      description: '**Access policy**: public'
      operationId: ValidateOAuth
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/auth.authenticateResponse'
        '400':
          description: Invalid request
        '422':
          description: Invalid Credentials
        '500':
          description: Server error
      summary: Authenticate with OAuth
      tags:
      - Auth
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/auth.oauthPayload'
        description: OAuth Credentials used for authentication
        required: true
components:
  schemas:
    auth.authenticatePayload:
      properties:
        Password:
          description: Password
          example: mypassword
          type: string
        Username:
          description: Username
          example: admin
          type: string
      required:
      - Password
      - Username
      type: object
    auth.oauthPayload:
      properties:
        Code:
          description: OAuth code returned from OAuth Provided
          type: string
      type: object
    auth.authenticateResponse:
      properties:
        jwt:
          description: JWT token used to authenticate against the API
          example: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyzAB
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey
    jwt:
      in: header
      name: Authorization
      type: apiKey