Koyeb Rest API — Snapshots

naftiko: 1.0.0-alpha2
info:
  label: Koyeb Rest API — Snapshots
  description: 'Koyeb Rest API — Snapshots. 5 operations. Lead operation: List all Snapshots. Self-contained Naftiko capability
    covering one Koyeb business surface.'
  tags:
  - Koyeb
  - Snapshots
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    KOYEB_API_KEY: KOYEB_API_KEY
capability:
  consumes:
  - type: http
    namespace: koyeb-snapshots
    baseUri: https://app.koyeb.com
    description: Koyeb Rest API — Snapshots business capability. Self-contained, no shared references.
    resources:
    - name: v1-snapshots
      path: /v1/snapshots
      operations:
      - name: listsnapshots
        method: GET
        description: List all Snapshots
        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: organization_id
          in: query
          type: string
          description: (Optional) Filter by organization_id
        - name: statuses
          in: query
          type: array
          description: (Optional) Filter by status
        - name: region
          in: query
          type: string
          description: (Optional) A filter for the region
      - name: createsnapshot
        method: POST
        description: Create a Snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          required: true
    - name: v1-snapshots-id
      path: /v1/snapshots/{id}
      operations:
      - name: getsnapshot
        method: GET
        description: Get a Snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: deletesnapshot
        method: DELETE
        description: Delete a Snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: updatesnapshot
        method: POST
        description: Update a Snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The id of the snapshot
          required: true
        - name: body
          in: body
          type: object
          required: true
  exposes:
  - type: rest
    namespace: koyeb-snapshots-rest
    port: 8080
    description: REST adapter for Koyeb Rest API — Snapshots. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/snapshots
      name: v1-snapshots
      description: REST surface for v1-snapshots.
      operations:
      - method: GET
        name: listsnapshots
        description: List all Snapshots
        call: koyeb-snapshots.listsnapshots
        with:
          limit: rest.limit
          offset: rest.offset
          organization_id: rest.organization_id
          statuses: rest.statuses
          region: rest.region
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsnapshot
        description: Create a Snapshot
        call: koyeb-snapshots.createsnapshot
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/snapshots/{id}
      name: v1-snapshots-id
      description: REST surface for v1-snapshots-id.
      operations:
      - method: GET
        name: getsnapshot
        description: Get a Snapshot
        call: koyeb-snapshots.getsnapshot
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesnapshot
        description: Delete a Snapshot
        call: koyeb-snapshots.deletesnapshot
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: updatesnapshot
        description: Update a Snapshot
        call: koyeb-snapshots.updatesnapshot
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: koyeb-snapshots-mcp
    port: 9090
    transport: http
    description: MCP adapter for Koyeb Rest API — Snapshots. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-all-snapshots
      description: List all Snapshots
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: koyeb-snapshots.listsnapshots
      with:
        limit: tools.limit
        offset: tools.offset
        organization_id: tools.organization_id
        statuses: tools.statuses
        region: tools.region
      outputParameters:
      - type: object
        mapping: $.
    - name: create-snapshot
      description: Create a Snapshot
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: koyeb-snapshots.createsnapshot
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-snapshot
      description: Get a Snapshot
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: koyeb-snapshots.getsnapshot
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-snapshot
      description: Delete a Snapshot
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: koyeb-snapshots.deletesnapshot
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-snapshot
      description: Update a Snapshot
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: koyeb-snapshots.updatesnapshot
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.