---
title: "Add project to family"
method: POST
path: "/api/v1/deploy/application/project/add-to-family"
tags: ["Deploy"]
---

# Add project to family

`POST /api/v1/deploy/application/project/add-to-family`

## Request

- Base URL: `http://:8080`
- URL: `http://:8080/api/v1/deploy/application/project/add-to-family`
- Auth: none declared

Add project to family.

Auth: Required (bearer token).
Scope: Organization-scoped in authenticated context.
Side effects: May mutate server state.

## Headers

- `Accept` string

## Request body `*/*`

- AddApplicationToFamilyRequest: AddApplicationToFamilyRequest schema
  - `branch` string, nullable: Git branch. Defaults to main if not specified
  - `build_pack` string, nullable: Build strategy. Defaults to dockerfile if not specified
  - `build_variables` object, nullable: Key-value pairs passed as build arguments to Docker
  - `dockerfile_path` string, nullable: Path to the Dockerfile. Defaults to Dockerfile if not specified
  - `domains` string[], nullable: Custom domains for the application
  - `environment` string, nullable: Deployment environment. Defaults to development if not specified
  - `environment_variables` object, nullable: Key-value pairs set as runtime environment variables
  - `family_id` string, uuid: Family ID to add the application to. Creates new family if not provided
  - `name` string, required: Application name
  - `path` string: Base path for the application. Defaults to /
  - `port` integer, nullable: Port the application listens on. Defaults to 8080 if not specified
  - `post_run_command` string, nullable: Command to run after the application starts
  - `pre_run_command` string, nullable: Command to run before the application starts
  - `repository` string, required: Numeric GitHub repository ID (get from GET /github-connector/repositories).

## Response `201`

Created

