Metal API — Batches

naftiko: 1.0.0-alpha2
info:
  label: Metal API — Batches
  description: 'Metal API — Batches. 4 operations. Lead operation: Delete the Batch. Self-contained Naftiko capability covering
    one Equinix business surface.'
  tags:
  - Equinix
  - Batches
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    EQUINIX_API_KEY: EQUINIX_API_KEY
capability:
  consumes:
  - type: http
    namespace: metal-batches
    baseUri: https://api.equinix.com/metal/v1
    description: Metal API — Batches business capability. Self-contained, no shared references.
    resources:
    - name: batches-id
      path: /batches/{id}
      operations:
      - name: deletebatch
        method: DELETE
        description: Delete the Batch
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Batch UUID
          required: true
        - name: remove_associated_instances
          in: query
          type: boolean
          description: Delete all instances created from this batch
      - name: findbatchbyid
        method: GET
        description: Retrieve a Batch
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Batch UUID
          required: true
        - name: include
          in: query
          type: array
          description: Nested attributes to include. Included objects will return their full
    - name: projects-id-batches
      path: /projects/{id}/batches
      operations:
      - name: findbatchesbyproject
        method: GET
        description: Retrieve all batches by project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Project UUID
          required: true
        - name: include
          in: query
          type: array
          description: Nested attributes to include. Included objects will return their full
    - name: projects-id-devices-batch
      path: /projects/{id}/devices/batch
      operations:
      - name: createdevicebatch
        method: POST
        description: Create a devices batch
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Project UUID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.EQUINIX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: metal-batches-rest
    port: 8080
    description: REST adapter for Metal API — Batches. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/batches/{id}
      name: batches-id
      description: REST surface for batches-id.
      operations:
      - method: DELETE
        name: deletebatch
        description: Delete the Batch
        call: metal-batches.deletebatch
        with:
          id: rest.id
          remove_associated_instances: rest.remove_associated_instances
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: findbatchbyid
        description: Retrieve a Batch
        call: metal-batches.findbatchbyid
        with:
          id: rest.id
          include: rest.include
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{id}/batches
      name: projects-id-batches
      description: REST surface for projects-id-batches.
      operations:
      - method: GET
        name: findbatchesbyproject
        description: Retrieve all batches by project
        call: metal-batches.findbatchesbyproject
        with:
          id: rest.id
          include: rest.include
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{id}/devices/batch
      name: projects-id-devices-batch
      description: REST surface for projects-id-devices-batch.
      operations:
      - method: POST
        name: createdevicebatch
        description: Create a devices batch
        call: metal-batches.createdevicebatch
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: metal-batches-mcp
    port: 9090
    transport: http
    description: MCP adapter for Metal API — Batches. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: delete-batch
      description: Delete the Batch
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: metal-batches.deletebatch
      with:
        id: tools.id
        remove_associated_instances: tools.remove_associated_instances
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-batch
      description: Retrieve a Batch
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: metal-batches.findbatchbyid
      with:
        id: tools.id
        include: tools.include
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-all-batches-project
      description: Retrieve all batches by project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: metal-batches.findbatchesbyproject
      with:
        id: tools.id
        include: tools.include
      outputParameters:
      - type: object
        mapping: $.
    - name: create-devices-batch
      description: Create a devices batch
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: metal-batches.createdevicebatch
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.