Ngrok API — SSH Credentials

naftiko: 1.0.0-alpha2
info:
  label: Ngrok API — SSH Credentials
  description: 'Ngrok API — SSH Credentials. 5 operations. Lead operation: Ngrok Create SSH Credential. Self-contained Naftiko
    capability covering one Ngrok business surface.'
  tags:
  - Ngrok
  - SSH Credentials
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NGROK_API_KEY: NGROK_API_KEY
capability:
  consumes:
  - type: http
    namespace: ngrok-ssh-credentials
    baseUri: https://api.ngrok.com
    description: Ngrok API — SSH Credentials business capability. Self-contained, no shared references.
    resources:
    - name: ssh_credentials
      path: /ssh_credentials
      operations:
      - name: createsshcredential
        method: POST
        description: Ngrok Create SSH Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listsshcredentials
        method: GET
        description: Ngrok List SSH Credentials
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: ssh_credentials-id
      path: /ssh_credentials/{id}
      operations:
      - name: getsshcredential
        method: GET
        description: Ngrok Get SSH Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatesshcredential
        method: PATCH
        description: Ngrok Update SSH Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesshcredential
        method: DELETE
        description: Ngrok Delete SSH Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.NGROK_API_KEY}}'
  exposes:
  - type: rest
    namespace: ngrok-ssh-credentials-rest
    port: 8080
    description: REST adapter for Ngrok API — SSH Credentials. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/ssh-credentials
      name: ssh-credentials
      description: REST surface for ssh_credentials.
      operations:
      - method: POST
        name: createsshcredential
        description: Ngrok Create SSH Credential
        call: ngrok-ssh-credentials.createsshcredential
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listsshcredentials
        description: Ngrok List SSH Credentials
        call: ngrok-ssh-credentials.listsshcredentials
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ssh-credentials/{id}
      name: ssh-credentials-id
      description: REST surface for ssh_credentials-id.
      operations:
      - method: GET
        name: getsshcredential
        description: Ngrok Get SSH Credential
        call: ngrok-ssh-credentials.getsshcredential
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatesshcredential
        description: Ngrok Update SSH Credential
        call: ngrok-ssh-credentials.updatesshcredential
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesshcredential
        description: Ngrok Delete SSH Credential
        call: ngrok-ssh-credentials.deletesshcredential
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ngrok-ssh-credentials-mcp
    port: 9090
    transport: http
    description: MCP adapter for Ngrok API — SSH Credentials. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: ngrok-create-ssh-credential
      description: Ngrok Create SSH Credential
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ngrok-ssh-credentials.createsshcredential
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ngrok-list-ssh-credentials
      description: Ngrok List SSH Credentials
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ngrok-ssh-credentials.listsshcredentials
      outputParameters:
      - type: object
        mapping: $.
    - name: ngrok-get-ssh-credential
      description: Ngrok Get SSH Credential
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ngrok-ssh-credentials.getsshcredential
      outputParameters:
      - type: object
        mapping: $.
    - name: ngrok-update-ssh-credential
      description: Ngrok Update SSH Credential
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ngrok-ssh-credentials.updatesshcredential
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ngrok-delete-ssh-credential
      description: Ngrok Delete SSH Credential
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ngrok-ssh-credentials.deletesshcredential
      outputParameters:
      - type: object
        mapping: $.