API Reference — subpackage_connections

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_connections
  description: 'API Reference — subpackage_connections. 16 operations. Lead operation: Get Connection Types. Self-contained
    Naftiko capability covering one Polytomic business surface.'
  tags:
  - Polytomic
  - subpackage_connections
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    POLYTOMIC_API_KEY: POLYTOMIC_API_KEY
capability:
  consumes:
  - type: http
    namespace: polytomic-subpackage-connections
    baseUri: https://app.polytomic.com
    description: API Reference — subpackage_connections business capability. Self-contained, no shared references.
    resources:
    - name: api-connection_types
      path: /api/connection_types
      operations:
      - name: gettypes
        method: GET
        description: Get Connection Types
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-connection_types-id
      path: /api/connection_types/{id}
      operations:
      - name: getconnectiontypeschema
        method: GET
        description: Get Connection Type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Connection type identifier (e.g. postgresql, salesforce, hubspot).
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-connection_types-type-parameter_values
      path: /api/connection_types/{type}/parameter_values
      operations:
      - name: gettypeparametervalues
        method: POST
        description: Connection Type Parameter Values
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-connections
      path: /api/connections
      operations:
      - name: list
        method: GET
        description: List Connections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
      - name: create
        method: POST
        description: Create Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-connections-connect
      path: /api/connections/connect/
      operations:
      - name: connect
        method: POST
        description: Connect
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-connections-test
      path: /api/connections/test
      operations:
      - name: testconnection
        method: POST
        description: Test Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-connections-id
      path: /api/connections/{id}
      operations:
      - name: get
        method: GET
        description: Get Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
      - name: update
        method: PUT
        description: Update Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: Delete Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: force
          in: query
          type: boolean
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-connections-id-parameter_values
      path: /api/connections/{id}/parameter_values
      operations:
      - name: getparametervalues
        method: GET
        description: Connection Parameter Values
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-connections-id-proxy
      path: /api/connections/{id}/proxy
      operations:
      - name: executeproxy
        method: POST
        description: Execute Connection Proxy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Unique identifier of the connection to proxy the request through.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-connections-id-proxy-info
      path: /api/connections/{id}/proxy/info
      operations:
      - name: getproxyinfo
        method: GET
        description: Get Connection Proxy Info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Unique identifier of the connection whose proxy contract should be returned.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-connections-id-shared
      path: /api/connections/{id}/shared
      operations:
      - name: listsharedconnections
        method: GET
        description: List Current Org Shared Connections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Unique identifier of the parent connection whose shared copies should be listed.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-organizations-org_id-connections-connection_id-shared
      path: /api/organizations/{org_id}/connections/{connection_id}/shared
      operations:
      - name: listsharedconnectionsforpartner
        method: GET
        description: List Partner Shared Connections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: Unique identifier of the organization that owns the parent connection.
          required: true
        - name: connection_id
          in: path
          type: string
          description: Unique identifier of the parent connection whose shared copies should be listed.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer partner API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
      - name: createsharedconnection
        method: POST
        description: Create Partner Shared Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org_id
          in: path
          type: string
          description: Unique identifier of the organization that owns the parent connection.
          required: true
        - name: connection_id
          in: path
          type: string
          description: Unique identifier of the parent connection to share.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer partner API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.POLYTOMIC_API_KEY}}'
  exposes:
  - type: rest
    namespace: polytomic-subpackage-connections-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_connections. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/connection-types
      name: api-connection-types
      description: REST surface for api-connection_types.
      operations:
      - method: GET
        name: gettypes
        description: Get Connection Types
        call: polytomic-subpackage-connections.gettypes
        with:
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/connection-types/{id}
      name: api-connection-types-id
      description: REST surface for api-connection_types-id.
      operations:
      - method: GET
        name: getconnectiontypeschema
        description: Get Connection Type
        call: polytomic-subpackage-connections.getconnectiontypeschema
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/connection-types/{type}/parameter-values
      name: api-connection-types-type-parameter-values
      description: REST surface for api-connection_types-type-parameter_values.
      operations:
      - method: POST
        name: gettypeparametervalues
        description: Connection Type Parameter Values
        call: polytomic-subpackage-connections.gettypeparametervalues
        with:
          type: rest.type
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/connections
      name: api-connections
      description: REST surface for api-connections.
      operations:
      - method: GET
        name: list
        description: List Connections
        call: polytomic-subpackage-connections.list
        with:
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: Create Connection
        call: polytomic-subpackage-connections.create
        with:
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/connections/connect
      name: api-connections-connect
      description: REST surface for api-connections-connect.
      operations:
      - method: POST
        name: connect
        description: Connect
        call: polytomic-subpackage-connections.connect
        with:
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/connections/test
      name: api-connections-test
      description: REST surface for api-connections-test.
      operations:
      - method: POST
        name: testconnection
        description: Test Connection
        call: polytomic-subpackage-connections.testconnection
        with:
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/connections/{id}
      name: api-connections-id
      description: REST surface for api-connections-id.
      operations:
      - method: GET
        name: get
        description: Get Connection
        call: polytomic-subpackage-connections.get
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: update
        description: Update Connection
        call: polytomic-subpackage-connections.update
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete Connection
        call: polytomic-subpackage-connections.delete
        with:
          id: rest.id
          force: rest.force
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/connections/{id}/parameter-values
      name: api-connections-id-parameter-values
      description: REST surface for api-connections-id-parameter_values.
      operations:
      - method: GET
        name: getparametervalues
        description: Connection Parameter Values
        call: polytomic-subpackage-connections.getparametervalues
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/connections/{id}/proxy
      name: api-connections-id-proxy
      description: REST surface for api-connections-id-proxy.
      operations:
      - method: POST
        name: executeproxy
        description: Execute Connection Proxy
        call: polytomic-subpackage-connections.executeproxy
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/connections/{id}/proxy/info
      name: api-connections-id-proxy-info
      description: REST surface for api-connections-id-proxy-info.
      operations:
      - method: GET
        name: getproxyinfo
        description: Get Connection Proxy Info
        call: polytomic-subpackage-connections.getproxyinfo
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/connections/{id}/shared
      name: api-connections-id-shared
      description: REST surface for api-connections-id-shared.
      operations:
      - method: GET
        name: listsharedconnections
        description: List Current Org Shared Connections
        call: polytomic-subpackage-connections.listsharedconnections
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/organizations/{org-id}/connections/{connection-id}/shared
      name: api-organizations-org-id-connections-connection-id-shared
      description: REST surface for api-organizations-org_id-connections-connection_id-shared.
      operations:
      - method: GET
        name: listsharedconnectionsforpartner
        description: List Partner Shared Connections
        call: polytomic-subpackage-connections.listsharedconnectionsforpartner
        with:
          org_id: rest.org_id
          connection_id: rest.connection_id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsharedconnection
        description: Create Partner Shared Connection
        call: polytomic-subpackage-connections.createsharedconnection
        with:
          org_id: rest.org_id
          connection_id: rest.connection_id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: polytomic-subpackage-connections-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_connections. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-connection-types
      description: Get Connection Types
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-connections.gettypes
      with:
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: get-connection-type
      description: Get Connection Type
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-connections.getconnectiontypeschema
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: connection-type-parameter-values
      description: Connection Type Parameter Values
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-connections.gettypeparametervalues
      with:
        type: tools.type
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-connections
      description: List Connections
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-connections.list
      with:
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: create-connection
      description: Create Connection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-connections.create
      with:
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: connect
      description: Connect
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-connections.connect
      with:
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: test-connection
      description: Test Connection
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: polytomic-subpackage-connections.testconnection
      with:
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-connection
      description: Get Connection
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-connections.get
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: update-connection
      description: Update Connection
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: polytomic-subpackage-connections.update
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-connection
      description: Delete Connection
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: polytomic-subpackage-connections.delete
      with:
        id: tools.id
        force: tools.force
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: connection-parameter-values
      description: Connection Parameter Values
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-connections.getparametervalues
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: execute-connection-proxy
      description: Execute Connection Proxy
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-connections.executeproxy
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-connection-proxy-info
      description: Get Connection Proxy Info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-connections.getproxyinfo
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: list-current-org-shared-connections
      description: List Current Org Shared Connections
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-connections.listsharedconnections
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: list-partner-shared-connections
      description: List Partner Shared Connections
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-connections.listsharedconnectionsforpartner
      with:
        org_id: tools.org_id
        connection_id: tools.connection_id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: create-partner-shared-connection
      description: Create Partner Shared Connection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-connections.createsharedconnection
      with:
        org_id: tools.org_id
        connection_id: tools.connection_id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.