AuditFilters

This contains APIs related to Filter of type Audit as defined in Harness

Creates a Filter

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema:

Details of the Filter 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/audit/api/auditFilters
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 of type Audit by identifier

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.

Responses
400

Bad Request

500

Internal server error

default

Boolean status whether request was successful or not

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

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

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.

Responses
400

Bad Request

500

Internal server error

default

Returns the list of Filters of type Audit

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

Gets a Filter of type Audit by identifier

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.

Responses
400

Bad Request

500

Internal server error

default

Returns Filter of type Audit and having filterIdentifier as specified in request

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

Updates the Filter of type Audit

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/audit/api/auditFilters
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": [
    ]
}