PortainerCE API — settings

naftiko: 1.0.0-alpha2
info:
  label: PortainerCE API — settings
  description: 'PortainerCE API — settings. 3 operations. Lead operation: Retrieve Portainer settings. Self-contained Naftiko
    capability covering one Portainer business surface.'
  tags:
  - Portainer
  - settings
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PORTAINER_API_KEY: PORTAINER_API_KEY
capability:
  consumes:
  - type: http
    namespace: portainer-settings
    baseUri: ''
    description: PortainerCE API — settings business capability. Self-contained, no shared references.
    resources:
    - name: settings
      path: /settings
      operations:
      - name: settingsinspect
        method: GET
        description: Retrieve Portainer settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: settingsupdate
        method: PUT
        description: Update Portainer settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          description: New settings
          required: true
    - name: settings-public
      path: /settings/public
      operations:
      - name: settingspublic
        method: GET
        description: Retrieve Portainer public settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: portainer-settings-rest
    port: 8080
    description: REST adapter for PortainerCE API — settings. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/settings
      name: settings
      description: REST surface for settings.
      operations:
      - method: GET
        name: settingsinspect
        description: Retrieve Portainer settings
        call: portainer-settings.settingsinspect
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: settingsupdate
        description: Update Portainer settings
        call: portainer-settings.settingsupdate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings/public
      name: settings-public
      description: REST surface for settings-public.
      operations:
      - method: GET
        name: settingspublic
        description: Retrieve Portainer public settings
        call: portainer-settings.settingspublic
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: portainer-settings-mcp
    port: 9090
    transport: http
    description: MCP adapter for PortainerCE API — settings. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: retrieve-portainer-settings
      description: Retrieve Portainer settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portainer-settings.settingsinspect
      outputParameters:
      - type: object
        mapping: $.
    - name: update-portainer-settings
      description: Update Portainer settings
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: portainer-settings.settingsupdate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-portainer-public-settings
      description: Retrieve Portainer public settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portainer-settings.settingspublic
      outputParameters:
      - type: object
        mapping: $.