Ngrok API — Credentials

naftiko: 1.0.0-alpha2
info:
  label: Ngrok API — Credentials
  description: 'Ngrok API — Credentials. 5 operations. Lead operation: Ngrok Create Credential. Self-contained Naftiko capability
    covering one Ngrok business surface.'
  tags:
  - Ngrok
  - 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-credentials
    baseUri: https://api.ngrok.com
    description: Ngrok API — Credentials business capability. Self-contained, no shared references.
    resources:
    - name: credentials
      path: /credentials
      operations:
      - name: createcredential
        method: POST
        description: Ngrok Create Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listcredentials
        method: GET
        description: Ngrok List Credentials
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: credentials-id
      path: /credentials/{id}
      operations:
      - name: getcredential
        method: GET
        description: Ngrok Get Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecredential
        method: PATCH
        description: Ngrok Update Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecredential
        method: DELETE
        description: Ngrok Delete Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.NGROK_API_KEY}}'
  exposes:
  - type: rest
    namespace: ngrok-credentials-rest
    port: 8080
    description: REST adapter for Ngrok API — Credentials. 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: Ngrok Create Credential
        call: ngrok-credentials.createcredential
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listcredentials
        description: Ngrok List Credentials
        call: ngrok-credentials.listcredentials
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/credentials/{id}
      name: credentials-id
      description: REST surface for credentials-id.
      operations:
      - method: GET
        name: getcredential
        description: Ngrok Get Credential
        call: ngrok-credentials.getcredential
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatecredential
        description: Ngrok Update Credential
        call: ngrok-credentials.updatecredential
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecredential
        description: Ngrok Delete Credential
        call: ngrok-credentials.deletecredential
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ngrok-credentials-mcp
    port: 9090
    transport: http
    description: MCP adapter for Ngrok API — Credentials. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: ngrok-create-credential
      description: Ngrok Create Credential
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ngrok-credentials.createcredential
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ngrok-list-credentials
      description: Ngrok List Credentials
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ngrok-credentials.listcredentials
      outputParameters:
      - type: object
        mapping: $.
    - name: ngrok-get-credential
      description: Ngrok Get Credential
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ngrok-credentials.getcredential
      outputParameters:
      - type: object
        mapping: $.
    - name: ngrok-update-credential
      description: Ngrok Update Credential
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ngrok-credentials.updatecredential
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: ngrok-delete-credential
      description: Ngrok Delete Credential
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ngrok-credentials.deletecredential
      outputParameters:
      - type: object
        mapping: $.