Portainer Roles API

Manage roles

Operations 1

GET /roles List roles #

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-roles-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.

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

OpenAPI Specification

portainer-roles-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 Roles API
  version: 2.39.1
servers:
- url: /api
tags:
- description: Manage roles
  name: Roles
paths:
  /roles:
    get:
      description: 'List all roles available for use

        **Access policy**: administrator'
      operationId: RoleList
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/portainer.Role'
                type: array
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: List roles
      tags:
      - Roles
components:
  schemas:
    portainer.Role:
      properties:
        Authorizations:
          allOf:
          - $ref: '#/components/schemas/portainer.Authorizations'
          description: Authorizations associated to a role
        Description:
          description: Role description
          example: Read-only access of all resources in an environment(endpoint)
          type: string
        Id:
          description: Role Identifier
          example: 1
          type: integer
        Name:
          description: Role name
          example: HelpDesk
          type: string
        Priority:
          type: integer
      type: object
    portainer.Authorizations:
      additionalProperties:
        type: boolean
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey
    jwt:
      in: header
      name: Authorization
      type: apiKey