Input Sets [Beta]

This contains APIs for Input Sets.

Create an Input Set

Creates an Input Set for a Pipeline.

Securityx-api-key

Request

path Parameters

org required	string Organization identifier
project required	string Project identifier

query Parameters

pipeline

required

string

Pipeline identifier for the Input Set.

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema:
application/json
required

Input Set create request body.

input_set_yaml required	string Input Set YAML (to be passed as a String).
identifier required	string [ 1 .. 128 ] characters ^[a-zA-Z_][0-9a-zA-Z_$]{0,127}$ Input Set identifier
name required	string [ 1 .. 128 ] characters ^[a-zA-Z_][0-9a-zA-Z-_ ]{0,127}$ Input Set name
description	string <= 1024 characters Input Set description
	object <= 128 properties Input Set tags
	object (Create Git Details) Contains parameters related to creating an Entity for Git Experience.

Responses

201

Input Set response body

post/v1/orgs/{org}/projects/{project}/input-sets

Request samples

Payload
curl
Java
Go

{"input_set_yaml": "inputSet:\n    pipeline:\n        identifier: Example_Pipeline\n        stages:\n            - stage:\n                  identifier: Example_Stage\n                  type: Approval\n                  spec:\n                      execution:\n                          steps:\n                              - step:\n                                    identifier: Approval_Step\n                                    type: HarnessApproval\n                                    spec:\n                                        approvers:\n                                            userGroups:\n                                                - account.Admins\n                              - step:\n                                    identifier: Shellscript_Step\n                                    type: ShellScript\n                                    spec:\n                                        source:\\n                                            type: Inline\n                                            spec:\\n                                                script: echo \"ShellScript\"\n            - stage:\n                  identifier: Sample_Deploy_Stage\n                  type: Deployment\n                  spec:\n                      serviceConfig:\n                          serviceRef: Service1\n                      infrastructure:\n                          environmentRef: Env1\n                          infrastructureDefinition:\n                              type: KubernetesDirect\n                              spec:\n                                  connectorRef: account.harnessciplatform\n                                  namespace: sample",
"identifier": "example_input_set",
"name": "ExampleInputSet",
"description": "Input Set Description",
"tags": {"property1": "example-tag-1-value",
"property2": "example-tag-2-value"
},
"git_details": {"branch_name": "branch",
"file_path": "/folder/file.json",
"commit_message": "Added Harness Git Experience",
"base_branch": "old_branch",
"connector_ref": "git_connector",
"store_type": "REMOTE",
"repo_name": "example_repository"
}
}

Response samples

{"input_set_yaml": "example_input_set_yaml",
"identifier": "example_input_set",
"name": "Example Input Set",
"org": "example_org",
"project": "example_project",
"description": "InputSet Description",
"tags": {"example-tag-1": "example-tag-1-value",
"example-tag-2": "example-tag-2-value"
},
"git_details": {"object_id": "example_object",
"branch_name": "branch",
"file_path": "/folder/file.json",
"repo_name": "example_repository",
"commit_id": "abcd123",
"file_url": "www.repo/folder/file.com",
"repo_url": "www.repo.com"
},
"created": 1234567890,
"updated": 9876543210,
"error_details": {"valid": false,
"message": "Some fields in the Input Set are invalid.",
"outdated": true,
"error_pipeline_yaml": "serviceConfig: \"pipeline.stages.example_deploy_stage.spec.serviceConfig\"\n",
"fqn_errors": [{"fqn": "pipeline.stages.example_deploy_stage.spec.serviceConfig",
"errors": [{"field_name": "serviceConfig",
"message": "Field not a runtime input",
"identifier_of_error_source": "example_input_set"
}
]
}
],
"invalid_refs": ["example_invalid_input_set"
]
}
}

List Input Sets

Returns a List of Input Sets for a Pipeline.

Securityx-api-key

Request

path Parameters

org required	string Organization identifier
project required	string Project identifier

query Parameters

