Northflank API — Services

naftiko: 1.0.0-alpha2
info:
  label: Northflank API — Services
  description: 'Northflank API — Services. 4 operations. Lead operation: List services in a project. Self-contained Naftiko
    capability covering one Northflank business surface.'
  tags:
  - Northflank
  - Services
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NORTHFLANK_API_KEY: NORTHFLANK_API_KEY
capability:
  consumes:
  - type: http
    namespace: northflank-services
    baseUri: https://api.northflank.com/v1
    description: Northflank API — Services business capability. Self-contained, no shared references.
    resources:
    - name: projects-projectId-services
      path: /projects/{projectId}/services
      operations:
      - name: listservices
        method: GET
        description: List services in a project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createservice
        method: POST
        description: Create a service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: projects-projectId-services-serviceId
      path: /projects/{projectId}/services/{serviceId}
      operations:
      - name: getservice
        method: GET
        description: Get a service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteservice
        method: DELETE
        description: Delete a service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.NORTHFLANK_API_KEY}}'
  exposes:
  - type: rest
    namespace: northflank-services-rest
    port: 8080
    description: REST adapter for Northflank API — Services. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/projects/{projectid}/services
      name: projects-projectid-services
      description: REST surface for projects-projectId-services.
      operations:
      - method: GET
        name: listservices
        description: List services in a project
        call: northflank-services.listservices
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createservice
        description: Create a service
        call: northflank-services.createservice
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectid}/services/{serviceid}
      name: projects-projectid-services-serviceid
      description: REST surface for projects-projectId-services-serviceId.
      operations:
      - method: GET
        name: getservice
        description: Get a service
        call: northflank-services.getservice
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteservice
        description: Delete a service
        call: northflank-services.deleteservice
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: northflank-services-mcp
    port: 9090
    transport: http
    description: MCP adapter for Northflank API — Services. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-services-project
      description: List services in a project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: northflank-services.listservices
      outputParameters:
      - type: object
        mapping: $.
    - name: create-service
      description: Create a service
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: northflank-services.createservice
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-service
      description: Get a service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: northflank-services.getservice
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-service
      description: Delete a service
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: northflank-services.deleteservice
      outputParameters:
      - type: object
        mapping: $.