Koyeb · Capability

Koyeb Rest API — CatalogInstances

Koyeb Rest API — CatalogInstances. 2 operations. Lead operation: List Instances. Self-contained Naftiko capability covering one Koyeb business surface.

Run with Naftiko KoyebCatalogInstances

What You Can Do

GET
Listcataloginstances — List Instances
/v1/v1/catalog/instances
GET
Getcataloginstance — Get Instance
/v1/v1/catalog/instances/{id}

MCP Tools

list-instances

List Instances

read-only idempotent
get-instance

Get Instance

read-only idempotent

Capability Spec

koyeb-cataloginstances.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Koyeb Rest API — CatalogInstances
  description: 'Koyeb Rest API — CatalogInstances. 2 operations. Lead operation: List Instances. Self-contained Naftiko capability
    covering one Koyeb business surface.'
  tags:
  - Koyeb
  - CatalogInstances
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    KOYEB_API_KEY: KOYEB_API_KEY
capability:
  consumes:
  - type: http
    namespace: koyeb-cataloginstances
    baseUri: https://app.koyeb.com
    description: Koyeb Rest API — CatalogInstances business capability. Self-contained, no shared references.
    resources:
    - name: v1-catalog-instances
      path: /v1/catalog/instances
      operations:
      - name: listcataloginstances
        method: GET
        description: List Instances
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - 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: id
          in: query
          type: string
          description: (Optional) A filter for instances
    - name: v1-catalog-instances-id
      path: /v1/catalog/instances/{id}
      operations:
      - name: getcataloginstance
        method: GET
        description: Get Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The name of the instance
          required: true
  exposes:
  - type: rest
    namespace: koyeb-cataloginstances-rest
    port: 8080
    description: REST adapter for Koyeb Rest API — CatalogInstances. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/catalog/instances
      name: v1-catalog-instances
      description: REST surface for v1-catalog-instances.
      operations:
      - method: GET
        name: listcataloginstances
        description: List Instances
        call: koyeb-cataloginstances.listcataloginstances
        with:
          limit: rest.limit
          offset: rest.offset
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/catalog/instances/{id}
      name: v1-catalog-instances-id
      description: REST surface for v1-catalog-instances-id.
      operations:
      - method: GET
        name: getcataloginstance
        description: Get Instance
        call: koyeb-cataloginstances.getcataloginstance
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: koyeb-cataloginstances-mcp
    port: 9090
    transport: http
    description: MCP adapter for Koyeb Rest API — CatalogInstances. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-instances
      description: List Instances
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: koyeb-cataloginstances.listcataloginstances
      with:
        limit: tools.limit
        offset: tools.offset
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-instance
      description: Get Instance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: koyeb-cataloginstances.getcataloginstance
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.