---
title: "Read deployment"
method: GET
path: "/v1/default/deployments/{deployment-id}"
tags: ["deployments-api", "deployment-visibility-project"]
---

# Read deployment

`GET /v1/default/deployments/{deployment-id}`

## Request

- Base URL: `https://api.bymason.com`
- URL: `https://api.bymason.com/v1/default/deployments/{deployment-id}`
- Auth: API key in header `Authorization`

Fetches a deployment by its unique id.

## Path parameters

- `deployment-id` string, required

## Response `200`

Read deployment response

- Deployment: A Deployment represents an artifact that will be installed on every device in a deployment group. An artifact is one of an APK, config, or Mason OS version.
  - `id` string, uuid: Unique identifier for the deployment
  - `artifact` DeployedArtifact: The artifact deployed to a group
    - `name` string: Name of the deployed artifact
    - `type` 'ota' | 'config' | 'apk'
    - `version` string: Version of the deployed artifact
  - `createdAt` string, date-time: Timestamp for when the deployment was created
  - `updatedAt` string, date-time: Timestamp for when the deployment was created
  - `groupId` string, uuid: The group id the deployment belongs to
  - `deployInsecure` boolean: Set to true for devices to download the update over http
  - `isActive` boolean: Whether the deployment is active or not

## Other responses

- `404`: Resource(s) not found
- `500`: Internal server error

---

[API](https://skmtc.dev/bymason/apis/mason-platform-apis-docs.md) - [All operations](https://skmtc.dev/bymason/apis/mason-platform-apis-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/bymason/apis/mason-platform-apis-docs/revisions/365b123b04d4?raw)
