inputSets

Gets an InputSet by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
inputSetIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
pipelineIdentifier
required
string
deleted
boolean
Default: false
branch
string
repoIdentifier
string
getDefaultFromOtherRepo
boolean
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/pipeline/api/inputSets/{inputSetIdentifier}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/inputSets/:inputSetIdentifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&pipelineIdentifier=string&deleted=false&branch=string&repoIdentifier=string&getDefaultFromOtherRepo=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Update an InputSet by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
inputSetIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
pipelineIdentifier
required
string
pipelineBranch
string
pipelineRepoID
string
branch
string
repoIdentifier
string
rootFolder
string
filePath
string
commitMsg
string
lastObjectId
string
baseBranch
string
header Parameters
If-Match
string
Request Body schema:
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

put/pipeline/api/inputSets/{inputSetIdentifier}
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Delete an inputSet by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
inputSetIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
pipelineIdentifier
required
string
branch
string
repoIdentifier
string
rootFolder
string
filePath
string
commitMsg
string
lastObjectId
string
header Parameters
If-Match
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

delete/pipeline/api/inputSets/{inputSetIdentifier}
Request samples
curl -i -X DELETE \
  'https://app.harness.io/gateway/pipeline/api/inputSets/:inputSetIdentifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&pipelineIdentifier=string&branch=string&repoIdentifier=string&rootFolder=string&filePath=string&commitMsg=string&lastObjectId=string' \
  -H 'If-Match: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": true,
  • "metaData": { },
  • "correlationId": "string"
}

Gets an Overlay InputSet by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
inputSetIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
pipelineIdentifier
required
string
deleted
boolean
Default: false
branch
string
repoIdentifier
string
getDefaultFromOtherRepo
boolean
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/pipeline/api/inputSets/overlay/{inputSetIdentifier}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/inputSets/overlay/:inputSetIdentifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&pipelineIdentifier=string&deleted=false&branch=string&repoIdentifier=string&getDefaultFromOtherRepo=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Update an Overlay InputSet by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
inputSetIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
pipelineIdentifier
required
string
branch
string
repoIdentifier
string
rootFolder
string
filePath
string
commitMsg
string
lastObjectId
string
baseBranch
string
header Parameters
If-Match
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

put/pipeline/api/inputSets/overlay/{inputSetIdentifier}
Request samples
curl -i -X PUT \
  'https://app.harness.io/gateway/pipeline/api/inputSets/overlay/:inputSetIdentifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&pipelineIdentifier=string&branch=string&repoIdentifier=string&rootFolder=string&filePath=string&commitMsg=string&lastObjectId=string&baseBranch=string' \
  -H 'If-Match: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Gets InputSets list for a pipeline

Request
Security:
ApiKey (readwrite)
query Parameters
pageIndex
integer <int32>
Default: 0
pageSize
integer <int32>
Default: 100
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
pipelineIdentifier
required
string
inputSetType
string
Default: "ALL"
Enum: "ALL" "INPUT_SET" "OVERLAY_INPUT_SET"
searchTerm
string
sortOrders
Array of strings
branch
string
repoIdentifier
string
getDefaultFromOtherRepo
boolean
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/pipeline/api/inputSets
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/inputSets?pageIndex=0&pageSize=100&accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&pipelineIdentifier=string&inputSetType=ALL&searchTerm=string&sortOrders=string&branch=string&repoIdentifier=string&getDefaultFromOtherRepo=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Create an InputSet For Pipeline

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
pipelineIdentifier
required
string
pipelineBranch
string
pipelineRepoID
string
branch
string
repoIdentifier
string
rootFolder
string
filePath
string
commitMsg
string
baseBranch
string
Request Body schema:
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/pipeline/api/inputSets
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get template from a pipeline yaml

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
pipelineIdentifier
required
string
branch
string
repoIdentifier
string
getDefaultFromOtherRepo
boolean
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/pipeline/api/inputSets/template
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/inputSets/template?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&pipelineIdentifier=string&branch=string&repoIdentifier=string&getDefaultFromOtherRepo=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Merges given input sets list on pipeline and return input set template format of applied pipeline

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
pipelineIdentifier
required
string
pipelineBranch
string
pipelineRepoID
string
branch
string
repoIdentifier
string
getDefaultFromOtherRepo
boolean
Request Body schema:
inputSetReferences
Array of strings
withMergedPipelineYaml
boolean
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/pipeline/api/inputSets/merge
Request samples
{
  • "inputSetReferences": [
    ],
  • "withMergedPipelineYaml": true
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Merges given runtime input yaml on pipeline and return input set template format of applied pipeline

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
pipelineIdentifier
required
string
pipelineBranch
string
pipelineRepoID
string
branch
string
repoIdentifier
string
getDefaultFromOtherRepo
boolean
Request Body schema:
runtimeInputYaml
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/pipeline/api/inputSets/mergeWithTemplateYaml
Request samples
{
  • "runtimeInputYaml": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Create an Overlay InputSet For Pipeline

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
pipelineIdentifier
required
string
branch
string
repoIdentifier
string
rootFolder
string
filePath
string
commitMsg
string
baseBranch
string
Request Body schema:
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/pipeline/api/inputSets/overlay
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}