Qovery API — Environment Main Calls

naftiko: 1.0.0-alpha2
info:
  label: Qovery API — Environment Main Calls
  description: 'Qovery API — Environment Main Calls. 9 operations. Lead operation: Get environment by ID. Self-contained Naftiko
    capability covering one Qovery business surface.'
  tags:
  - Qovery
  - Environment Main Calls
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    QOVERY_API_KEY: QOVERY_API_KEY
capability:
  consumes:
  - type: http
    namespace: qovery-environment-main-calls
    baseUri: https://api.qovery.com
    description: Qovery API — Environment Main Calls business capability. Self-contained, no shared references.
    resources:
    - name: environment-environmentId
      path: /environment/{environmentId}
      operations:
      - name: getenvironment
        method: GET
        description: Get environment by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: editenvironment
        method: PUT
        description: Edit an environment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteenvironment
        method: DELETE
        description: Delete an environment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: environment-environmentId-deploymentQueue
      path: /environment/{environmentId}/deploymentQueue
      operations:
      - name: listdeploymentrequestbyenvironmentid
        method: GET
        description: List Deployment Queue Request By EnvironmentId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: environment-environmentId-services
      path: /environment/{environmentId}/services
      operations:
      - name: listservicesbyenvironmentid
        method: GET
        description: List Services By EnvironmentId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: environment-environmentId-status
      path: /environment/{environmentId}/status
      operations:
      - name: getenvironmentstatus
        method: GET
        description: Get environment status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: environment-environmentId-statuses
      path: /environment/{environmentId}/statuses
      operations:
      - name: getenvironmentstatuses
        method: GET
        description: Get environment statuses with services status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: environment-environmentId-statusesWithStages
      path: /environment/{environmentId}/statusesWithStages
      operations:
      - name: getenvironmentstatuseswithstages
        method: GET
        description: Get environment statuses with stages
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: service-serviceId-deploymentQueue
      path: /service/{serviceId}/deploymentQueue
      operations:
      - name: listdeploymentrequestbyserviceid
        method: GET
        description: List Deployment Queue Request By ServiceId
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.QOVERY_API_KEY}}'
  exposes:
  - type: rest
    namespace: qovery-environment-main-calls-rest
    port: 8080
    description: REST adapter for Qovery API — Environment Main Calls. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/environment/{environmentid}
      name: environment-environmentid
      description: REST surface for environment-environmentId.
      operations:
      - method: GET
        name: getenvironment
        description: Get environment by ID
        call: qovery-environment-main-calls.getenvironment
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: editenvironment
        description: Edit an environment
        call: qovery-environment-main-calls.editenvironment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteenvironment
        description: Delete an environment
        call: qovery-environment-main-calls.deleteenvironment
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/environment/{environmentid}/deploymentqueue
      name: environment-environmentid-deploymentqueue
      description: REST surface for environment-environmentId-deploymentQueue.
      operations:
      - method: GET
        name: listdeploymentrequestbyenvironmentid
        description: List Deployment Queue Request By EnvironmentId
        call: qovery-environment-main-calls.listdeploymentrequestbyenvironmentid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/environment/{environmentid}/services
      name: environment-environmentid-services
      description: REST surface for environment-environmentId-services.
      operations:
      - method: GET
        name: listservicesbyenvironmentid
        description: List Services By EnvironmentId
        call: qovery-environment-main-calls.listservicesbyenvironmentid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/environment/{environmentid}/status
      name: environment-environmentid-status
      description: REST surface for environment-environmentId-status.
      operations:
      - method: GET
        name: getenvironmentstatus
        description: Get environment status
        call: qovery-environment-main-calls.getenvironmentstatus
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/environment/{environmentid}/statuses
      name: environment-environmentid-statuses
      description: REST surface for environment-environmentId-statuses.
      operations:
      - method: GET
        name: getenvironmentstatuses
        description: Get environment statuses with services status
        call: qovery-environment-main-calls.getenvironmentstatuses
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/environment/{environmentid}/statuseswithstages
      name: environment-environmentid-statuseswithstages
      description: REST surface for environment-environmentId-statusesWithStages.
      operations:
      - method: GET
        name: getenvironmentstatuseswithstages
        description: Get environment statuses with stages
        call: qovery-environment-main-calls.getenvironmentstatuseswithstages
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/service/{serviceid}/deploymentqueue
      name: service-serviceid-deploymentqueue
      description: REST surface for service-serviceId-deploymentQueue.
      operations:
      - method: GET
        name: listdeploymentrequestbyserviceid
        description: List Deployment Queue Request By ServiceId
        call: qovery-environment-main-calls.listdeploymentrequestbyserviceid
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: qovery-environment-main-calls-mcp
    port: 9090
    transport: http
    description: MCP adapter for Qovery API — Environment Main Calls. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-environment-id
      description: Get environment by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qovery-environment-main-calls.getenvironment
      outputParameters:
      - type: object
        mapping: $.
    - name: edit-environment
      description: Edit an environment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: qovery-environment-main-calls.editenvironment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-environment
      description: Delete an environment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: qovery-environment-main-calls.deleteenvironment
      outputParameters:
      - type: object
        mapping: $.
    - name: list-deployment-queue-request-environmentid
      description: List Deployment Queue Request By EnvironmentId
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qovery-environment-main-calls.listdeploymentrequestbyenvironmentid
      outputParameters:
      - type: object
        mapping: $.
    - name: list-services-environmentid
      description: List Services By EnvironmentId
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qovery-environment-main-calls.listservicesbyenvironmentid
      outputParameters:
      - type: object
        mapping: $.
    - name: get-environment-status
      description: Get environment status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qovery-environment-main-calls.getenvironmentstatus
      outputParameters:
      - type: object
        mapping: $.
    - name: get-environment-statuses-services-status
      description: Get environment statuses with services status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qovery-environment-main-calls.getenvironmentstatuses
      outputParameters:
      - type: object
        mapping: $.
    - name: get-environment-statuses-stages
      description: Get environment statuses with stages
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qovery-environment-main-calls.getenvironmentstatuseswithstages
      outputParameters:
      - type: object
        mapping: $.
    - name: list-deployment-queue-request-serviceid
      description: List Deployment Queue Request By ServiceId
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: qovery-environment-main-calls.listdeploymentrequestbyserviceid
      outputParameters:
      - type: object
        mapping: $.