Setting

This contains APIs related to Settings as defined in Harness

Get a setting value by identifier

SecurityApiKey
Request
path Parameters
identifier
required
string

This is the Identifier of the Entity

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

This returns a setting value by the Identifier

get/ng/api/settings/{identifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get list of settings under the specified category

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

category
required
string

Category of the Setting.

Enum: "CD" "CI" "CE" "CV" "CF" "STO" "CORE" "PMS" "TEMPLATESERVICE" "GOVERNANCE" "CHAOS"
group
string

Group Id of the setting

Responses
400

Bad Request

500

Internal server error

default

This contains a list of Settings

get/ng/api/settings
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update settings

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

Request Body schema:

List of update requests for settings

Array
identifier
required
string

Identifier of the Setting.

value
string

Value of the setting

allowOverrides
required
boolean

Allow override of the Setting in sub-scopes.

updateType
required
string

Type of the update operation. When update type is RESTORE, field [value] is ignored

Enum: "UPDATE" "RESTORE"
Responses
400

Bad Request

500

Internal server error

default

This updates the settings

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