InputSets

Contain APIs corresponding to the Input Sets, including Overlay Input Sets.

Gets Input Set for a given identifier. Throws error if no Input Set exists for the given identifier.

Request
Security:
ApiKey (readwrite)
path Parameters
inputSetIdentifier
required
string

Identifier of the Input Set

query Parameters
accountIdentifier
required
string

Account Identifier for the entity.

orgIdentifier
required
string

Organization Identifier for the entity.

projectIdentifier
required
string

Project Identifier for the entity.

pipelineIdentifier
required
string

Pipeline ID for the Input Set. The Input Set will work only for the Pipeline corresponding to this identifier.

branch
string

Branch Name

repoIdentifier
string

Git Sync Config Id

getDefaultFromOtherRepo
boolean

if true, return all the default entities

Responses
400

Bad Request

500

Internal server error

default

Gets an Input Set if it exists for the identifier in the path. Throws an error if no Input Set exists for this identifier.

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&branch=string&repoIdentifier=string&getDefaultFromOtherRepo=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update Input Set for Pipeline

Request
Security:
ApiKey (readwrite)
path Parameters
inputSetIdentifier
required
string

Identifier for the Input Set that needs to be updated. An Input Set corresponding to this identifier should already exist.

query Parameters
accountIdentifier
required
string

Account Identifier for the entity.

orgIdentifier
required
string

Organization Identifier for the entity.

projectIdentifier
required
string

Project Identifier for the entity.

pipelineIdentifier
required
string

Pipeline Id for the Input Set. The Input Set will work only for the Pipeline corresponding to this Id.

pipelineBranch
string

Github branch of the Pipeline for which the Input Set is to be created

pipelineRepoID
string

Github Repo Id of the Pipeline for which the Input Set is to be created

branch
string

Branch Name

repoIdentifier
string

Git Sync Config Id

rootFolder
string

Default Folder Path

filePath
string

Default Folder Path

commitMsg
string

Commit Message

lastObjectId
string

Last Object Id

baseBranch
string

Default Branch

header Parameters
If-Match
string

Version of entity to match

Request Body schema:

Input set YAML to be updated. The Account, Org, Project, and Pipeline Ids inside the YAML should match the query parameters

string
Responses
400

Bad Request

500

Internal server error

default

If the YAML is valid, returns the updated Input Set. If not, it sends what is wrong with the YAML

put/pipeline/api/inputSets/{inputSetIdentifier}
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Delete the Input Set by Identifier

Request
Security:
ApiKey (readwrite)
path Parameters
inputSetIdentifier
required
string

This is the Id of the Input Set that needs to be deleted. An error is thrown if no Input Set exists for this Id.

query Parameters
accountIdentifier
required
string

Account Identifier for the entity.

orgIdentifier
required
string

Organization Identifier for the entity.

projectIdentifier
required
string

Project Identifier for the entity.

pipelineIdentifier
required
string

Pipeline identifier for the Input Set. Input Set will be deleted for the Pipeline corresponding to this Identifier

branch
string

Branch Name

repoIdentifier
string

Git Sync Config Id

rootFolder
string

Default Folder Path

filePath
string

File Path

commitMsg
string

Commit Message

lastObjectId
string

Last Object Id

header Parameters
If-Match
string

Version of entity to match

Responses
400

Bad Request

500

Internal server error

default

Return the Deleted Input Set

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",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Merge given Input Sets into a single Runtime Input YAML

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the entity.

orgIdentifier
required
string

Organization Identifier for the entity.

projectIdentifier
required
string

Project Identifier for the entity.

pipelineIdentifier
required
string

Identifier of the Pipeline to which the Input Sets belong

pipelineBranch
string

Github branch of the Pipeline to which the Input Sets belong

pipelineRepoID
string

Github Repo identifier of the Pipeline to which the Input Sets belong

branch
string

Branch Name

repoIdentifier
string

Git Sync Config Id

getDefaultFromOtherRepo
boolean

if true, return all the default entities

Request Body schema:
inputSetReferences
Array of strings
withMergedPipelineYaml
boolean
stageIdentifiers
Array of strings
Responses
400

Bad Request

500

Internal server error

default

Merge given Input Sets into A single Runtime Input YAML