- ApplicationResponse: ApplicationResponse schema
  - `data` object
    - `base_path` string
    - `branch` string
    - `build_pack` string
    - `build_variables` string
    - `compose_services` object[], nullable
      - `application_id` string, uuid
      - `created_at` string, date-time
      - `domains` object[], nullable
        - `application_id` string, uuid
        - `compose_service` ComposeService
          - `application_id` string, uuid
          - `created_at` string, date-time
          - `domains` object[], nullable
            - `application_id` string, uuid
            - `compose_service` ComposeService (recursive)
            - `compose_service_id` string, uuid
            - `created_at` string, date-time
            - `domain` string
            - `id` string, uuid
            - `port` integer, nullable
          - `id` string, uuid
          - `port` integer
          - `service_name` string
          - `updated_at` string, date-time
        - `compose_service_id` string, uuid
        - `created_at` string, date-time
        - `domain` string
        - `id` string, uuid
        - `port` integer, nullable
      - `id` string, uuid
      - `port` integer
      - `service_name` string
      - `updated_at` string, date-time
    - `created_at` string, date-time
    - `deployments` object[], nullable
      - `application` Application, nullable
        - `base_path` string
        - `branch` string
        - `build_pack` string
        - `build_variables` string
        - `compose_services` object[], nullable
          - `application_id` string, uuid
          - `created_at` string, date-time
          - `domains` object[], nullable
            - `application_id` string, uuid
            - `compose_service` ComposeService
              - …
            - `compose_service_id` string, uuid
            - `created_at` string, date-time
            - `domain` string
            - `id` string, uuid
            - `port` integer, nullable
          - `id` string, uuid
          - `port` integer
          - `service_name` string
          - `updated_at` string, date-time
        - `created_at` string, date-time
        - `deployments` ApplicationDeployment[], nullable
          - `application` object, nullable
            - `base_path` string
            - `branch` string
            - `build_pack` string
            - `build_variables` string
            - `compose_services` object[], nullable
              - …
            - `created_at` string, date-time
            - `deployments` ApplicationDeployment[], nullable
            - `dockerfile_path` string
            - `domains` object[], nullable
              - …
            - `environment` string
            - `environment_variables` string
            - `family_id` string, uuid
            - `id` string, uuid
            - `is_live_deployment` boolean
            - `labels` string[], nullable
            - `logs` object[], nullable
              - …
            - `name` string
            - `organization_id` string, uuid
            - `port` integer
            - `post_run_command` string
            - `pre_run_command` string
            - `proxy_server` string
            - `repository` string
            - `routing_strategy` string
            - `servers` object[], nullable
              - …
            - `source` string
            - `status` object, nullable
              - …
            - `template_id` string, uuid
            - `updated_at` string, date-time
            - `user_id` string, uuid
          - `application_id` string, uuid
          - `children` ApplicationDeployment[], nullable
          - `commit_hash` string
          - `container_id` string, uuid
          - `container_image` string
          - `container_name` string
          - `container_status` string
          - `created_at` string, date-time
          - `id` string, uuid
          - `image_s3_key` string
          - `image_size` integer
          - `logs` object[], nullable
            - `application_deployment_id` string, uuid
            - `application_id` string, uuid
            - `created_at` string, date-time
            - `id` string, uuid
            - `log` string
            - `updated_at` string, date-time
          - `parent_deployment_id` string, uuid
          - `server_id` string, uuid
          - `status` object, nullable
            - `application_deployment_id` string, uuid
            - `created_at` string, date-time
            - `id` string, uuid
            - `status` string
            - `updated_at` string, date-time
          - `updated_at` string, date-time
        - `dockerfile_path` string
        - `domains` object[], nullable
          - `application_id` string, uuid
          - `compose_service` object, nullable
            - `application_id` string, uuid
            - `created_at` string, date-time
            - `domains` ApplicationDomain[]
              - …
            - `id` string, uuid
            - `port` integer
            - `service_name` string
            - `updated_at` string, date-time
          - `compose_service_id` string, uuid
          - `created_at` string, date-time
          - `domain` string
          - `id` string, uuid
          - `port` integer, nullable
        - `environment` string
        - `environment_variables` string
        - `family_id` string, uuid
        - `id` string, uuid
        - `is_live_deployment` boolean
        - `labels` string[], nullable
        - `logs` object[], nullable
          - `application_deployment_id` string, uuid
          - `application_id` string, uuid
          - `created_at` string, date-time
          - `id` string, uuid
          - `log` string
          - `updated_at` string, date-time
        - `name` string
        - `organization_id` string, uuid
        - `port` integer
        - `post_run_command` string
        - `pre_run_command` string
        - `proxy_server` string
        - `repository` string
        - `routing_strategy` string
        - `servers` object[], nullable
          - `application_id` string, uuid
          - `created_at` string, date-time
          - `id` string, uuid
          - `is_primary` boolean
          - `server` object, nullable
            - `auth_method` string
            - `created_at` string, date-time
            - `deleted_at` string, date-time, nullable
            - `description` string, nullable
            - `fingerprint` string, nullable
            - `host` string, nullable
            - `id` string, uuid
            - `is_active` boolean
            - `is_default` boolean
            - `key_size` integer, nullable
            - `key_type` string, nullable
            - `last_used_at` string, date-time, nullable
            - `name` string
            - `organization_id` string, uuid
            - `port` integer, nullable
            - `proxy_host` string, nullable
            - `public_key` string, nullable
            - `updated_at` string, date-time
            - `user` string, nullable
          - `server_id` string, uuid
        - `source` string
        - `status` object, nullable
          - `application_id` string, uuid
          - `created_at` string, date-time
          - `id` string, uuid
          - `status` string
          - `updated_at` string, date-time
        - `template_id` string, uuid
        - `updated_at` string, date-time
        - `user_id` string, uuid
      - `application_id` string, uuid
      - `children` ApplicationDeployment[]
        - `application` object, nullable
          - `base_path` string
          - `branch` string
          - `build_pack` string
          - `build_variables` string
          - `compose_services` object[], nullable
            - `application_id` string, uuid
            - `created_at` string, date-time
            - `domains` object[], nullable
              - …
            - `id` string, uuid
            - `port` integer
            - `service_name` string
            - `updated_at` string, date-time
          - `created_at` string, date-time
          - `deployments` ApplicationDeployment[], nullable
          - `dockerfile_path` string
          - `domains` object[], nullable
            - `application_id` string, uuid
            - `compose_service` object, nullable
              - …
            - `compose_service_id` string, uuid
            - `created_at` string, date-time
            - `domain` string
            - `id` string, uuid
            - `port` integer, nullable
          - `environment` string
          - `environment_variables` string
          - `family_id` string, uuid
          - `id` string, uuid
          - `is_live_deployment` boolean
          - `labels` string[], nullable
          - `logs` object[], nullable
            - `application_deployment_id` string, uuid
            - `application_id` string, uuid
            - `created_at` string, date-time
            - `id` string, uuid
            - `log` string
            - `updated_at` string, date-time
          - `name` string
          - `organization_id` string, uuid
          - `port` integer
          - `post_run_command` string
          - `pre_run_command` string
          - `proxy_server` string
          - `repository` string
          - `routing_strategy` string
          - `servers` object[], nullable
            - `application_id` string, uuid
            - `created_at` string, date-time
            - `id` string, uuid
            - `is_primary` boolean
            - `server` object, nullable
              - …
            - `server_id` string, uuid
          - `source` string
          - `status` object, nullable
            - `application_id` string, uuid
            - `created_at` string, date-time
            - `id` string, uuid
            - `status` string
            - `updated_at` string, date-time
          - `template_id` string, uuid
          - `updated_at` string, date-time
          - `user_id` string, uuid
        - `application_id` string, uuid
        - `children` ApplicationDeployment[], nullable
        - `commit_hash` string
        - `container_id` string, uuid
        - `container_image` string
        - `container_name` string
        - `container_status` string
        - `created_at` string, date-time
        - `id` string, uuid
        - `image_s3_key` string
        - `image_size` integer
        - `logs` object[], nullable
          - `application_deployment_id` string, uuid
          - `application_id` string, uuid
          - `created_at` string, date-time
          - `id` string, uuid
          - `log` string
          - `updated_at` string, date-time
        - `parent_deployment_id` string, uuid
        - `server_id` string, uuid
        - `status` object, nullable
          - `application_deployment_id` string, uuid
          - `created_at` string, date-time
          - `id` string, uuid
          - `status` string
          - `updated_at` string, date-time
        - `updated_at` string, date-time
      - `commit_hash` string
      - `container_id` string, uuid
      - `container_image` string
      - `container_name` string
      - `container_status` string
      - `created_at` string, date-time
      - `id` string, uuid
      - `image_s3_key` string
      - `image_size` integer
      - `logs` object[], nullable
        - `application_deployment_id` string, uuid
        - `application_id` string, uuid
        - `created_at` string, date-time
        - `id` string, uuid
        - `log` string
        - `updated_at` string, date-time
      - `parent_deployment_id` string, uuid
      - `server_id` string, uuid
      - `status` object, nullable
        - `application_deployment_id` string, uuid
        - `created_at` string, date-time
        - `id` string, uuid
        - `status` string
        - `updated_at` string, date-time
      - `updated_at` string, date-time
    - `dockerfile_path` string
    - `domains` object[], nullable
      - `application_id` string, uuid
      - `compose_service` object, nullable
        - `application_id` string, uuid
        - `created_at` string, date-time
        - `domains` ApplicationDomain[]
          - `application_id` string, uuid
          - `compose_service` ComposeService
            - `application_id` string, uuid
            - `created_at` string, date-time
            - `domains` object[], nullable
              - …
            - `id` string, uuid
            - `port` integer
            - `service_name` string
            - `updated_at` string, date-time
          - `compose_service_id` string, uuid
          - `created_at` string, date-time
          - `domain` string
          - `id` string, uuid
          - `port` integer, nullable
        - `id` string, uuid
        - `port` integer
        - `service_name` string
        - `updated_at` string, date-time
      - `compose_service_id` string, uuid
      - `created_at` string, date-time
      - `domain` string
      - `id` string, uuid
      - `port` integer, nullable
    - `environment` string
    - `environment_variables` string
    - `family_id` string, uuid
    - `id` string, uuid
    - `is_live_deployment` boolean
    - `labels` string[], nullable
    - `logs` object[], nullable
      - `application_deployment_id` string, uuid
      - `application_id` string, uuid
      - `created_at` string, date-time
      - `id` string, uuid
      - `log` string
      - `updated_at` string, date-time
    - `name` string
    - `organization_id` string, uuid
    - `port` integer
    - `post_run_command` string
    - `pre_run_command` string
    - `proxy_server` string
    - `repository` string
    - `routing_strategy` string
    - `servers` object[], nullable
      - `application_id` string, uuid
      - `created_at` string, date-time
      - `id` string, uuid
      - `is_primary` boolean
      - `server` object, nullable
        - `auth_method` string
        - `created_at` string, date-time
        - `deleted_at` string, date-time, nullable
        - `description` string, nullable
        - `fingerprint` string, nullable
        - `host` string, nullable
        - `id` string, uuid
        - `is_active` boolean
        - `is_default` boolean
        - `key_size` integer, nullable
        - `key_type` string, nullable
        - `last_used_at` string, date-time, nullable
        - `name` string
        - `organization_id` string, uuid
        - `port` integer, nullable
        - `proxy_host` string, nullable
        - `public_key` string, nullable
        - `updated_at` string, date-time
        - `user` string, nullable
      - `server_id` string, uuid
    - `source` string
    - `status` object, nullable
      - `application_id` string, uuid
      - `created_at` string, date-time
      - `id` string, uuid
      - `status` string
      - `updated_at` string, date-time
    - `template_id` string, uuid
    - `updated_at` string, date-time
    - `user_id` string, uuid
  - `message` string
  - `status` string

## Other responses

- `400`: Bad Request _(validation or deserialization error)_
- `500`: Internal Server Error _(panics)_
- `default`

## Changes

- **2026-04-26** `09f18af670c4`: 3 breaking, 5 info
  - the request property `name` became required
  - the request property `repository` became required
  - removed the success response with the status `200`
  - api tag `Deploy` added
  - …4 more
- **2026-04-20** `7dc7276cdc50`: 8 info
  - added the optional property `data/deployments/items/application/deployments/items/application/template_id` to the response with the `200` status (media type: application/json)
  - added the optional property `data/deployments/items/application/deployments/items/application/template_id` to the response with the `200` status (media type: application/xml)
  - added the optional property `data/deployments/items/application/template_id` to the response with the `200` status (media type: application/json)
  - added the optional property `data/deployments/items/application/template_id` to the response with the `200` status (media type: application/xml)
  - …4 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/nixopus/apis/nixopus-api/changes/api/v1/deploy/application/project/add-to-family/post.md)

---

[API](https://skmtc.dev/nixopus/apis/nixopus-api.md) - [All operations](https://skmtc.dev/nixopus/apis/nixopus-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nixopus/apis/nixopus-api/revisions/c5bacaea7239?raw)