Skip to main content
GET
/
api
/
previews
List preview deployments
curl --request GET \
  --url http://localhost:3000/api/previews
{
  "deployments": [
    {
      "prNumber": 123,
      "repoName": "<string>",
      "repoOwner": "<string>",
      "projectSlug": "<string>",
      "deploymentId": "<string>",
      "branch": "<string>",
      "commitSha": "<string>",
      "framework": "nestjs",
      "dbType": "postgres",
      "appPort": 123,
      "exposedAppPort": 123,
      "exposedDbPort": 123,
      "status": "building",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "url": "<string>",
      "commentId": 123
    }
  ]
}

Response

List of deployments

deployments
object[]
required