post/pipeline/api/inputSets/merge
Request samples
{
  • "inputSetReferences": [
    ],
  • "withMergedPipelineYaml": true,
  • "stageIdentifiers": [
    ]
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Merge given Runtime Input YAML into the Pipeline

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the entity.

orgIdentifier
required
string

Organization Identifier for the entity.

projectIdentifier
required
string

Project Identifier for the entity.

pipelineIdentifier
required
string

Identifier of the Pipeline to which the Input Sets belong

pipelineBranch
string

Github branch of the Pipeline to which the Input Sets belong

pipelineRepoID
string

Github Repo identifier of the Pipeline to which the Input Sets belong

branch
string

Branch Name

repoIdentifier
string

Git Sync Config Id

getDefaultFromOtherRepo
boolean

if true, return all the default entities

Request Body schema:
runtimeInputYaml
string
Responses
400

Bad Request

500

Internal server error

default

Merge given Runtime Input YAML into the Pipeline

post/pipeline/api/inputSets/mergeWithTemplateYaml
Request samples
{
  • "runtimeInputYaml": "string"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets an Overlay Input Set by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
inputSetIdentifier
required
string

Identifier of the Overlay Input Set

query Parameters
accountIdentifier
required
string

Account Identifier for the entity.

orgIdentifier
required
string

Organization Identifier for the entity.

projectIdentifier
required
string

Project Identifier for the entity.

pipelineIdentifier
required
string

This is the Pipeline Id specific to the Overlay Input Set. Overlay Input Set corresponding to the Pipeline with this Id would be fetched

branch
string

Branch Name

repoIdentifier
string

Git Sync Config Id

getDefaultFromOtherRepo
boolean

if true, return all the default entities

Responses
400

Bad Request

500

Internal server error

default

Fetches the Overlay Input Set corresponding to the Overlay Input Set Id provided in the API URL.

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&branch=string&repoIdentifier=string&getDefaultFromOtherRepo=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update an Overlay Input Set for a pipeline

Request
Security:
ApiKey (readwrite)
path Parameters
inputSetIdentifier
required
string

Identifier for the Overlay Input Set that needs to be updated. An Overlay Input Set corresponding to this identifier should already exist.

query Parameters
accountIdentifier
required
string

Account Identifier for the entity.

orgIdentifier
required
string

Organization Identifier for the entity.

projectIdentifier
required
string

Project Identifier for the entity.

pipelineIdentifier
required
string

Pipeline identifier for the Overlay Input Set. The Overlay Input Set will work only for the Pipeline corresponding to this identifier.

branch
string

Branch Name

repoIdentifier
string

Git Sync Config Id

rootFolder
string

Default Folder Path

filePath
string

Default Folder Path

commitMsg
string

Commit Message

lastObjectId
string

Last Object Id

baseBranch
string

Default Branch

header Parameters
If-Match
string

Version of entity to match

Request Body schema:

Overlay Input Set YAML to be updated. The Account, Org, Project, and Pipeline identifiers inside the YAML should match the query parameters, and the Overlay Input Set identifier cannot be changed.

string
Responses
400

Bad Request

500

Internal server error

default

If the YAML is valid, returns the updated Overlay Input Set. If not, it sends what is wrong with the YAML

put/pipeline/api/inputSets/overlay/{inputSetIdentifier}
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

List all Input Sets for a pipeline

Request
Security:
ApiKey (readwrite)
query Parameters
pageIndex
integer <int32>
Default: 0

The number of the page to fetch

pageSize
integer <int32>
Default: 100

The number of the elements to fetch

accountIdentifier
required
string

Account Identifier for the entity.

orgIdentifier
required
string

Organization Identifier for the entity.

projectIdentifier
required
string

Project Identifier for the entity.

pipelineIdentifier
required
string

Pipeline identifier for which we need the Input Sets list.

inputSetType
string
Default: "ALL"

Type of Input Set needed: "INPUT_SET", or "OVERLAY_INPUT_SET", or "ALL". If nothing is sent, ALL is considered.

Enum: "ALL" "INPUT_SET" "OVERLAY_INPUT_SET"
searchTerm
string

Search term to filter out Input Sets based on name, identifier, tags.

sortOrders
Array of strings

Sort criteria for the elements.

branch
string

Branch Name

repoIdentifier
string

Git Sync Config Id

getDefaultFromOtherRepo
boolean

if true, return all the default entities

Responses
400

Bad Request

500

Internal server error

default

Fetch all the Input Sets for a Pipeline, including Overlay Input Sets. The response is paginated

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",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Create an Input Set for a Pipeline

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the entity.

orgIdentifier
required
string

Organization Identifier for the entity.

projectIdentifier
required
string

Project Identifier for the entity.

pipelineIdentifier
required
string

Pipeline identifier for the input set. The input set will work only for the pipeline corresponding to this identifier.

pipelineBranch
string

Github branch of the Pipeline for which the Input Set is to be created

pipelineRepoID
string

Github Repo identifier of the Pipeline for which the Input Set is to be created

branch
string

Branch Name

repoIdentifier
string

Git Sync Config Id

rootFolder
string

Default Folder Path

filePath
string

File Path

commitMsg
string

File Path

isNewBranch
boolean
Default: false

Checks the new branch

baseBranch
string

Default Branch

Request Body schema:

Input set YAML to be created. The account, org, project, and pipeline identifiers inside the YAML should match the query parameters

string
Responses
400

Bad Request

500

Internal server error

default

If the YAML is valid, returns created Input Set. If not, it sends what is wrong with the YAML

post/pipeline/api/inputSets
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Fetch Runtime Input Template for a Pipeline

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the entity.

orgIdentifier
required
string

Organization Identifier for the entity.

projectIdentifier
required
string

Project Identifier for the entity.

pipelineIdentifier
required
string

Pipeline identifier for which we need the Runtime Input Template.

branch
string

Branch Name

repoIdentifier
string

Git Sync Config Id

getDefaultFromOtherRepo
boolean

if true, return all the default entities

Request Body schema:
stageIdentifiers
Array of strings
Responses
400

Bad Request

500

Internal server error

default

Fetch Runtime Input Template for a Pipeline, along with any expressions whose value is needed for running specific Stages

post/pipeline/api/inputSets/template
Request samples
{
  • "stageIdentifiers": [
    ]
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Create an Overlay Input Set for a pipeline

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string

Account Identifier for the entity.

orgIdentifier
required
string

Organization Identifier for the entity.

projectIdentifier
required
string

Project Identifier for the entity.

pipelineIdentifier
required
string

Pipeline identifier for the overlay input set. The Overlay Input Set will work only for the Pipeline corresponding to this identifier.

branch
string

Branch Name

repoIdentifier
string

Git Sync Config Id

rootFolder
string

Default Folder Path

filePath
string

File Path

commitMsg
string

File Path

isNewBranch
boolean
Default: false

Checks the new branch

baseBranch
string

Default Branch

Request Body schema:

Overlay Input Set YAML to be created. The Account, Org, Project, and Pipeline identifiers inside the YAML should match the query parameters

string
Responses
400

Bad Request

500

Internal server error

default

If the YAML is valid, returns created Overlay Input Set. If not, it sends what is wrong with the YAML

post/pipeline/api/inputSets/overlay
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}