n8n Public API — Credential

naftiko: 1.0.0-alpha2
info:
  label: n8n Public API — Credential
  description: 'n8n Public API — Credential. 5 operations. Lead operation: Create a credential. Self-contained Naftiko capability
    covering one N8n business surface.'
  tags:
  - N8n
  - Credential
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    N8N_API_KEY: N8N_API_KEY
capability:
  consumes:
  - type: http
    namespace: n8n-credential
    baseUri: https://app.n8n.cloud/api/v1
    description: n8n Public API — Credential business capability. Self-contained, no shared references.
    resources:
    - name: credentials
      path: /credentials
      operations:
      - name: createcredential
        method: POST
        description: Create a credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: credentials-schema-credentialTypeName
      path: /credentials/schema/{credentialTypeName}
      operations:
      - name: getcredentialschema
        method: GET
        description: Show credential data schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: credentialTypeName
          in: path
          type: string
          required: true
    - name: credentials-id
      path: /credentials/{id}
      operations:
      - name: deletecredential
        method: DELETE
        description: Delete credential by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The credential ID.
          required: true
    - name: credentials-id-test
      path: /credentials/{id}/test
      operations:
      - name: testcredential
        method: POST
        description: Test a credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: credentials-id-transfer
      path: /credentials/{id}/transfer
      operations:
      - name: transfercredential
        method: PUT
        description: Transfer a credential to another project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.N8N_API_KEY}}'
  exposes:
  - type: rest
    namespace: n8n-credential-rest
    port: 8080
    description: REST adapter for n8n Public API — Credential. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/credentials
      name: credentials
      description: REST surface for credentials.
      operations:
      - method: POST
        name: createcredential
        description: Create a credential
        call: n8n-credential.createcredential
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/credentials/schema/{credentialtypename}
      name: credentials-schema-credentialtypename
      description: REST surface for credentials-schema-credentialTypeName.
      operations:
      - method: GET
        name: getcredentialschema
        description: Show credential data schema
        call: n8n-credential.getcredentialschema
        with:
          credentialTypeName: rest.credentialTypeName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/credentials/{id}
      name: credentials-id
      description: REST surface for credentials-id.
      operations:
      - method: DELETE
        name: deletecredential
        description: Delete credential by ID
        call: n8n-credential.deletecredential
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/credentials/{id}/test
      name: credentials-id-test
      description: REST surface for credentials-id-test.
      operations:
      - method: POST
        name: testcredential
        description: Test a credential
        call: n8n-credential.testcredential
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/credentials/{id}/transfer
      name: credentials-id-transfer
      description: REST surface for credentials-id-transfer.
      operations:
      - method: PUT
        name: transfercredential
        description: Transfer a credential to another project
        call: n8n-credential.transfercredential
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: n8n-credential-mcp
    port: 9090
    transport: http
    description: MCP adapter for n8n Public API — Credential. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-credential
      description: Create a credential
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: n8n-credential.createcredential
      outputParameters:
      - type: object
        mapping: $.
    - name: show-credential-data-schema
      description: Show credential data schema
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: n8n-credential.getcredentialschema
      with:
        credentialTypeName: tools.credentialTypeName
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-credential-id
      description: Delete credential by ID
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: n8n-credential.deletecredential
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: test-credential
      description: Test a credential
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: n8n-credential.testcredential
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: transfer-credential-another-project
      description: Transfer a credential to another project
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: n8n-credential.transfercredential
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.