pipeline required	string Pipeline identifier for the Input Set.
page	integer Default: 0 Pagination page number strategy: Specify the page number within the paginated collection related to the number of items on each page.
limit	integer <= 100 Default: 30 Pagination: Number of items to return.
search_term	string This would be used to filter resources having attributes matching the search term.
sort	string Parameter on the basis of which sorting is done. Enum: "name" "updated"
order	string Order on the basis of which sorting is done. Enum: "ASC" "DESC"

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Responses

200

Input Set response body

get/v1/orgs/{org}/projects/{project}/input-sets

Request samples

curl
Java
Go

Response samples

[{"input_set_yaml": "example_input_set_yaml",
"identifier": "example_input_set",
"name": "Example Input Set",
"org": "example_org",
"project": "example_project",
"description": "InputSet Description",
"tags": {"example-tag-1": "example-tag-1-value",
"example-tag-2": "example-tag-2-value"
},
"git_details": {"object_id": "example_object",
"branch_name": "branch",
"file_path": "/folder/file.json",
"repo_name": "example_repository",
"commit_id": "abcd123",
"file_url": "www.repo/folder/file.com",
"repo_url": "www.repo.com"
},
"created": 1234567890,
"updated": 9876543210,
"error_details": {"valid": false,
"message": "Some fields in the Input Set are invalid.",
"outdated": true,
"error_pipeline_yaml": "serviceConfig: \"pipeline.stages.example_deploy_stage.spec.serviceConfig\"\n",
"fqn_errors": [{"fqn": "pipeline.stages.example_deploy_stage.spec.serviceConfig",
"errors": [{"field_name": "serviceConfig",
"message": "Field not a runtime input",
"identifier_of_error_source": "example_input_set"
}
]
}
],
"invalid_refs": ["example_invalid_input_set"
]
}
}
]

Retrieve an Input Set

Retrieves an Input Set for a Pipeline.

Securityx-api-key

Request

path Parameters

org required	string Organization identifier
project required	string Project identifier
input-set required	string Input Set identifier

query Parameters

pipeline required	string Pipeline identifier for the Input Set.
branch_name	string Name of the branch (for Git Experience).
parent_entity_connector_ref	string Connector reference for Parent Entity (Pipeline).
parent_entity_repo_name	string Repository name for Parent Entity (Pipeline).
load_from_fallback_branch	boolean Default: "false" Flag to load the pipeline from the created non default branch

header Parameters

Harness-Account	string Identifier field of the account the resource is scoped to.
Load-From-Cache	string Default: false Specifies whether the remote pipeline should be loaded from Git or Git cache.

Responses

200

Input Set response body

get/v1/orgs/{org}/projects/{project}/input-sets/{input-set}

Request samples

curl
Java
Go

Response samples

{"input_set_yaml": "example_input_set_yaml",
"identifier": "example_input_set",
"name": "Example Input Set",
"org": "example_org",
"project": "example_project",
"description": "InputSet Description",
"tags": {"example-tag-1": "example-tag-1-value",
"example-tag-2": "example-tag-2-value"
},
"git_details": {"object_id": "example_object",
"branch_name": "branch",
"file_path": "/folder/file.json",
"repo_name": "example_repository",
"commit_id": "abcd123",
"file_url": "www.repo/folder/file.com",
"repo_url": "www.repo.com"
},
"created": 1234567890,
"updated": 9876543210,
"error_details": {"valid": false,
"message": "Some fields in the Input Set are invalid.",
"outdated": true,
"error_pipeline_yaml": "serviceConfig: \"pipeline.stages.example_deploy_stage.spec.serviceConfig\"\n",
"fqn_errors": [{"fqn": "pipeline.stages.example_deploy_stage.spec.serviceConfig",
"errors": [{"field_name": "serviceConfig",
"message": "Field not a runtime input",
"identifier_of_error_source": "example_input_set"
}
]
}
],
"invalid_refs": ["example_invalid_input_set"
]
}
}

Update an Input Set

Updates an Input Set for a Pipeline.

