---
title: "Get a single environment deployment"
method: GET
path: "/projects/{projectId}/environments/{environmentId}/deployments/{deploymentId}"
tags: ["Deployment"]
---

# Get a single environment deployment

`GET /projects/{projectId}/environments/{environmentId}/deployments/{deploymentId}`

Retrieve a single deployment configuration with an id of `current`. This may be subject to change in the future.
Only `current` can be queried.

## Path parameters

- `projectId` string, required
- `environmentId` string, required
- `deploymentId` string, required

## Response `default`

- Deployment
  - `id` string, required — The identifier of Deployment
  - `created_at` string, date-time, nullable — The creation date of the deployment
  - `updated_at` string, date-time, nullable — The update date of the deployment
  - `fingerprint` string — The fingerprint of the deployment
  - `cluster_name` string, required — The name of the cluster
  - `project_info` object, required — The project information
    - `title` string, required
    - `name` string, required
    - `namespace` string, nullable, required
    - `organization` string, nullable, required
    - `capabilities` object, required
    - `settings` object, required
  - `environment_info` object, required — The environment information
    - `name` string, required — The machine name of the environment
    - `status` string, required — The enviroment status
    - `is_main` boolean, required — Is this environment the main environment
    - `is_production` boolean, required — Is this environment a production environment
    - `constraints` object, required — Constraints of the environment's deployment
    - `reference` string, required — The reference in Git for this environment
    - `machine_name` string, required — The machine name of the environment
    - `environment_type` string, required — The type of environment (Production, Staging or Development)
    - `links` object, required
  - `deployment_target` string, required — The deployment target
  - `vpn` object, nullable, required — The configuration of the VPN
    - `version` 1 | 2, required — The IKE version to use (1 or 2)
    - `aggressive` 'no' | 'yes', required — Whether to use IKEv1 Aggressive or Main Mode
    - `modeconfig` 'pull' | 'push', required — Defines which mode is used to assign a virtual IP (must be the same on both sides)
    - `authentication` string, required — The authentication scheme
    - `gateway_ip` string, required
    - `identity` string, nullable, required — The identity of the ipsec participant
    - `second_identity` string, nullable, required — The second identity of the ipsec participant
    - `remote_identity` string, nullable, required — The identity of the remote ipsec participant
    - `remote_subnets` string[], required — Remote subnets (CIDR notation)
    - `ike` string, required — The IKE algorithms to negotiate for this VPN connection.
    - `esp` string, required — The ESP algorithms to negotiate for this VPN connection.
    - `ikelifetime` string, required — The lifetime of the IKE exchange.
    - `lifetime` string, required — The lifetime of the ESP exchange.
    - `margintime` string, required — The margin time for re-keying.
  - `http_access` object, required — The permissions of the HTTP access
    - `is_enabled` boolean, required — Whether http_access control is enabled
    - `addresses` object[], required
      - `permission` 'allow' | 'deny', required
      - `address` string, required — IP address or CIDR
    - `basic_auth` object, required
  - `enable_smtp` boolean, required — Whether to configure SMTP for this environment
  - `restrict_robots` boolean, required — Whether to restrict robots for this environment
  - `variables` object[], required — The variables applying to this environment
    - `name` string, required — Name of the variable
    - `value` string — Value of the variable
    - `is_sensitive` boolean, required — The variable is sensitive
    - `is_json` boolean, required — The variable is a JSON string
    - `visible_build` boolean, required — The variable is visible during build
    - `visible_runtime` boolean, required — The variable is visible at runtime
  - `access` object[], required — Access control definition for this enviroment
    - `entity_id` string, required
    - `role` 'admin' | 'contributor' | 'viewer', required
  - `subscription` object, required — Subscription
    - `license_uri` string, required — URI of the subscription
    - `plan` '2xlarge' | '2xlarge-high-memory' | '4xlarge' | '8xlarge' | 'development' | 'large' | 'large-high-memory' | 'medium' | 'medium-high-memory' | 'standard' | 'standard-high-memory' | 'xlarge' | 'xlarge-high-memory'
    - `environments` integer — Number of environments
    - `storage` integer, required — Size of storage (in MB)
    - `included_users` integer, required — Number of users
    - `subscription_management_uri` string, required — URI for managing the subscription
    - `restricted` boolean, required — True if subscription attributes, like number of users, are frozen
    - `suspended` boolean, required — Whether or not the subscription is suspended
    - `user_licenses` integer, required — Current number of users
    - `resources` object — Resources limits
      - `container_profiles` boolean, required — Enable support for customizable container profiles.
      - `production` object, required — Resources for production environments
        - `legacy_development` boolean, required — Enable legacy development sizing for this environment type.
        - `max_cpu` number, float, nullable, required — Maximum number of allocated CPU units.
        - `max_memory` integer, nullable, required — Maximum amount of allocated RAM.
        - `max_environments` integer, nullable, required — Maximum number of environments
      - `development` object, required — Resources for development environments
        - `legacy_development` boolean, required — Enable legacy development sizing for this environment type.
        - `max_cpu` number, float, nullable, required — Maximum number of allocated CPU units.
        - `max_memory` integer, nullable, required — Maximum amount of allocated RAM.
        - `max_environments` integer, nullable, required — Maximum number of environments
    - `resource_validation_url` string — URL for resources validation
    - `image_types` object — Restricted and denied image types
      - `only` string[] — Image types to be allowed use.
      - `exclude` string[] — Image types to be denied use.
  - `services` object, required — The services
  - `routes` object, required — The routes
  - `webapps` object, required — The Web applications
  - `workers` object, required — The workers
  - `container_profiles` object, required — The profiles of the containers

---

[API](https://skmtc.net/upsun/apis/upsun-com-rest-api.md) · [All operations](https://skmtc.net/upsun/apis/upsun-com-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upsun/upsun-com-rest-api/revisions/6cc88fde6435/schema)