Filter

This contains APIs related to Filter as defined in Harness

Create a Filter

Creates a Filter.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema:

Details of the Connector to create

name
required
string

Name of the Filter.

identifier
required
string

Identifier of the Filter.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

required
object (FilterProperties)

Properties of the Filter entity defined in Harness.

filterVisibility
string

This indicates visibility of Filter, by default it is Everyone.

Enum: "EveryOne" "OnlyCreator"
Responses
400

Bad Request

500

Internal server error

default

Returns created Filter

post/ng/api/filters
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "filterProperties": {
    },
  • "filterVisibility": "EveryOne"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Create a Filter

Creates a Filter.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema:

Details of the Connector to create

name
required
string

Name of the Filter.

identifier
required
string

Identifier of the Filter.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

required
object (FilterProperties)

Properties of the Filter entity defined in Harness.

filterVisibility
string

This indicates visibility of Filter, by default it is Everyone.

Enum: "EveryOne" "OnlyCreator"
Responses
400

Bad Request

500

Internal server error

default

Returns created Filter

post/pipeline/api/filters
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "filterProperties": {
    },
  • "filterVisibility": "EveryOne"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Create a Filter

Creates a Filter.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema:

Details of the Connector to create

name
required
string

Name of the Filter.

identifier
required
string

Identifier of the Filter.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

required
object (FilterProperties)

Properties of the Filter entity defined in Harness.

filterVisibility
string

This indicates visibility of Filter, by default it is Everyone.

Enum: "EveryOne" "OnlyCreator"
Responses
400

Bad Request

500

Internal server error

default

Returns created Filter

post/ccm/api/filters
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "filterProperties": {
    },
  • "filterVisibility": "EveryOne"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Create a Filter

Creates a Filter.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema:

Details of the Connector to create

name
required
string

Name of the Filter.

identifier
required
string

Identifier of the Filter.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

required
object (FilterProperties)

Properties of the Filter entity defined in Harness.

filterVisibility
string

This indicates visibility of Filter, by default it is Everyone.

Enum: "EveryOne" "OnlyCreator"
Responses
400

Bad Request

500

Internal server error

default

Returns created Filter

post/template/api/filters
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "filterProperties": {
    },
  • "filterVisibility": "EveryOne"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Delete a Filter

Deletes a filter for the given ID.

SecurityApiKey
Request
path Parameters
identifier
required
string

Filter Identifier

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

type
required
string

Type of Filter

Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment"
Responses
400

Bad Request

500

Internal server error

default

Boolean status whether request was successful or not

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

Delete a Filter

Deletes a filter for the given ID.

SecurityApiKey
Request
path Parameters
identifier
required
string

Filter Identifier

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

type
required
string

Type of Filter

Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment"
Responses
400

Bad Request

500

Internal server error

default

Boolean status whether request was successful or not

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

Delete a Filter

Deletes a filter for the given ID.

SecurityApiKey
Request
path Parameters
identifier
required
string

Filter Identifier

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

type
required
string

Type of Filter

Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment"
Responses
400

Bad Request

500

Internal server error

default

Boolean status whether request was successful or not