Securityx-api-key

Request

path Parameters

org required	string Organization identifier
project required	string Project identifier
input-set required	string Input Set identifier

query Parameters

pipeline

required

string

Pipeline identifier for the Input Set.

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema:
application/json
required

Input Set update request body

input_set_yaml required	string Input Set YAML (to be passed as a String).
identifier required	string [ 1 .. 128 ] characters ^[a-zA-Z_][0-9a-zA-Z_$]{0,127}$ Input Set identifier
name required	string [ 1 .. 128 ] characters ^[a-zA-Z_][0-9a-zA-Z-_ ]{0,127}$ Input Set name
description	string <= 1024 characters Input Set description
	object <= 128 properties Input Set tags
	object (InputSetGitUpdateDetails) Contains parameters related to updating an Input Set for Git Experience.

Responses

200

Input Set response body

put/v1/orgs/{org}/projects/{project}/input-sets/{input-set}

Request samples

Payload
curl
Java
Go

{"input_set_yaml": "inputSet:\n    pipeline:\n        identifier: Example_Pipeline\n        stages:\n            - stage:\n                  identifier: Example_Stage\n                  type: Approval\n                  spec:\n                      execution:\n                          steps:\n                              - step:\n                                    identifier: Approval_Step\n                                    type: HarnessApproval\n                                    spec:\n                                        approvers:\n                                            userGroups:\n                                                - account.Admins\n                              - step:\n                                    identifier: Shellscript_Step\n                                    type: ShellScript\n                                    spec:\n                                        source:\\n                                            type: Inline\n                                            spec:\\n                                                script: echo \"ShellScript\"\n            - stage:\n                  identifier: Sample_Deploy_Stage\n                  type: Deployment\n                  spec:\n                      serviceConfig:\n                          serviceRef: Service1\n                      infrastructure:\n                          environmentRef: Env1\n                          infrastructureDefinition:\n                              type: KubernetesDirect\n                              spec:\n                                  connectorRef: account.harnessciplatform\n                                  namespace: sample",
"identifier": "example_input_set",
"name": "ExampleInputSet",
"description": "Input Set Description",
"tags": {"property1": "example-tag-1-value",
"property2": "example-tag-2-value"
},
"git_details": {"branch_name": "branch",
"commit_message": "Added Harness Git Experience",
"last_object_id": "abcdXYZ",
"base_branch": "old_branch",
"last_commit_id": "abcdXYZ",
"parent_entity_connector_ref": "git_connector",
"parent_entity_repo_name": "example_repository"
}
}

Response samples

{"input_set_yaml": "example_input_set_yaml",
"identifier": "example_input_set",
"name": "Example Input Set",
"org": "example_org",
"project": "example_project",
"description": "InputSet Description",
"tags": {"example-tag-1": "example-tag-1-value",
"example-tag-2": "example-tag-2-value"
},
"git_details": {"object_id": "example_object",
"branch_name": "branch",
"file_path": "/folder/file.json",
"repo_name": "example_repository",
"commit_id": "abcd123",
"file_url": "www.repo/folder/file.com",
"repo_url": "www.repo.com"
},
"created": 1234567890,
"updated": 9876543210,
"error_details": {"valid": false,
"message": "Some fields in the Input Set are invalid.",
"outdated": true,
"error_pipeline_yaml": "serviceConfig: \"pipeline.stages.example_deploy_stage.spec.serviceConfig\"\n",
"fqn_errors": [{"fqn": "pipeline.stages.example_deploy_stage.spec.serviceConfig",
"errors": [{"field_name": "serviceConfig",
"message": "Field not a runtime input",
"identifier_of_error_source": "example_input_set"
}
]
}
],
"invalid_refs": ["example_invalid_input_set"
]
}
}

Delete an Input Set

Deletes an Input Set for a Pipeline.

Securityx-api-key

Request

path Parameters

org required	string Organization identifier
project required	string Project identifier
input-set required	string Input Set identifier

query Parameters

