---
title: "GET /environment.one"
method: GET
path: "/environment.one"
tags: ["environment"]
---

# GET /environment.one

`GET /environment.one`

## Query parameters

- `environmentId` string, required

## Response `200`

Successful response

- object
  - `applications` object[], required
    - `appName` string, required
    - `applicationId` string, required
    - `applicationStatus` 'idle' | 'running' | 'done' | 'error', required
    - `autoDeploy` boolean, nullable, required
    - `bitbucketBranch` string, nullable, required
    - `bitbucketBuildPath` string, nullable, required
    - `bitbucketId` string, nullable, required
    - `bitbucketOwner` string, nullable, required
    - `bitbucketRepository` string, nullable, required
    - `branch` string, nullable, required
    - `buildArgs` string, nullable, required
    - `buildPath` string, nullable, required
    - `buildType` 'dockerfile' | 'heroku_buildpacks' | 'paketo_buildpacks' | 'nixpacks' | 'static' | 'railpack', required
    - `cleanCache` boolean, nullable, required
    - `command` string, nullable, required
    - `cpuLimit` string, nullable, required
    - `cpuReservation` string, nullable, required
    - `createdAt` string, required
    - `customGitBranch` string, nullable, required
    - `customGitBuildPath` string, nullable, required
    - `customGitSSHKeyId` string, nullable, required
    - `customGitUrl` string, nullable, required
    - `description` string, nullable, required
    - `dockerBuildStage` string, nullable, required
    - `dockerContextPath` string, nullable, required
    - `dockerImage` string, nullable, required
    - `dockerfile` string, nullable, required
    - `dropBuildPath` string, nullable, required
    - `enableSubmodules` boolean, required
    - `enabled` boolean, nullable, required
    - `env` string, nullable, required
    - `environmentId` string, required
    - `giteaBranch` string, nullable, required
    - `giteaBuildPath` string, nullable, required
    - `giteaId` string, nullable, required
    - `giteaOwner` string, nullable, required
    - `giteaRepository` string, nullable, required
    - `githubId` string, nullable, required
    - `gitlabBranch` string, nullable, required
    - `gitlabBuildPath` string, nullable, required
    - `gitlabId` string, nullable, required
    - `gitlabOwner` string, nullable, required
    - `gitlabPathNamespace` string, nullable, required
    - `gitlabProjectId` number, nullable, required
    - `gitlabRepository` string, nullable, required
    - `healthCheckSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `herokuVersion` string, nullable, required
    - `isPreviewDeploymentsActive` boolean, nullable, required
    - `isStaticSpa` boolean, nullable, required
    - `labelsSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `memoryLimit` string, nullable, required
    - `memoryReservation` string, nullable, required
    - `modeSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `name` string, required
    - `networkSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `owner` string, nullable, required
    - `password` string, nullable, required
    - `placementSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `previewBuildArgs` string, nullable, required
    - `previewCertificateType` 'letsencrypt' | 'none' | 'custom', required
    - `previewCustomCertResolver` string, nullable, required
    - `previewEnv` string, nullable, required
    - `previewHttps` boolean, required
    - `previewLabels` string[], nullable, required
    - `previewLimit` number, nullable, required
    - `previewPath` string, nullable, required
    - `previewPort` number, nullable, required
    - `previewRequireCollaboratorPermissions` boolean, nullable, required
    - `previewWildcard` string, nullable, required
    - `publishDirectory` string, nullable, required
    - `railpackVersion` string, nullable, required
    - `refreshToken` string, nullable, required
    - `registryId` string, nullable, required
    - `registryUrl` string, nullable, required
    - `replicas` number, required
    - `repository` string, nullable, required
    - `restartPolicySwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `rollbackActive` boolean, nullable, required
    - `rollbackConfigSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `serverId` string, nullable, required
    - `sourceType` 'docker' | 'git' | 'github' | 'gitlab' | 'bitbucket' | 'gitea' | 'drop', required
    - `subtitle` string, nullable, required
    - `title` string, nullable, required
    - `triggerType` 'push' | 'tag', nullable, required
    - `updateConfigSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `username` string, nullable, required
    - `watchPaths` string[], nullable, required
  - `compose` object[], required
    - `appName` string, required
    - `autoDeploy` boolean, nullable, required
    - `bitbucketBranch` string, nullable, required
    - `bitbucketId` string, nullable, required
    - `bitbucketOwner` string, nullable, required
    - `bitbucketRepository` string, nullable, required
    - `branch` string, nullable, required
    - `command` string, required
    - `composeFile` string, required
    - `composeId` string, required
    - `composePath` string, required
    - `composeStatus` 'idle' | 'running' | 'done' | 'error', required
    - `composeType` 'docker-compose' | 'stack', required
    - `createdAt` string, required
    - `customGitBranch` string, nullable, required
    - `customGitSSHKeyId` string, nullable, required
    - `customGitUrl` string, nullable, required
    - `description` string, nullable, required
    - `enableSubmodules` boolean, required
    - `env` string, nullable, required
    - `environmentId` string, required
    - `giteaBranch` string, nullable, required
    - `giteaId` string, nullable, required
    - `giteaOwner` string, nullable, required
    - `giteaRepository` string, nullable, required
    - `githubId` string, nullable, required
    - `gitlabBranch` string, nullable, required
    - `gitlabId` string, nullable, required
    - `gitlabOwner` string, nullable, required
    - `gitlabPathNamespace` string, nullable, required
    - `gitlabProjectId` number, nullable, required
    - `gitlabRepository` string, nullable, required
    - `isolatedDeployment` boolean, required
    - `isolatedDeploymentsVolume` boolean, required
    - `name` string, required
    - `owner` string, nullable, required
    - `randomize` boolean, required
    - `refreshToken` string, nullable, required
    - `repository` string, nullable, required
    - `serverId` string, nullable, required
    - `sourceType` 'git' | 'github' | 'gitlab' | 'bitbucket' | 'gitea' | 'raw', required
    - `suffix` string, required
    - `triggerType` 'push' | 'tag', nullable, required
    - `watchPaths` string[], nullable, required
  - `createdAt` string, required
  - `description` string, nullable, required
  - `env` string, required
  - `environmentId` string, required
  - `mariadb` object[], required
    - `appName` string, required
    - `applicationStatus` 'idle' | 'running' | 'done' | 'error', required
    - `command` string, nullable, required
    - `cpuLimit` string, nullable, required
    - `cpuReservation` string, nullable, required
    - `createdAt` string, required
    - `databaseName` string, required
    - `databasePassword` string, required
    - `databaseRootPassword` string, required
    - `databaseUser` string, required
    - `description` string, nullable, required
    - `dockerImage` string, required
    - `env` string, nullable, required
    - `environmentId` string, required
    - `externalPort` number, nullable, required
    - `healthCheckSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `labelsSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `mariadbId` string, required
    - `memoryLimit` string, nullable, required
    - `memoryReservation` string, nullable, required
    - `modeSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `name` string, required
    - `networkSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `placementSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `replicas` number, required
    - `restartPolicySwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `rollbackConfigSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `serverId` string, nullable, required
    - `updateConfigSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
  - `mongo` object[], required
    - `appName` string, required
    - `applicationStatus` 'idle' | 'running' | 'done' | 'error', required
    - `command` string, nullable, required
    - `cpuLimit` string, nullable, required
    - `cpuReservation` string, nullable, required
    - `createdAt` string, required
    - `databasePassword` string, required
    - `databaseUser` string, required
    - `description` string, nullable, required
    - `dockerImage` string, required
    - `env` string, nullable, required
    - `environmentId` string, required
    - `externalPort` number, nullable, required
    - `healthCheckSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `labelsSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `memoryLimit` string, nullable, required
    - `memoryReservation` string, nullable, required
    - `modeSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `mongoId` string, required
    - `name` string, required
    - `networkSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `placementSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `replicaSets` boolean, nullable, required
    - `replicas` number, required
    - `restartPolicySwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `rollbackConfigSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `serverId` string, nullable, required
    - `updateConfigSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
  - `mysql` object[], required
    - `appName` string, required
    - `applicationStatus` 'idle' | 'running' | 'done' | 'error', required
    - `command` string, nullable, required
    - `cpuLimit` string, nullable, required
    - `cpuReservation` string, nullable, required
    - `createdAt` string, required
    - `databaseName` string, required
    - `databasePassword` string, required
    - `databaseRootPassword` string, required
    - `databaseUser` string, required
    - `description` string, nullable, required
    - `dockerImage` string, required
    - `env` string, nullable, required
    - `environmentId` string, required
    - `externalPort` number, nullable, required
    - `healthCheckSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `labelsSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `memoryLimit` string, nullable, required
    - `memoryReservation` string, nullable, required
    - `modeSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `mysqlId` string, required
    - `name` string, required
    - `networkSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `placementSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `replicas` number, required
    - `restartPolicySwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `rollbackConfigSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `serverId` string, nullable, required
    - `updateConfigSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
  - `name` string, required
  - `postgres` object[], required
    - `appName` string, required
    - `applicationStatus` 'idle' | 'running' | 'done' | 'error', required
    - `command` string, nullable, required
    - `cpuLimit` string, nullable, required
    - `cpuReservation` string, nullable, required
    - `createdAt` string, required
    - `databaseName` string, required
    - `databasePassword` string, required
    - `databaseUser` string, required
    - `description` string, nullable, required
    - `dockerImage` string, required
    - `env` string, nullable, required
    - `environmentId` string, required
    - `externalPort` number, nullable, required
    - `healthCheckSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `labelsSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `memoryLimit` string, nullable, required
    - `memoryReservation` string, nullable, required
    - `modeSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `name` string, required
    - `networkSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `placementSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `postgresId` string, required
    - `replicas` number, required
    - `restartPolicySwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `rollbackConfigSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `serverId` string, nullable, required
    - `updateConfigSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
  - `project` object, required
    - `createdAt` string, required
    - `description` string, nullable, required
    - `env` string, required
    - `name` string, required
    - `organizationId` string, required
    - `projectId` string, required
  - `projectId` string, required
  - `redis` object[], required
    - `appName` string, required
    - `applicationStatus` 'idle' | 'running' | 'done' | 'error', required
    - `command` string, nullable, required
    - `cpuLimit` string, nullable, required
    - `cpuReservation` string, nullable, required
    - `createdAt` string, required
    - `databasePassword` string, required
    - `description` string, nullable, required
    - `dockerImage` string, required
    - `env` string, nullable, required
    - `environmentId` string, required
    - `externalPort` number, nullable, required
    - `healthCheckSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `labelsSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `memoryLimit` string, nullable, required
    - `memoryReservation` string, nullable, required
    - `modeSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `name` string, required
    - `networkSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `placementSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `redisId` string, required
    - `replicas` number, required
    - `restartPolicySwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `rollbackConfigSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object
    - `serverId` string, nullable, required
    - `updateConfigSwarm` union, required
      - string
      - number
      - boolean
      - 'null', nullable
      - unknown[]
        - unknown
      - object

## Other responses

- `default` — Error response

---

[API](https://skmtc.net/charliedevelops/apis/dokploy-api.md) · [All operations](https://skmtc.net/charliedevelops/apis/dokploy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/charliedevelops/dokploy-api/revisions/50e2e470fdd0/schema)