Deployment Pipelines

Get deployment pipelines

get

Authorizations

Query parameters

start-indexinteger · int32Optional

an integer specifying the starting point (beginning with 0) when paging through a list of entities

Default: 0

max-resultsinteger · int32 · max: 100Optional

the maximum number of results when paging through a list of deployment pipelines

Default: 50

Responses

200

The deployment pipelines

application/json

get

GET /api/deployment-pipelines HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

The deployment pipelines

[
  {
    "id": 1,
    "name": "text",
    "integrationType": "text",
    "integrationKey": "text",
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "createdAt": "2025-07-08T11:57:45.353Z",
    "updatedAt": "2025-07-08T11:57:45.353Z",
    "params": "null",
    "integrationUrl": "text"
  }
]

Create a new deployment pipeline.

post

Authorizations

Body

idinteger · int64Optional

namestringRequired

integrationTypestringRequired

integrationKeystringOptional

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

paramsone ofOptional

Dynamic params based on the chosen integration type of the pipeline

Default: null

objectOptional

Deployment pipeline API integration params

Default: null

or

integrationUrlstringOptional

Responses

200

The newly created depoyment pipeline

application/json

post

POST /api/deployment-pipelines HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "id": 1,
  "name": "text",
  "integrationType": "text",
  "integrationKey": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "params": "null",
  "integrationUrl": "text"
}

200

The newly created depoyment pipeline

{
  "id": 1,
  "name": "text",
  "integrationType": "text",
  "integrationKey": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "createdAt": "2025-07-08T11:57:45.353Z",
  "updatedAt": "2025-07-08T11:57:45.353Z",
  "params": "null",
  "integrationUrl": "text"
}

Get a specific deployment pipeline

get

Authorizations

Path parameters

idnumberRequired

entity ID

Responses

200

The requested deployment pipeline

application/json

get

GET /api/deployment-pipelines/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

The requested deployment pipeline

{
  "id": 1,
  "name": "text",
  "integrationType": "text",
  "integrationKey": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "createdAt": "2025-07-08T11:57:45.353Z",
  "updatedAt": "2025-07-08T11:57:45.353Z",
  "params": "null",
  "integrationUrl": "text"
}

Update the specific deployment pipeline

put

Authorizations

Path parameters

idnumberRequired

entity ID

Body

idinteger · int64Optional

namestringRequired

integrationTypestringRequired

integrationKeystringOptional

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

paramsone ofOptional

Dynamic params based on the chosen integration type of the pipeline

Default: null

objectOptional

Deployment pipeline API integration params

Default: null

or

integrationUrlstringOptional

Responses

200

The updated deployment pipeline

application/json

put

PUT /api/deployment-pipelines/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "id": 1,
  "name": "text",
  "integrationType": "text",
  "integrationKey": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "params": "null",
  "integrationUrl": "text"
}

200

The updated deployment pipeline

{
  "id": 1,
  "name": "text",
  "integrationType": "text",
  "integrationKey": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "createdAt": "2025-07-08T11:57:45.353Z",
  "updatedAt": "2025-07-08T11:57:45.353Z",
  "params": "null",
  "integrationUrl": "text"
}

Delete a specific deployment pipeline

delete

Authorizations

Path parameters

idnumberRequired

entity ID

Responses

204

Empty body delete response

delete

DELETE /api/deployment-pipelines/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

Empty body delete response

No content