pipeline

required

string

Pipeline identifier for the Input Set.

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Responses

204

No Content

400

Bad Request

delete/v1/orgs/{org}/projects/{project}/input-sets/{input-set}

Request samples

curl
Java
Go

Response samples

{ }

Move InputSet YAML from inline to remote

Creates a remote entity by fetching the input set YAML from Harness.

Securityx-api-key

Request

path Parameters

org required	string Organization identifier
project required	string Project identifier
input-set required	string Input Set identifier

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema: application/json

	object (Move Git Details) Parameters related to moving an entity for Git Experience.
pipeline_identifier	string
input_set_identifier	string
move_config_operation_type	string (MoveConfigOperationType) Operation type to move the configuration Value: "INLINE_TO_REMOTE"

Responses

200

Response body for moving an input set configuration.

post/v1/orgs/{org}/projects/{project}/input-sets/{input-set}/move-config

Request samples

Payload
curl
Java
Go

application/json

{"git_details": {"branch_name": "string",
"file_path": "string",
"commit_message": "string",
"base_branch": "string",
"connector_ref": "string",
"repo_name": "string"
},
"pipeline_identifier": "string",
"input_set_identifier": "string",
"move_config_operation_type": "INLINE_TO_REMOTE"
}

Response samples

application/json

{"input_set_identifier": "string"
}

Get Input Set YAML from Git Repository

Fetches InputSet YAML from Git Repository and saves a record for it in Harness

Securityx-api-key

Request

path Parameters

org required	string Organization identifier
project required	string Project identifier
input-set required	string Input Set identifier

query Parameters

pipeline

required

string

Pipeline identifier for the Input Set.

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema: application/json

Input Set import request body

	object (Import Git Information) Parameters related to importing an entity for Git.
	object (InputSet Import Request DTO) Information of InputSet import request DTO

Responses

200

Response body for input set import.

post/v1/orgs/{org}/projects/{project}/input-sets/{input-set}/import

Request samples

Payload
curl
Java
Go

application/json

{"git_import_info": {"connector_ref": "string",
"repo_name": "string",
"branch_name": "string",
"file_path": "string",
"is_force_import": true
},
"input_set_import_request": {"input_set_name": "string",
"input_set_description": "string"
}
}

Response samples

application/json

{"input_set_identifier": "string"
}

Update GitMetadata for Remote InputSet

Update git-metadata in remote inputSet and return the updated inputSet

Securityx-api-key

Request

path Parameters

org required	string Organization identifier
project required	string Project identifier
input-set required	string Input Set identifier

query Parameters

pipeline

required

string

Pipeline identifier for the Input Set.

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema: application/json

connector_ref	string Harness connector id used for entity CRUD operations
repo_name	string Name of the repository.
file_path	string File path of the entity in the repository.

Responses

200

Example response

put/v1/orgs/{org}/projects/{project}/input-sets/{input-set}/git-metadata

Request samples

Payload
curl
Java
Go

application/json

{"connector_ref": "string",
"repo_name": "string",
"file_path": "string"
}

Response samples

application/json

{"entity_identifier": "string"
}

➔ Next to Approvals

Input Sets [Beta]

Create an Input Set

path Parameters

query Parameters

header Parameters

Request Body schema: application/jsonapplication/yamlapplication/jsonrequired

List Input Sets

path Parameters

query Parameters

header Parameters

Retrieve an Input Set

path Parameters

query Parameters

header Parameters

Update an Input Set

path Parameters

query Parameters

header Parameters

Request Body schema: application/jsonapplication/yamlapplication/jsonrequired

Delete an Input Set

path Parameters

query Parameters

header Parameters

Move InputSet YAML from inline to remote

path Parameters

header Parameters

Request Body schema: application/json

Get Input Set YAML from Git Repository

path Parameters

query Parameters

header Parameters

Request Body schema: application/json

Update GitMetadata for Remote InputSet

path Parameters

query Parameters

header Parameters

Request Body schema: application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required