Metal API — Facilities

naftiko: 1.0.0-alpha2
info:
  label: Metal API — Facilities
  description: 'Metal API — Facilities. 3 operations. Lead operation: Retrieve all facilities. Self-contained Naftiko capability
    covering one Equinix business surface.'
  tags:
  - Equinix
  - Facilities
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    EQUINIX_API_KEY: EQUINIX_API_KEY
capability:
  consumes:
  - type: http
    namespace: metal-facilities
    baseUri: https://api.equinix.com/metal/v1
    description: Metal API — Facilities business capability. Self-contained, no shared references.
    resources:
    - name: facilities
      path: /facilities
      operations:
      - name: findfacilities
        method: GET
        description: Retrieve all facilities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: include
          in: query
          type: array
          description: Nested attributes to include. Included objects will return their full attributes. Attribute names can
            be dotted (up to 3 levels) to included deeply nested objec
        - name: exclude
          in: query
          type: array
          description: Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names
            can be dotted (up to 3 levels) to exclude deeply nested obje
    - name: organizations-id-facilities
      path: /organizations/{id}/facilities
      operations:
      - name: findfacilitiesbyorganization
        method: GET
        description: Retrieve all facilities visible by the organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Organization UUID
          required: true
        - name: include
          in: query
          type: array
          description: Nested attributes to include. Included objects will return their full
        - name: exclude
          in: query
          type: array
          description: Nested attributes to exclude. Excluded objects will return only the href
    - name: projects-id-facilities
      path: /projects/{id}/facilities
      operations:
      - name: findfacilitiesbyproject
        method: GET
        description: Retrieve all facilities visible by the 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: exclude
          in: query
          type: array
          description: Nested attributes to exclude. Excluded objects will return only the href
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.EQUINIX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: metal-facilities-rest
    port: 8080
    description: REST adapter for Metal API — Facilities. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/facilities
      name: facilities
      description: REST surface for facilities.
      operations:
      - method: GET
        name: findfacilities
        description: Retrieve all facilities
        call: metal-facilities.findfacilities
        with:
          include: rest.include
          exclude: rest.exclude
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{id}/facilities
      name: organizations-id-facilities
      description: REST surface for organizations-id-facilities.
      operations:
      - method: GET
        name: findfacilitiesbyorganization
        description: Retrieve all facilities visible by the organization
        call: metal-facilities.findfacilitiesbyorganization
        with:
          id: rest.id
          include: rest.include
          exclude: rest.exclude
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{id}/facilities
      name: projects-id-facilities
      description: REST surface for projects-id-facilities.
      operations:
      - method: GET
        name: findfacilitiesbyproject
        description: Retrieve all facilities visible by the project
        call: metal-facilities.findfacilitiesbyproject
        with:
          id: rest.id
          include: rest.include
          exclude: rest.exclude
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: metal-facilities-mcp
    port: 9090
    transport: http
    description: MCP adapter for Metal API — Facilities. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: retrieve-all-facilities
      description: Retrieve all facilities
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: metal-facilities.findfacilities
      with:
        include: tools.include
        exclude: tools.exclude
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-all-facilities-visible-organization
      description: Retrieve all facilities visible by the organization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: metal-facilities.findfacilitiesbyorganization
      with:
        id: tools.id
        include: tools.include
        exclude: tools.exclude
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-all-facilities-visible-project
      description: Retrieve all facilities visible by the project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: metal-facilities.findfacilitiesbyproject
      with:
        id: tools.id
        include: tools.include
        exclude: tools.exclude
      outputParameters:
      - type: object
        mapping: $.