Skip to main content

Pipelines

GETapi/pipelines

List all Pipelines

This endpoint allows you to retrieve a list of all pipelines.

Response Body

[
  {
    "id": "d8583d1c-ce63-4e0c-bd55-2088409bc7e1",
    "createdAt": "2023-03-20T17:17:13.760Z",
    "updatedAt": "2023-03-20T17:17:13.760Z",
    "name": "Demo Pipeline",
    "awsEcsCluster": "Demo-Cluster-AX8J34",
    "awsEcsClusterStaging": "Demo-StagingCluster-kD5hKe3",
    "githubClientId": "83b3ac48a100cc6fb320",
    "githubClientSecret": "a43abd98aa3a2b3332add3a12ac4ba3e02cba48b",
    "githubOauthToken": "abc_D1fa7dK8cXc2atzH19AcfRD9azaGhZ2ItbAd",
    "services": []
  }
]

GETapi/pipelines/:pipelineId

List a Pipeline

This endpoint allows you to retrieve a single pipeline using its id.

Response Body

{
  "id": "d8583d1c-ce63-4e0c-bd55-2088409bc7e1",
  "createdAt": "2023-03-20T17:17:13.760Z",
  "updatedAt": "2023-03-20T17:17:13.760Z",
  "name": "Demo Pipeline",
  "awsEcsCluster": "Demo-Cluster-AX8J34",
  "awsEcsClusterStaging": "Demo-StagingCluster-kD5hKe3",
  "githubClientId": "83b3ac48a100cc6fb320",
  "githubClientSecret": "a43abd98aa3a2b3332add3a12ac4ba3e02cba48b",
  "githubOauthToken": "abc_D1fa7dK8cXc2atzH19AcfRD9azaGhZ2ItbAd",
  "services": []
}

POSTapi/pipelines

Create a Pipeline

This endpoint allows you to add a new pipeline. Properties shown in the request body are required.

Request Headers

  • Content-Type: application/json

Request Body

{
  "name": "Demo Pipeline Two",
  "awsEcsCluster": "Demo-Cluster-Two-BCA8HT",
  "awsEcsClusterStaging": "Demo-StagingCluster-Two-4k8ca45",
  "githubClientId": "83b3ac48a100cc6fb320",
  "githubClientSecret": "a43abd98aa3a2b3332add3a12ac4ba3e02cba48b",
  "githubOauthToken": "abc_D1fa7dK8cXc2atzH19AcfRD9azaGhZ2ItbAd"
}

Response Body

{
  "id": "1b22e175-08ac-4d78-b3bb-ab0dd4de5582",
  "createdAt": "2023-03-27T22:40:02.540Z",
  "updatedAt": "2023-03-27T22:40:02.540Z",
  "name": "Demo Pipeline Two",
  "awsEcsCluster": "Demo-Cluster-Two-BCA8HT",
  "awsEcsClusterStaging": "Demo-StagingCluster-Two-4k8ca45",
  "githubClientId": "83b3ac48a100cc6fb320",
  "githubClientSecret": "a43abd98aa3a2b3332add3a12ac4ba3e02cba48b",
  "githubOauthToken": "abc_D1fa7dK8cXc2atzH19AcfRD9azaGhZ2ItbAd"
}

DELETEapi/pipelines/:pipelineId

Delete a Pipeline

This endpoint allows you to delete a pipeline using its id.

Response Body

{
  "id": "d8583d1c-ce63-4e0c-bd55-2088409bc7e1",
  "createdAt": "2023-03-20T17:17:13.760Z",
  "updatedAt": "2023-03-20T17:17:13.760Z",
  "name": "Demo Pipeline",
  "awsEcsCluster": "Demo-Cluster-AX8J34",
  "awsEcsClusterStaging": "Demo-StagingCluster-kD5hKe3",
  "githubClientId": "83b3ac48a100cc6fb320",
  "githubClientSecret": "a43abd98aa3a2b3332add3a12ac4ba3e02cba48b",
  "githubOauthToken": "abc_D1fa7dK8cXc2atzH19AcfRD9azaGhZ2ItbAd",
  "services": []
}