---
title: "Get a deployment"
method: GET
path: "/repos/{owner}/{repo}/deployments/{deployment_id}"
tags: ["repos"]
---

# Get a deployment

`GET /repos/{owner}/{repo}/deployments/{deployment_id}`

## Path parameters

- `owner` string, required
- `repo` string, required
- `deployment_id` integer, required

## Response `200`

Response

- Deployment — A request for a specific ref(branch,sha,tag) to be deployed
  - `url` string, uri, required
  - `id` integer, required — Unique identifier of the deployment
  - `node_id` string, required
  - `sha` string, required
  - `ref` string, required — The ref to deploy. This can be a branch, tag, or sha.
  - `task` string, required — Parameter to specify a task to execute
  - `payload` union, required
    - object
    - string
  - `original_environment` string
  - `environment` string, required — Name for the target deployment environment.
  - `description` string, nullable, required
  - `creator` NullableSimpleUser, nullable, required — A GitHub user.
    - `name` string, nullable
    - `email` string, nullable
    - `login` string, required
    - `id` integer, required
    - `node_id` string, required
    - `avatar_url` string, uri, required
    - `gravatar_id` string, nullable, required
    - `url` string, uri, required
    - `html_url` string, uri, required
    - `followers_url` string, uri, required
    - `following_url` string, required
    - `gists_url` string, required
    - `starred_url` string, required
    - `subscriptions_url` string, uri, required
    - `organizations_url` string, uri, required
    - `repos_url` string, uri, required
    - `events_url` string, required
    - `received_events_url` string, uri, required
    - `type` string, required
    - `site_admin` boolean, required
    - `starred_at` string
    - `user_view_type` string
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `statuses_url` string, uri, required
  - `repository_url` string, uri, required
  - `transient_environment` boolean — Specifies if the given environment is will no longer exist at some point in the future. Default: false.
  - `production_environment` boolean — Specifies if the given environment is one that end-users directly interact with. Default: false.
  - `performed_via_github_app` NullableIntegration, nullable — GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
    - `id` integer, required — Unique identifier of the GitHub app
    - `slug` string — The slug name of the GitHub app
    - `node_id` string, required
    - `client_id` string
    - `owner` union, required
      - SimpleUser — A GitHub user.
        - `name` string, nullable
        - `email` string, nullable
        - `login` string, required
        - `id` integer, required
        - `node_id` string, required
        - `avatar_url` string, uri, required
        - `gravatar_id` string, nullable, required
        - `url` string, uri, required
        - `html_url` string, uri, required
        - `followers_url` string, uri, required
        - `following_url` string, required
        - `gists_url` string, required
        - `starred_url` string, required
        - `subscriptions_url` string, uri, required
        - `organizations_url` string, uri, required
        - `repos_url` string, uri, required
        - `events_url` string, required
        - `received_events_url` string, uri, required
        - `type` string, required
        - `site_admin` boolean, required
        - `starred_at` string
        - `user_view_type` string
      - Enterprise — An enterprise on GitHub.
        - `description` string, nullable — A short description of the enterprise.
        - `html_url` string, uri, required
        - `website_url` string, uri, nullable — The enterprise's website URL.
        - `id` integer, required — Unique identifier of the enterprise
        - `node_id` string, required
        - `name` string, required — The name of the enterprise.
        - `slug` string, required — The slug url identifier for the enterprise.
        - `created_at` string, date-time, nullable, required
        - `updated_at` string, date-time, nullable, required
        - `avatar_url` string, uri, required
    - `name` string, required — The name of the GitHub app
    - `description` string, nullable, required
    - `external_url` string, uri, required
    - `html_url` string, uri, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `permissions` object, required — The set of permissions for the GitHub app
      - `issues` string
      - `checks` string
      - `metadata` string
      - `contents` string
      - `deployments` string
    - `events` string[], required — The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.
    - `installations_count` integer — The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

## Other responses

- `404` — Resource not found

---

[API](https://skmtc.net/github/apis/github-v3-rest-api-3.md) · [All operations](https://skmtc.net/github/apis/github-v3-rest-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/github/github-v3-rest-api-3/versions/dc0584ac4e13/schema)