Filter

This contains APIs related to Filter as defined in Harness

Gets a Filter by identifier

Request
Security:
ApiKey (readwrite)
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"
Responses
400

Bad Request

500

Internal server error

default

Returns Filter having filterIdentifier as specified in request

get/ng/api/filters/{identifier}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/filters/:identifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&type=CONNECTOR' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Delete a Filter by identifier

Request
Security:
ApiKey (readwrite)
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"
Responses
400

Bad Request

500

Internal server error

default

Boolean status whether request was successful or not

delete/ng/api/filters/{identifier}
Request samples
curl -i -X DELETE \
  'https://app.harness.io/gateway/ng/api/filters/:identifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&type=CONNECTOR' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get the list of Filters satisfying the criteria (if any) in the request

Request
Security:
ApiKey (readwrite)
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"
Responses
400

Bad Request

500

Internal server error

default

Returns the list of Filters

get/ng/api/filters
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/filters?pageIndex=0&pageSize=100&accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&type=CONNECTOR' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Updates the Filter

Request
Security:
ApiKey (readwrite)
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
identifier
required
string
orgIdentifier
string
projectIdentifier
string
required
object (FilterProperties)

This is the view of the Filter Properties entity defined in Harness

filterVisibility
string
Enum: "EVERYONE" "ONLY_CREATOR"
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": [
    ]
}

Creates a Filter

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

Account Identifier for the Entity

Request Body schema:

Details of the Connector to create

name
required
string
identifier
required
string
orgIdentifier
string
projectIdentifier
string
required
object (FilterProperties)

This is the view of the Filter Properties entity defined in Harness

filterVisibility
string
Enum: "EVERYONE" "ONLY_CREATOR"
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": [
    ]
}

Gets a Filter by identifier

Request
Security:
ApiKey (readwrite)
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"
Responses
400

Bad Request

500

Internal server error

default

Returns Filter having filterIdentifier as specified in request

get/pipeline/api/filters/{identifier}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/filters/:identifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&type=CONNECTOR' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Delete a Filter by identifier

Request
Security:
ApiKey (readwrite)
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"
Responses
400

Bad Request

500

Internal server error

default

Boolean status whether request was successful or not

delete/pipeline/api/filters/{identifier}
Request samples
curl -i -X DELETE \
  'https://app.harness.io/gateway/pipeline/api/filters/:identifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&type=CONNECTOR' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get the list of Filters satisfying the criteria (if any) in the request

Request
Security:
ApiKey (readwrite)
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"
Responses
400

Bad Request

500

Internal server error

default

Returns the list of Filters

get/pipeline/api/filters
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/filters?pageIndex=0&pageSize=100&accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&type=CONNECTOR' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Updates the Filter

Request
Security:
ApiKey (readwrite)
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
identifier
required
string
orgIdentifier
string
projectIdentifier
string
required
object (FilterProperties)

This is the view of the Filter Properties entity defined in Harness

filterVisibility
string
Enum: "EVERYONE" "ONLY_CREATOR"
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": [
    ]
}

Creates a Filter

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

Account Identifier for the entity

Request Body schema:

Details of the Connector to create

name
required
string
identifier
required
string
orgIdentifier
string
projectIdentifier
string
required
object (FilterProperties)

This is the view of the Filter Properties entity defined in Harness

filterVisibility
string
Enum: "EVERYONE" "ONLY_CREATOR"
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": [
    ]
}