Portainer

Portainer Resource Controls API

Manage access control on Docker resources

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 3

POST /resource_controls Create a new resource control #
DELETE /resource_controls/{id} Remove a resource control #
PUT /resource_controls/{id} Update a resource control #

Documentation

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

Specifications

⚙
OpenAPI
https://artifacts.apis.io/portainer/openapi/portainer-resource-controls-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/portainer/json-schema/portainer-portainer-resource-control-schema.json
📊
JSONSchema
https://artifacts.apis.io/portainer/json-schema/portainer-resourcecontrols-resource-control-create-payload-schema.json

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-resource-controls-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

portainer-resource-controls-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 Resource Controls API
  version: 2.39.1
servers:
- url: /api
tags:
- description: Manage access control on Docker resources
  name: resource_controls
paths:
  /resource_controls:
    post:
      description: 'Create a new resource control to restrict access to a Docker resource.

        **Access policy**: administrator'
      operationId: ResourceControlCreate
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.ResourceControl'
        '400':
          description: Invalid request
        '409':
          description: A resource control is already associated to this resource
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Create a new resource control
      tags:
      - resource_controls
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/resourcecontrols.resourceControlCreatePayload'
        description: Resource control details
        required: true
  /resource_controls/{id}:
    delete:
      description: 'Remove a resource control.

        **Access policy**: administrator'
      operationId: ResourceControlDelete
      parameters:
      - description: Resource control identifier
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request
        '404':
          description: Resource control not found
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Remove a resource control
      tags:
      - resource_controls
    put:
      description: 'Update a resource control

        **Access policy**: authenticated'
      operationId: ResourceControlUpdate
      parameters:
      - description: Resource control identifier
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.ResourceControl'
        '400':
          description: Invalid request
        '403':
          description: Unauthorized
        '404':
          description: Resource control not found
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Update a resource control
      tags:
      - resource_controls
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/resourcecontrols.resourceControlUpdatePayload'
        description: Resource control details
        required: true
components:
  schemas:
    resourcecontrols.resourceControlUpdatePayload:
      properties:
        AdministratorsOnly:
          description: Permit access to resource only to admins
          example: true
          type: boolean
        Public:
          description: Permit access to the associated resource to any user
          example: true
          type: boolean
        Teams:
          description: List of team identifiers with access to the associated resource
          example:
          - 7
          items:
            type: integer
          type: array
        Users:
          description: List of user identifiers with access to the associated resource
          example:
          - 4
          items:
            type: integer
          type: array
      type: object
    resourcecontrols.resourceControlCreatePayload:
      properties:
        AdministratorsOnly:
          description: Permit access to resource only to admins
          example: true
          type: boolean
        Public:
          description: Permit access to the associated resource to any user
          example: true
          type: boolean
        ResourceID:
          example: 617c5f22bb9b023d6daab7cba43a57576f83492867bc767d1c59416b065e5f08
          type: string
        SubResourceIDs:
          description: List of Docker resources that will inherit this access control
          example:
          - 617c5f22bb9b023d6daab7cba43a57576f83492867bc767d1c59416b065e5f08
          items:
            type: string
          type: array
        Teams:
          description: List of team identifiers with access to the associated resource
          example:
          - 56
          - 7
          items:
            type: integer
          type: array
        Type:
          allOf:
          - $ref: '#/components/schemas/portainer.ResourceControlType'
          description: 'Type of Resource. Valid values are: 1 - container, 2 - service

            3 - volume, 4 - network, 5 - secret, 6 - stack, 7 - config, 8 - custom template, 9 - azure-container-group'
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
          - 9
          example: 1
        Users:
          description: List of user identifiers with access to the associated resource
          example:
          - 1
          - 4
          items:
            type: integer
          type: array
      required:
      - ResourceID
      - Type
      type: object
    portainer.UserResourceAccess:
      properties:
        AccessLevel:
          $ref: '#/components/schemas/portainer.ResourceAccessLevel'
        UserId:
          type: integer
      type: object
    portainer.TeamResourceAccess:
      properties:
        AccessLevel:
          $ref: '#/components/schemas/portainer.ResourceAccessLevel'
        TeamId:
          type: integer
      type: object
    portainer.ResourceControlType:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      type: integer
      x-enum-varnames:
      - _
      - ContainerResourceControl
      - ServiceResourceControl
      - VolumeResourceControl
      - NetworkResourceControl
      - SecretResourceControl
      - StackResourceControl
      - ConfigResourceControl
      - CustomTemplateResourceControl
      - ContainerGroupResourceControl
    portainer.ResourceAccessLevel:
      enum:
      - 0
      - 1
      type: integer
      x-enum-varnames:
      - _
      - ReadWriteAccessLevel
    portainer.ResourceControl:
      properties:
        AccessLevel:
          $ref: '#/components/schemas/portainer.ResourceAccessLevel'
        AdministratorsOnly:
          description: Permit access to resource only to admins
          example: true
          type: boolean
        Id:
          description: ResourceControl Identifier
          example: 1
          type: integer
        OwnerId:
          description: 'Deprecated fields

            Deprecated in DBVersion == 2'
          type: integer
        Public:
          description: Permit access to the associated resource to any user
          example: true
          type: boolean
        ResourceId:
          description: 'Docker resource identifier on which access control will be applied.\

            In the case of a resource control applied to a stack, use the stack name as identifier'
          example: 617c5f22bb9b023d6daab7cba43a57576f83492867bc767d1c59416b065e5f08
          type: string
        SubResourceIds:
          description: List of Docker resources that will inherit this access control
          example:
          - 617c5f22bb9b023d6daab7cba43a57576f83492867bc767d1c59416b065e5f08
          items:
            type: string
          type: array
        System:
          type: boolean
        TeamAccesses:
          items:
            $ref: '#/components/schemas/portainer.TeamResourceAccess'
          type: array
        Type:
          allOf:
          - $ref: '#/components/schemas/portainer.ResourceControlType'
          description: 'Type of Docker resource. Valid values are: 1- container, 2 -service

            3 - volume, 4 - secret, 5 - stack, 6 - config or 7 - custom template'
          example: 1
        UserAccesses:
          items:
            $ref: '#/components/schemas/portainer.UserResourceAccess'
          type: array
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey
    jwt:
      in: header
      name: Authorization
      type: apiKey