Deploy

Preview compose services

Changed on Apr 26, 2026

Preview compose services.

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

post/api/v1/deploy/application/preview-compose

Request

Base URL
http://:8080
URL
http://:8080/api/v1/deploy/application/preview-compose
Auth
none declared

Headers

Acceptstring

Request body /

base_pathstring nullable

Base path within the repository

branchstring required

Git branch to preview

dockerfile_pathstring nullable

Path to the Dockerfile

repositorystring required

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

Example request

{
  "base_path": "/",
  "branch": "main",
  "dockerfile_path": "Dockerfile",
  "repository": "912345678"
}

Response

Example response

{
  "services": [
    {
      "port": 8080,
      "service_name": "web"
    }
  ]
}

Changes

Apr 26, 202609f18af670c4 Revision changes
- breaking
  the request property became required
- breaking
  the request property became required
- info
  api tag Deploy added
- info
  api tag api/v1/deploy removed
- info
  api tag application removed
- info
  api tag preview-compose removed
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: application/xml)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: application/xml)
Apr 2, 20262beb810c5221 Revision changes
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- info
  api operation id createPreviewCompose removed and replaced with previewComposeServices
- 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 required property to the response with the status (media type: application/json)
- info
  added the required property to the response with the status (media type: application/xml)
- info
  added the required property to the response with the status (media type: application/json)
- info
  added the required property to the response with the status (media type: application/xml)
- info
  added the required property to the response with the status (media type: application/json)
- info
  added the required property to the response with the status (media type: application/xml)
- info
  added the required property to the response with the status (media type: application/json)
- info
  added the required property to the response with the status (media type: application/xml)

Operation history (5 revisions)