Humanitec API — ActiveResource

naftiko: 1.0.0-alpha2
info:
  label: Humanitec API — ActiveResource
  description: 'Humanitec API — ActiveResource. 4 operations. Lead operation: List Active Resources provisioned in an environment..
    Self-contained Naftiko capability covering one Humanitec business surface.'
  tags:
  - Humanitec
  - ActiveResource
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HUMANITEC_API_KEY: HUMANITEC_API_KEY
capability:
  consumes:
  - type: http
    namespace: humanitec-activeresource
    baseUri: https://api.humanitec.io
    description: Humanitec API — ActiveResource business capability. Self-contained, no shared references.
    resources:
    - name: orgs-orgId-apps-appId-envs-envId-resources
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/resources
      operations:
      - name: listactiveresources
        method: GET
        description: List Active Resources provisioned 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: scheduled_deletion
          in: query
          type: boolean
          description: If set to `true` or `false`, filters resources scheduled or not scheduled for deletion correspondingly.
    - name: orgs-orgId-apps-appId-envs-envId-resources-type-resId
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/resources/{type}/{resId}
      operations:
      - name: deleteactiveresource
        method: DELETE
        description: Delete Active Resource.
        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: type
          in: path
          type: string
          description: 'The Resource Type, may include a resource class: {type}.{class}.'
          required: true
        - name: resId
          in: path
          type: string
          description: The Resource ID.
          required: true
        - name: detach
          in: query
          type: boolean
          description: If set to `true`, will detach an active resource. The resource continues to exist and is not deleted,
            but it is no longer connected to the Platform Orchestrator
    - name: orgs-orgId-apps-appId-envs-envId-resources-type-resId-actions-pin
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/resources/{type}/{resId}/actions/pin
      operations:
      - name: pinactiveresource
        method: POST
        description: Pin Active Resource to a target Resource Definition Version.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-resources-defs-defId-resources
      path: /orgs/{orgId}/resources/defs/{defId}/resources
      operations:
      - name: listactiveresourcebydefinition
        method: GET
        description: List Active Resources provisioned via a specific Resource Definition.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: defId
          in: path
          type: string
          description: The Resource Definition ID.
          required: true
  exposes:
  - type: rest
    namespace: humanitec-activeresource-rest
    port: 8080
    description: REST adapter for Humanitec API — ActiveResource. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources
      name: orgs-orgid-apps-appid-envs-envid-resources
      description: REST surface for orgs-orgId-apps-appId-envs-envId-resources.
      operations:
      - method: GET
        name: listactiveresources
        description: List Active Resources provisioned in an environment.
        call: humanitec-activeresource.listactiveresources
        with:
          orgId: rest.orgId
          appId: rest.appId
          envId: rest.envId
          scheduled_deletion: rest.scheduled_deletion
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources/{type}/{resid}
      name: orgs-orgid-apps-appid-envs-envid-resources-type-resid
      description: REST surface for orgs-orgId-apps-appId-envs-envId-resources-type-resId.
      operations:
      - method: DELETE
        name: deleteactiveresource
        description: Delete Active Resource.
        call: humanitec-activeresource.deleteactiveresource
        with:
          orgId: rest.orgId
          appId: rest.appId
          envId: rest.envId
          type: rest.type
          resId: rest.resId
          detach: rest.detach
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources/{type}/{resid}/actions/pin
      name: orgs-orgid-apps-appid-envs-envid-resources-type-resid-actions-pin
      description: REST surface for orgs-orgId-apps-appId-envs-envId-resources-type-resId-actions-pin.
      operations:
      - method: POST
        name: pinactiveresource
        description: Pin Active Resource to a target Resource Definition Version.
        call: humanitec-activeresource.pinactiveresource
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{orgid}/resources/defs/{defid}/resources
      name: orgs-orgid-resources-defs-defid-resources
      description: REST surface for orgs-orgId-resources-defs-defId-resources.
      operations:
      - method: GET
        name: listactiveresourcebydefinition
        description: List Active Resources provisioned via a specific Resource Definition.
        call: humanitec-activeresource.listactiveresourcebydefinition
        with:
          orgId: rest.orgId
          defId: rest.defId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: humanitec-activeresource-mcp
    port: 9090
    transport: http
    description: MCP adapter for Humanitec API — ActiveResource. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-active-resources-provisioned-environment
      description: List Active Resources provisioned in an environment.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: humanitec-activeresource.listactiveresources
      with:
        orgId: tools.orgId
        appId: tools.appId
        envId: tools.envId
        scheduled_deletion: tools.scheduled_deletion
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-active-resource
      description: Delete Active Resource.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: humanitec-activeresource.deleteactiveresource
      with:
        orgId: tools.orgId
        appId: tools.appId
        envId: tools.envId
        type: tools.type
        resId: tools.resId
        detach: tools.detach
      outputParameters:
      - type: object
        mapping: $.
    - name: pin-active-resource-target-resource
      description: Pin Active Resource to a target Resource Definition Version.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: humanitec-activeresource.pinactiveresource
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-active-resources-provisioned-specific
      description: List Active Resources provisioned via a specific Resource Definition.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: humanitec-activeresource.listactiveresourcebydefinition
      with:
        orgId: tools.orgId
        defId: tools.defId
      outputParameters:
      - type: object
        mapping: $.