Portainer

Portainer Ldap API

Manage LDAP settings

Documentation GitHub OpenAPI

Operations 1

POST /ldap/check Test LDAP connectivity #

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-ldap-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 Ldap API
  version: 2.39.1
servers:
- url: /api
tags:
- description: Manage LDAP settings
  name: LDAP
paths:
  /ldap/check:
    post:
      description: 'Test LDAP connectivity using LDAP details

        **Access policy**: administrator'
      operationId: LDAPCheck
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Test LDAP connectivity
      tags:
      - LDAP
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ldap.checkPayload'
        description: details
        required: true
components:
  schemas:
    portainer.TLSConfiguration:
      properties:
        TLS:
          description: Use TLS
          example: true
          type: boolean
        TLSCACert:
          description: Path to the TLS CA certificate file
          example: /data/tls/ca.pem
          type: string
        TLSCert:
          description: Path to the TLS client certificate file
          example: /data/tls/cert.pem
          type: string
        TLSKey:
          description: Path to the TLS client key file
          example: /data/tls/key.pem
          type: string
        TLSSkipVerify:
          description: Skip the verification of the server TLS certificate
          example: false
          type: boolean
      type: object
    portainer.LDAPSearchSettings:
      properties:
        BaseDN:
          description: The distinguished name of the element from which the LDAP server will search for users
          example: dc=ldap,dc=domain,dc=tld
          type: string
        Filter:
          description: Optional LDAP search filter used to select user elements
          example: (objectClass=account)
          type: string
        UserNameAttribute:
          description: LDAP attribute which denotes the username
          example: uid
          type: string
      type: object
    ldap.checkPayload:
      properties:
        LDAPSettings:
          $ref: '#/components/schemas/portainer.LDAPSettings'
      type: object
    portainer.LDAPGroupSearchSettings:
      properties:
        GroupAttribute:
          description: LDAP attribute which denotes the group membership
          example: member
          type: string
        GroupBaseDN:
          description: The distinguished name of the element from which the LDAP server will search for groups
          example: dc=ldap,dc=domain,dc=tld
          type: string
        GroupFilter:
          description: The LDAP search filter used to select group elements, optional
          example: (objectClass=account
          type: string
      type: object
    portainer.LDAPSettings:
      properties:
        AnonymousMode:
          description: Enable this option if the server is configured for Anonymous access. When enabled, ReaderDN and Password will not be used
          example: true
          type: boolean
        AutoCreateUsers:
          description: Automatically provision users and assign them to matching LDAP group names
          example: true
          type: boolean
        GroupSearchSettings:
          items:
            $ref: '#/components/schemas/portainer.LDAPGroupSearchSettings'
          type: array
        Password:
          description: Password of the account that will be used to search users
          example: readonly-password
          type: string
        ReaderDN:
          description: Account that will be used to search for users
          example: cn=readonly-account,dc=ldap,dc=domain,dc=tld
          type: string
        SearchSettings:
          items:
            $ref: '#/components/schemas/portainer.LDAPSearchSettings'
          type: array
        StartTLS:
          description: Whether LDAP connection should use StartTLS
          example: true
          type: boolean
        TLSConfig:
          $ref: '#/components/schemas/portainer.TLSConfiguration'
        URL:
          description: URL or IP address of the LDAP server
          example: myldap.domain.tld:389
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey
    jwt:
      in: header
      name: Authorization
      type: apiKey