Koyeb Rest API — Credentials

naftiko: 1.0.0-alpha2
info:
  label: Koyeb Rest API — Credentials
  description: 'Koyeb Rest API — Credentials. 6 operations. Lead operation: List credentials. Self-contained Naftiko capability
    covering one Koyeb business surface.'
  tags:
  - Koyeb
  - Credentials
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    KOYEB_API_KEY: KOYEB_API_KEY
capability:
  consumes:
  - type: http
    namespace: koyeb-credentials
    baseUri: https://app.koyeb.com
    description: Koyeb Rest API — Credentials business capability. Self-contained, no shared references.
    resources:
    - name: v1-credentials
      path: /v1/credentials
      operations:
      - name: listcredentials
        method: GET
        description: List credentials
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: query
          type: string
          description: (Optional) A filter for type
        - name: name
          in: query
          type: string
          description: (Optional) A filter for name
        - name: organization_id
          in: query
          type: string
          description: (Optional) Filter for an organization
        - name: user_id
          in: query
          type: string
          description: (Optional) Filter for an user
        - name: limit
          in: query
          type: string
          description: (Optional) The number of items to return
        - name: offset
          in: query
          type: string
          description: (Optional) The offset in the list of item to return
      - name: createcredential
        method: POST
        description: Create credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: credential
          in: body
          type: string
          required: true
    - name: v1-credentials-id
      path: /v1/credentials/{id}
      operations:
      - name: getcredential
        method: GET
        description: Get credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: deletecredential
        method: DELETE
        description: Delete credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: updatecredential
        method: PUT
        description: Update credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: credential
          in: body
          type: string
          required: true
        - name: update_mask
          in: query
          type: string
      - name: updatecredential2
        method: PATCH
        description: Update credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: credential
          in: body
          type: string
          required: true
        - name: update_mask
          in: query
          type: string
  exposes:
  - type: rest
    namespace: koyeb-credentials-rest
    port: 8080
    description: REST adapter for Koyeb Rest API — Credentials. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/credentials
      name: v1-credentials
      description: REST surface for v1-credentials.
      operations:
      - method: GET
        name: listcredentials
        description: List credentials
        call: koyeb-credentials.listcredentials
        with:
          type: rest.type
          name: rest.name
          organization_id: rest.organization_id
          user_id: rest.user_id
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcredential
        description: Create credential
        call: koyeb-credentials.createcredential
        with:
          credential: rest.credential
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/credentials/{id}
      name: v1-credentials-id
      description: REST surface for v1-credentials-id.
      operations:
      - method: GET
        name: getcredential
        description: Get credential
        call: koyeb-credentials.getcredential
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecredential
        description: Delete credential
        call: koyeb-credentials.deletecredential
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecredential
        description: Update credential
        call: koyeb-credentials.updatecredential
        with:
          id: rest.id
          credential: rest.credential
          update_mask: rest.update_mask
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatecredential2
        description: Update credential
        call: koyeb-credentials.updatecredential2
        with:
          id: rest.id
          credential: rest.credential
          update_mask: rest.update_mask
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: koyeb-credentials-mcp
    port: 9090
    transport: http
    description: MCP adapter for Koyeb Rest API — Credentials. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-credentials
      description: List credentials
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: koyeb-credentials.listcredentials
      with:
        type: tools.type
        name: tools.name
        organization_id: tools.organization_id
        user_id: tools.user_id
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: create-credential
      description: Create credential
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: koyeb-credentials.createcredential
      with:
        credential: tools.credential
      outputParameters:
      - type: object
        mapping: $.
    - name: get-credential
      description: Get credential
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: koyeb-credentials.getcredential
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-credential
      description: Delete credential
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: koyeb-credentials.deletecredential
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-credential
      description: Update credential
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: koyeb-credentials.updatecredential
      with:
        id: tools.id
        credential: tools.credential
        update_mask: tools.update_mask
      outputParameters:
      - type: object
        mapping: $.
    - name: update-credential-2
      description: Update credential
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: koyeb-credentials.updatecredential2
      with:
        id: tools.id
        credential: tools.credential
        update_mask: tools.update_mask
      outputParameters:
      - type: object
        mapping: $.