delete/ccm/api/filters/{identifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Delete a Filter

Deletes a filter for the given ID.

SecurityApiKey
Request
path Parameters
identifier
required
string

Filter Identifier

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

type
required
string

Type of Filter

Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment"
Responses
400

Bad Request

500

Internal server error

default

Boolean status whether request was successful or not

delete/template/api/filters/{identifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

List Filters

Lists Filters for the given criteria.

SecurityApiKey
Request
query Parameters
pageIndex
integer <int32>
Default: 0

Page number of navigation. If left empty, default value of 0 is assumed.

pageSize
integer <int32>
Default: 100

Number of entries per page. If left empty, default value of 100 is assumed

accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

type
required
string

Type of Filter

Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment"
Responses
400

Bad Request

500

Internal server error

default

Returns the list of Filters

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

List Filters

Lists Filters for the given criteria.

SecurityApiKey
Request
query Parameters
pageIndex
integer <int32>
Default: 0

Page number of navigation. If left empty, default value of 0 is assumed.

pageSize
integer <int32>
Default: 100

Number of entries per page. If left empty, default value of 100 is assumed

accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

type
required
string

Type of Filter

Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment"
Responses
400

Bad Request

500

Internal server error

default

Returns the list of Filters

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

List Filters

Lists Filters for the given criteria.

SecurityApiKey
Request
query Parameters
pageIndex
integer <int32>
Default: 0

Page number of navigation. If left empty, default value of 0 is assumed.

pageSize
integer <int32>
Default: 100

Number of entries per page. If left empty, default value of 100 is assumed

accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

type
required
string

Type of Filter

Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment"
Responses
400

Bad Request

500

Internal server error

default

Returns the list of Filters

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

List Filters

Lists Filters for the given criteria.

SecurityApiKey
Request
query Parameters
pageIndex
integer <int32>
Default: 0

Page number of navigation. If left empty, default value of 0 is assumed.

pageSize
integer <int32>
Default: 100

Number of entries per page. If left empty, default value of 100 is assumed

accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

type
required
string

Type of Filter

Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment"
Responses
400

Bad Request

500

Internal server error

default

Returns the list of Filters

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

Return Filter Details

Returns the settings of a filter for the given ID.

SecurityApiKey
Request
path Parameters
identifier
required
string

Filter Identifier

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

type
required
string

Type of Filter

Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment"
Responses
400

Bad Request

500

Internal server error

default

Returns Filter having filterIdentifier as specified in request

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

Return Filter Details

Returns the settings of a filter for the given ID.

SecurityApiKey
Request
path Parameters
identifier
required
string

Filter Identifier

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

type
required
string

Type of Filter

Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment"
Responses
400

Bad Request

500

Internal server error

default

Returns Filter having filterIdentifier as specified in request

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

Return Filter Details

Returns the settings of a filter for the given ID.

SecurityApiKey
Request
path Parameters
identifier
required
string

Filter Identifier

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

type
required
string

Type of Filter

Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment"
Responses
400

Bad Request

500

Internal server error

default

Returns Filter having filterIdentifier as specified in request

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

Return Filter Details

Returns the settings of a filter for the given ID.

SecurityApiKey
Request
path Parameters
identifier
required
string

Filter Identifier

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

type
required
string

Type of Filter

Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment"
Responses
400

Bad Request

500

Internal server error

default

Returns Filter having filterIdentifier as specified in request

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

Update a Filter

Updates the filter for the given ID.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema:

This is the updated Filter. This should have all the fields not just the updated ones

name
required
string

Name of the Filter.

identifier
required
string

Identifier of the Filter.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

required
object (FilterProperties)

Properties of the Filter entity defined in Harness.

filterVisibility
string

This indicates visibility of Filter, by default it is Everyone.

Enum: "EveryOne" "OnlyCreator"
Responses
400

Bad Request

500

Internal server error

default

Returns the updated Filter

put/ng/api/filters
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "filterProperties": {
    },
  • "filterVisibility": "EveryOne"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update a Filter

Updates the filter for the given ID.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema:

This is the updated Filter. This should have all the fields not just the updated ones

name
required
string

Name of the Filter.

identifier
required
string

Identifier of the Filter.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

required
object (FilterProperties)

Properties of the Filter entity defined in Harness.

filterVisibility
string

This indicates visibility of Filter, by default it is Everyone.

Enum: "EveryOne" "OnlyCreator"
Responses
400

Bad Request

500

Internal server error

default

Returns the updated Filter

put/pipeline/api/filters
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "filterProperties": {
    },
  • "filterVisibility": "EveryOne"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update a Filter

Updates the filter for the given ID.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema:

This is the updated Filter. This should have all the fields not just the updated ones

name
required
string

Name of the Filter.

identifier
required
string

Identifier of the Filter.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

required
object (FilterProperties)

Properties of the Filter entity defined in Harness.

filterVisibility
string

This indicates visibility of Filter, by default it is Everyone.

Enum: "EveryOne" "OnlyCreator"
Responses
400

Bad Request

500

Internal server error

default

Returns the updated Filter

put/ccm/api/filters
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "filterProperties": {
    },
  • "filterVisibility": "EveryOne"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update a Filter

Updates the filter for the given ID.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema:

This is the updated Filter. This should have all the fields not just the updated ones

name
required
string

Name of the Filter.

identifier
required
string

Identifier of the Filter.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

required
object (FilterProperties)

Properties of the Filter entity defined in Harness.

filterVisibility
string

This indicates visibility of Filter, by default it is Everyone.

Enum: "EveryOne" "OnlyCreator"
Responses
400

Bad Request

500

Internal server error

default

Returns the updated Filter

put/template/api/filters
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "filterProperties": {
    },
  • "filterVisibility": "EveryOne"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}