> ## Documentation Index
> Fetch the complete documentation index at: https://docs-pos.solya.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Disable a connector (connecteur)

> Turns the connector OFF (sets `enabled: false`) and returns it (secrets masked). Idempotent — disabling an already-disabled connector is a no-op success. Reversible: the stored config is untouched, so re-enabling restores the connector as configured. 404 on an unknown key. Requires `pos.settings.manage`.



## OpenAPI

````yaml /openapi.json post /v1/integrations/{key}/disable
openapi: 3.0.3
info:
  title: Solya POS API
  version: 1.0.0
  description: >-
    The Solya POS backend HTTP surface. Every documented operation is
    agent-ready: it carries an `operationId`, an agent-facing `description`, the
    `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`.
    Success responses return the payload as raw JSON; failures return the
    `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`).
servers:
  - url: /
    description: The backend, relative to its deployed origin.
security: []
paths:
  /v1/integrations/{key}/disable:
    post:
      tags:
        - Integrations
      summary: Disable a connector (connecteur)
      description: >-
        Turns the connector OFF (sets `enabled: false`) and returns it (secrets
        masked). Idempotent — disabling an already-disabled connector is a no-op
        success. Reversible: the stored config is untouched, so re-enabling
        restores the connector as configured. 404 on an unknown key. Requires
        `pos.settings.manage`.
      operationId: disableIntegration
      parameters:
        - schema:
            type: string
            minLength: 1
          in: path
          name: key
          required: true
          description: >-
            The connector's stable key, e.g. `shopify` (from the connector
            list).
      responses:
        '200':
          description: The disabled connector (secrets masked).
          content:
            application/json:
              schema:
                type: object
                properties:
                  key:
                    type: string
                    minLength: 1
                  name:
                    type: string
                    minLength: 1
                  category:
                    type: string
                    enum:
                      - payment
                      - ecommerce
                      - accounting
                      - merchandising
                  enabled:
                    type: boolean
                  config:
                    type: object
                    additionalProperties:
                      anyOf:
                        - type: boolean
                        - type: string
                required:
                  - key
                  - name
                  - category
                  - enabled
                  - config
                additionalProperties: false
                description: The disabled connector (secrets masked).
                example:
                  key: shopify
                  name: Shopify
                  category: ecommerce
                  enabled: false
                  config:
                    shopDomain: acme.myshopify.com
                    accessToken: ••••••
                    syncStock: true
        '400':
          description: >-
            The request failed schema validation; `error.fieldErrors` lists the
            fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: No valid credential was presented — send a bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The actor is authenticated but lacks the required `pos.*` scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No resource matches the addressed identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected server error — safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ValidationErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: >-
        A `VALIDATION_FAILED` envelope carrying the offending fields in
        `fieldErrors`.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
            message:
              type: string
            statusCode:
              type: integer
            fieldErrors:
              type: array
              description: >-
                One entry per rejected field: the field path and why it was
                rejected.
              items:
                type: object
                required:
                  - field
                  - message
                additionalProperties: false
                properties:
                  field:
                    type: string
                    description: Dot-path of the offending field.
                  message:
                    type: string
                    description: Why the field was rejected.
    ErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: The uniform failure envelope every non-2xx response returns.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - CONFLICT
                - BUSINESS_RULE_VIOLATION
                - INTERNAL_ERROR
              description: >-
                Machine-readable kernel `ResultCode` — branch on this, not on
                `message`.
            message:
              type: string
              description: >-
                Human-readable explanation. Safe to surface; never leaks server
                internals.
            statusCode:
              type: integer
              description: >-
                The HTTP status, mirrored into the body so a client need not
                read headers.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        `Authorization: Bearer <token>`. Accepts EITHER a Keycloak access token
        (scopes-in-token) OR an opaque POS session token; both resolve to the
        same `pos.*` scope vocabulary the route guards enforce.

````