UpKeep API — Assets

naftiko: 1.0.0-alpha2
info:
  label: UpKeep API — Assets
  description: 'UpKeep API — Assets. 6 operations. Lead operation: List Assets. Self-contained Naftiko capability covering
    one Upkeep business surface.'
  tags:
  - Upkeep
  - Assets
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UPKEEP_API_KEY: UPKEEP_API_KEY
capability:
  consumes:
  - type: http
    namespace: upkeep-assets
    baseUri: https://api.onupkeep.com/api/v2
    description: UpKeep API — Assets business capability. Self-contained, no shared references.
    resources:
    - name: assets
      path: /assets
      operations:
      - name: listassets
        method: GET
        description: List Assets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
        - name: limit
          in: query
          type: integer
        - name: includes
          in: query
          type: string
          description: Comma-separated related resources to include
        - name: locationId
          in: query
          type: string
          description: Filter by location
      - name: createasset
        method: POST
        description: Create Asset
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: assets-id
      path: /assets/{id}
      operations:
      - name: getasset
        method: GET
        description: Get Asset
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: updateasset
        method: PATCH
        description: Update Asset
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteasset
        method: DELETE
        description: Delete Asset
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: assets-id-downtime
      path: /assets/{id}/downtime
      operations:
      - name: recordassetdowntime
        method: POST
        description: Record Asset Downtime
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Asset identifier
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: session-token
      value: '{{env.UPKEEP_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: upkeep-assets-rest
    port: 8080
    description: REST adapter for UpKeep API — Assets. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/assets
      name: assets
      description: REST surface for assets.
      operations:
      - method: GET
        name: listassets
        description: List Assets
        call: upkeep-assets.listassets
        with:
          page: rest.page
          limit: rest.limit
          includes: rest.includes
          locationId: rest.locationId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createasset
        description: Create Asset
        call: upkeep-assets.createasset
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/assets/{id}
      name: assets-id
      description: REST surface for assets-id.
      operations:
      - method: GET
        name: getasset
        description: Get Asset
        call: upkeep-assets.getasset
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateasset
        description: Update Asset
        call: upkeep-assets.updateasset
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteasset
        description: Delete Asset
        call: upkeep-assets.deleteasset
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/assets/{id}/downtime
      name: assets-id-downtime
      description: REST surface for assets-id-downtime.
      operations:
      - method: POST
        name: recordassetdowntime
        description: Record Asset Downtime
        call: upkeep-assets.recordassetdowntime
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: upkeep-assets-mcp
    port: 9090
    transport: http
    description: MCP adapter for UpKeep API — Assets. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-assets
      description: List Assets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: upkeep-assets.listassets
      with:
        page: tools.page
        limit: tools.limit
        includes: tools.includes
        locationId: tools.locationId
      outputParameters:
      - type: object
        mapping: $.
    - name: create-asset
      description: Create Asset
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: upkeep-assets.createasset
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-asset
      description: Get Asset
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: upkeep-assets.getasset
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-asset
      description: Update Asset
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: upkeep-assets.updateasset
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-asset
      description: Delete Asset
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: upkeep-assets.deleteasset
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: record-asset-downtime
      description: Record Asset Downtime
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: upkeep-assets.recordassetdowntime
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.