---
title: "Get a project"
method: GET
path: "/projects/{projectId}"
tags: ["Project"]
---

# Get a project

`GET /projects/{projectId}`

Retrieve the details of a single project.

## Path parameters

- `projectId` string, required

## Response `default`

- Project
  - `id` string, required — The identifier of Project
  - `created_at` string, date-time, nullable, required — The creation date
  - `updated_at` string, date-time, nullable, required — The update date
  - `attributes` object, required — Arbitrary attributes attached to this resource
  - `title` string, required — The title of the project
  - `description` string, required — The description of the project
  - `owner` string, required — The owner of the project
  - `namespace` string, nullable, required — The namespace the project belongs in
  - `organization` string, nullable, required — The organization the project belongs in
  - `default_branch` string, nullable, required — The default branch of the project
  - `status` object, required — The status of the project
    - `code` string, required
    - `message` string, required
  - `timezone` string, required — Timezone of the project
  - `region` string, required — The region of the project
  - `repository` object, required — The repository information of the project
    - `url` string, required
    - `client_ssh_key` string, nullable, required — SSH Key used to access external private repositories.
  - `default_domain` string, nullable, required — The default domain of the project
  - `subscription` object, required — The subscription information of the project
    - `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.

---

[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)