filters

Get Filter

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string
query Parameters
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
type
required
string
Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template"
Responses
200

successful operation

400

Bad Request

500

Internal server error

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",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Delete a filter

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string
query Parameters
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
type
required
string
Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template"
Responses
200

successful operation

400

Bad Request

500

Internal server error

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",
  • "data": true,
  • "metaData": { },
  • "correlationId": "string"
}

Get Filter

Request
Security:
ApiKey (readwrite)
query Parameters
pageIndex
integer <int32>
Default: 0
pageSize
integer <int32>
Default: 100
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
type
required
string
Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template"
Responses
200

successful operation

400

Bad Request

500

Internal server error

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",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Update a Filter

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
Request Body schema:
name
required
string
identifier
required
string
orgIdentifier
string
projectIdentifier
string
required
object (FilterProperties)
filterVisibility
string
Enum: "EveryOne" "OnlyCreator"
Responses
200

successful operation

400

Bad Request

500

Internal server error

put/ng/api/filters
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "filterProperties": {
    },
  • "filterVisibility": "EveryOne"
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Create a Filter

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
Request Body schema:
name
required
string
identifier
required
string
orgIdentifier
string
projectIdentifier
string
required
object (FilterProperties)
filterVisibility
string
Enum: "EveryOne" "OnlyCreator"
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/ng/api/filters
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "filterProperties": {
    },
  • "filterVisibility": "EveryOne"
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get Filter

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string
query Parameters
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
type
required
string
Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template"
Responses
200

successful operation

400

Bad Request

500

Internal server error

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",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Delete a filter

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string
query Parameters
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
type
required
string
Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template"
Responses
200

successful operation

400

Bad Request

500

Internal server error

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",
  • "data": true,
  • "metaData": { },
  • "correlationId": "string"
}

Get Filter

Request
Security:
ApiKey (readwrite)
query Parameters
pageIndex
integer <int32>
Default: 0
pageSize
integer <int32>
Default: 100
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
type
required
string
Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template"
Responses
200

successful operation

400

Bad Request

500

Internal server error

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",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Update a Filter

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
Request Body schema:
name
required
string
identifier
required
string
orgIdentifier
string
projectIdentifier
string
required
object (FilterProperties)
filterVisibility
string
Enum: "EveryOne" "OnlyCreator"
Responses
200

successful operation

400

Bad Request

500

Internal server error

put/pipeline/api/filters
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "filterProperties": {
    },
  • "filterVisibility": "EveryOne"
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Create a Filter

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
Request Body schema:
name
required
string
identifier
required
string
orgIdentifier
string
projectIdentifier
string
required
object (FilterProperties)
filterVisibility
string
Enum: "EveryOne" "OnlyCreator"
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/pipeline/api/filters
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "filterProperties": {
    },
  • "filterVisibility": "EveryOne"
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get Filter

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string
query Parameters
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
type
required
string
Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template"
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/resourcegroup/api/filters/{identifier}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/resourcegroup/api/filters/:identifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&type=Connector' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Delete a filter

Request
Security:
ApiKey (readwrite)
path Parameters
identifier
required
string
query Parameters
accountIdentifier
string
orgIdentifier
string
projectIdentifier
string
type
required
string
Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template"
Responses
200

successful operation

400

Bad Request

500

Internal server error

delete/resourcegroup/api/filters/{identifier}
Request samples
curl -i -X DELETE \
  'https://app.harness.io/gateway/resourcegroup/api/filters/:identifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&type=Connector' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": true,
  • "metaData": { },
  • "correlationId": "string"
}

Get Filter

Request
Security:
ApiKey (readwrite)
query Parameters
pageIndex
integer <int32>
Default: 0
pageSize
integer <int32>
Default: 100
accountIdentifier
required
string
orgIdentifier
string
projectIdentifier
string
type
required
string
Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template"
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/resourcegroup/api/filters
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/resourcegroup/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",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Update a Filter

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
string
Request Body schema:
name
required
string
identifier
required
string
orgIdentifier
string
projectIdentifier
string
required
object (resourcegroupFilterProperties)
filterVisibility
string
Enum: "EveryOne" "OnlyCreator"
Responses
200

successful operation

400

Bad Request

500

Internal server error

put/resourcegroup/api/filters
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "filterProperties": {
    },
  • "filterVisibility": "EveryOne"
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Create a Filter

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
Request Body schema:
name
required
string
identifier
required
string
orgIdentifier
string
projectIdentifier
string
required
object (resourcegroupFilterProperties)
filterVisibility
string
Enum: "EveryOne" "OnlyCreator"
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/resourcegroup/api/filters
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "filterProperties": {
    },
  • "filterVisibility": "EveryOne"
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}