Skip to content
Appaloft 文档 v0.6.0

deployments.list

GET
/deployments
 
curl --request GET \
  --url https://example.com/api/deployments

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
projectId
string
resourceId
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
items
required
Array<object>
object
id
required
string
projectId
required
string
environmentId
required
string
resourceId
required
string
serverId
required
string
destinationId
required
string
status
required
string
Allowed values: created planning planned running cancel-requested succeeded failed canceled rolled-back
sourceCommitSha
string
runtimePlan
required
object
id
required
string
source
required
object
kind
required
string
Allowed values: local-folder local-git remote-git git-public git-github-app git-deploy-key zip-artifact dockerfile-inline docker-compose-inline docker-image compose
locator
required
string
displayName
required
string
integrationKey
string
inspection
object
runtimeFamily
string
Allowed values: custom dotnet elixir go java node php python ruby rust static
framework
string
Allowed values: actix-web angular astro aspnet-core axum chi django echo express fastapi fastify fiber flask gin hono koa laravel micronaut nestjs nextjs nuxt phoenix quarkus rails react remix rocket sinatra spring-boot solid svelte sveltekit symfony vite vue
packageManager
string
Allowed values: bun cargo composer dotnet go gradle maven mix npm pip pnpm poetry uv yarn
applicationShape
string
Allowed values: static serverful-http ssr hybrid-static-server worker container-native
runtimeVersion
string
projectName
string
detectedFiles
Array<string>
Allowed values: angular-json astro-config bun-lock cargo-toml composer-json compose-manifest csproj django-manage dockerfile git-directory go-mod gradle-build gradle-wrapper mix-exs maven-wrapper next-app-router next-config next-pages-router next-standalone-output next-static-output nuxt-config package-lock package-json pnpm-lock poetry-lock pom-xml pyproject-toml requirements-txt remix-config svelte-config uv-lock vite-config yarn-lock
detectedScripts
Array<string>
Allowed values: build dev export generate preview serve start start-built
dockerfilePath
string
composeFilePath
string
jarPath
string
metadata
object
key
additional properties
string
buildStrategy
required
string
Allowed values: dockerfile compose-deploy buildpack static-artifact prebuilt-image workspace-commands
packagingMode
required
string
Allowed values: split-deploy all-in-one-docker compose-bundle host-process-runtime optional-future-binary
runtimeArtifact
object
kind
required
string
Allowed values: image compose-project
intent
required
string
Allowed values: build-image prebuilt-image compose-project
image
string
composeFile
string
metadata
object
key
additional properties
string
execution
required
object
kind
required
string
Allowed values: docker-container docker-compose-stack host-process
workingDirectory
string
installCommand
string
buildCommand
string
startCommand
string
healthCheckPath
string
healthCheck
object
enabled
required
boolean
type
required
string
Allowed values: http command
intervalSeconds
required
integer
> 0 <= 9007199254740991
timeoutSeconds
required
integer
> 0 <= 9007199254740991
retries
required
integer
> 0 <= 9007199254740991
startPeriodSeconds
required
integer
<= 9007199254740991
http
object
method
required
string
Allowed values: GET HEAD POST OPTIONS
scheme
required
string
Allowed values: http https
host
required
string
port
integer
> 0 <= 65535
path
required
string
expectedStatusCode
required
integer
>= 100 <= 599
expectedResponseText
string
port
integer
> 0 <= 9007199254740991
image
string
dockerfilePath
string
composeFile
string
accessRoutes
Array<object>
object
proxyKind
required
string
Allowed values: none traefik caddy
domains
required
Array<string>
pathPrefix
required
string
tlsMode
required
string
Allowed values: auto disabled
targetPort
integer
> 0 <= 9007199254740991
verificationSteps
Array<object>
object
kind
required
string
Allowed values: internal-http public-http
label
required
string
metadata
object
key
additional properties
string
target
required
object
kind
required
string
Allowed values: single-server future-multi-server future-k8s
providerKey
required
string
serverIds
required
Array<string>
metadata
object
key
additional properties
string
detectSummary
required
string
steps
required
Array<string>
generatedAt
required
string
environmentSnapshot
required
object
id
required
string
environmentId
required
string
createdAt
required
string
precedence
required
Array<string>
variables
required
Array<object>
object
key
required
string
value
required
string
scope
required
string
exposure
required
string
Allowed values: build-time runtime
isSecret
required
boolean
kind
required
string
logs
required
Array<object>
object
timestamp
required
string
source
required
string
Allowed values: appaloft application
phase
required
string
Allowed values: detect plan package deploy verify rollback
level
required
string
Allowed values: debug info warn error
message
required
string
masked
boolean
logCount
required
number
createdAt
required
string
startedAt
string
finishedAt
string
rollbackOfDeploymentId
string
Example 
{
  "items": [
    {
      "status": "created",
      "runtimePlan": {
        "source": {
          "kind": "local-folder",
          "inspection": {
            "runtimeFamily": "custom",
            "framework": "actix-web",
            "packageManager": "bun",
            "applicationShape": "static",
            "detectedFiles": [
              "angular-json"
            ],
            "detectedScripts": [
              "build"
            ]
          }
        },
        "buildStrategy": "dockerfile",
        "packagingMode": "split-deploy",
        "runtimeArtifact": {
          "kind": "image",
          "intent": "build-image"
        },
        "execution": {
          "kind": "docker-container",
          "healthCheck": {
            "type": "http",
            "http": {
              "method": "GET",
              "scheme": "http"
            }
          },
          "accessRoutes": [
            {
              "proxyKind": "none",
              "tlsMode": "auto"
            }
          ],
          "verificationSteps": [
            {
              "kind": "internal-http"
            }
          ]
        },
        "target": {
          "kind": "single-server"
        }
      },
      "environmentSnapshot": {
        "variables": [
          {
            "exposure": "build-time"
          }
        ]
      },
      "logs": [
        {
          "source": "appaloft",
          "phase": "detect",
          "level": "debug"
        }
      ]
    }
  ]
}