NInixopus
Deploy

Add project to family

Changed on

Add project to family.

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

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

Headers

Acceptstring

Request body */*

branchstring nullable

Git branch. Defaults to main if not specified

build_packstring nullable

Build strategy. Defaults to dockerfile if not specified

build_variablesobject nullable

Key-value pairs passed as build arguments to Docker

dockerfile_pathstring nullable

Path to the Dockerfile. Defaults to Dockerfile if not specified

domainsstring[] nullable

Custom domains for the application

environmentstring nullable

Deployment environment. Defaults to development if not specified

environment_variablesobject nullable

Key-value pairs set as runtime environment variables

family_idstring uuid

Family ID to add the application to. Creates new family if not provided

namestring required

Application name

pathstring

Base path for the application. Defaults to /

portinteger nullable

Port the application listens on. Defaults to 8080 if not specified

post_run_commandstring nullable

Command to run after the application starts

pre_run_commandstring nullable

Command to run before the application starts

repositorystring required

Numeric GitHub repository ID (get from GET /github-connector/repositories).

Example request

{
  "branch": "main",
  "build_pack": "dockerfile",
  "dockerfile_path": "Dockerfile",
  "environment": "development",
  "family_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "my-api",
  "path": "api/",
  "port": 8080,
  "post_run_command": "npm run seed",
  "pre_run_command": "npm run migrate",
  "repository": "912345678"
}

Response

Created

messagestring
statusstring

Changes

  • 09f18af670c4Revision changes
    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      removed the success response with the status

    • info

      api tag Deploy added

    • info

      api tag api/v1/deploy removed

    • info

      api tag application removed

    • info

      api tag project removed

    • info

      added the success response with the status

  • 7dc7276cdc50Revision changes
    • info

      added the optional property /////// to the response with the status (media type: application/json)

    • info

      added the optional property /////// to the response with the status (media type: application/xml)

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: application/xml)

    • info

      added the optional property ////// to the response with the status (media type: application/json)

    • info

      added the optional property ////// to the response with the status (media type: application/xml)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/xml)