Humanitec API — Deployment

naftiko: 1.0.0-alpha2
info:
  label: Humanitec API — Deployment
  description: 'Humanitec API — Deployment. 4 operations. Lead operation: List Deployments in an Environment.. Self-contained
    Naftiko capability covering one Humanitec business surface.'
  tags:
  - Humanitec
  - Deployment
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HUMANITEC_API_KEY: HUMANITEC_API_KEY
capability:
  consumes:
  - type: http
    namespace: humanitec-deployment
    baseUri: https://api.humanitec.io
    description: Humanitec API — Deployment business capability. Self-contained, no shared references.
    resources:
    - name: orgs-orgId-apps-appId-envs-envId-deploys
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys
      operations:
      - name: listdeployments
        method: GET
        description: List Deployments in an Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: pipelineRunId
          in: query
          type: string
          description: An optional filter by the Pipeline and Pipeline Run ID separated by a comma.
      - name: createdeployment
        method: POST
        description: Start a new Deployment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-envs-envId-deploys-deployId
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}
      operations:
      - name: getdeployment
        method: GET
        description: Get a specific Deployment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: deployId
          in: path
          type: string
          description: The Deployment ID.
          required: true
    - name: orgs-orgId-apps-appId-envs-envId-deploys-deployId-errors
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}/errors
      operations:
      - name: listdeploymenterrors
        method: GET
        description: List errors that occurred in a Deployment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: deployId
          in: path
          type: string
          description: The Deployment ID.
          required: true
  exposes:
  - type: rest
    namespace: humanitec-deployment-rest
    port: 8080
    description: REST adapter for Humanitec API — Deployment. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/deploys
      name: orgs-orgid-apps-appid-envs-envid-deploys
      description: REST surface for orgs-orgId-apps-appId-envs-envId-deploys.
      operations:
      - method: GET
        name: listdeployments
        description: List Deployments in an Environment.
        call: humanitec-deployment.listdeployments
        with:
          orgId: rest.orgId
          appId: rest.appId
          envId: rest.envId
          pipelineRunId: rest.pipelineRunId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createdeployment
        description: Start a new Deployment.
        call: humanitec-deployment.createdeployment
        with:
          orgId: rest.orgId
          appId: rest.appId
          envId: rest.envId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/deploys/{deployid}
      name: orgs-orgid-apps-appid-envs-envid-deploys-deployid
      description: REST surface for orgs-orgId-apps-appId-envs-envId-deploys-deployId.
      operations:
      - method: GET
        name: getdeployment
        description: Get a specific Deployment.
        call: humanitec-deployment.getdeployment
        with:
          orgId: rest.orgId
          appId: rest.appId
          envId: rest.envId
          deployId: rest.deployId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/deploys/{deployid}/errors
      name: orgs-orgid-apps-appid-envs-envid-deploys-deployid-errors
      description: REST surface for orgs-orgId-apps-appId-envs-envId-deploys-deployId-errors.
      operations:
      - method: GET
        name: listdeploymenterrors
        description: List errors that occurred in a Deployment.
        call: humanitec-deployment.listdeploymenterrors
        with:
          orgId: rest.orgId
          appId: rest.appId
          envId: rest.envId
          deployId: rest.deployId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: humanitec-deployment-mcp
    port: 9090
    transport: http
    description: MCP adapter for Humanitec API — Deployment. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-deployments-environment
      description: List Deployments in an Environment.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: humanitec-deployment.listdeployments
      with:
        orgId: tools.orgId
        appId: tools.appId
        envId: tools.envId
        pipelineRunId: tools.pipelineRunId
      outputParameters:
      - type: object
        mapping: $.
    - name: start-new-deployment
      description: Start a new Deployment.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: humanitec-deployment.createdeployment
      with:
        orgId: tools.orgId
        appId: tools.appId
        envId: tools.envId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-specific-deployment
      description: Get a specific Deployment.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: humanitec-deployment.getdeployment
      with:
        orgId: tools.orgId
        appId: tools.appId
        envId: tools.envId
        deployId: tools.deployId
      outputParameters:
      - type: object
        mapping: $.
    - name: list-errors-that-occurred-deployment
      description: List errors that occurred in a Deployment.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: humanitec-deployment.listdeploymenterrors
      with:
        orgId: tools.orgId
        appId: tools.appId
        envId: tools.envId
        deployId: tools.deployId
      outputParameters:
      - type: object
        mapping: $.