Convex Management API — Deployments

naftiko: 1.0.0-alpha2
info:
  label: Convex Management API — Deployments
  description: 'Convex Management API — Deployments. 5 operations. Lead operation: Get a deployment by name. Self-contained
    Naftiko capability covering one Convex business surface.'
  tags:
  - Convex
  - Deployments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CONVEX_API_KEY: CONVEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: management-deployments
    baseUri: https://api.convex.dev/v1
    description: Convex Management API — Deployments business capability. Self-contained, no shared references.
    resources:
    - name: deployments-deployment_name
      path: /deployments/{deployment_name}
      operations:
      - name: getdeployment
        method: GET
        description: Get a deployment by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: deployments-deployment_name-delete
      path: /deployments/{deployment_name}/delete
      operations:
      - name: deletedeployment
        method: POST
        description: Delete a deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: projects-project_id-deployment-default_prod
      path: /projects/{project_id}/deployment/default_prod
      operations:
      - name: getdefaultproddeployment
        method: GET
        description: Get default production deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: projects-project_id-deployments-create_cloud
      path: /projects/{project_id}/deployments/create_cloud
      operations:
      - name: createclouddeployment
        method: POST
        description: Create a cloud deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: projects-project_id-deployments-list
      path: /projects/{project_id}/deployments/list
      operations:
      - name: listdeployments
        method: GET
        description: List deployments in a project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.CONVEX_API_KEY}}'
  exposes:
  - type: rest
    namespace: management-deployments-rest
    port: 8080
    description: REST adapter for Convex Management API — Deployments. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/deployments/{deployment-name}
      name: deployments-deployment-name
      description: REST surface for deployments-deployment_name.
      operations:
      - method: GET
        name: getdeployment
        description: Get a deployment by name
        call: management-deployments.getdeployment
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/deployments/{deployment-name}/delete
      name: deployments-deployment-name-delete
      description: REST surface for deployments-deployment_name-delete.
      operations:
      - method: POST
        name: deletedeployment
        description: Delete a deployment
        call: management-deployments.deletedeployment
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/deployment/default-prod
      name: projects-project-id-deployment-default-prod
      description: REST surface for projects-project_id-deployment-default_prod.
      operations:
      - method: GET
        name: getdefaultproddeployment
        description: Get default production deployment
        call: management-deployments.getdefaultproddeployment
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/deployments/create-cloud
      name: projects-project-id-deployments-create-cloud
      description: REST surface for projects-project_id-deployments-create_cloud.
      operations:
      - method: POST
        name: createclouddeployment
        description: Create a cloud deployment
        call: management-deployments.createclouddeployment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/deployments/list
      name: projects-project-id-deployments-list
      description: REST surface for projects-project_id-deployments-list.
      operations:
      - method: GET
        name: listdeployments
        description: List deployments in a project
        call: management-deployments.listdeployments
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: management-deployments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Convex Management API — Deployments. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-deployment-name
      description: Get a deployment by name
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: management-deployments.getdeployment
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-deployment
      description: Delete a deployment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: management-deployments.deletedeployment
      outputParameters:
      - type: object
        mapping: $.
    - name: get-default-production-deployment
      description: Get default production deployment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: management-deployments.getdefaultproddeployment
      outputParameters:
      - type: object
        mapping: $.
    - name: create-cloud-deployment
      description: Create a cloud deployment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: management-deployments.createclouddeployment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-deployments-project
      description: List deployments in a project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: management-deployments.listdeployments
      outputParameters:
      - type: object
        mapping: $.