Notification Channels

This contains APIs for Notification Channels

List Notification channels

Returns a list of notification channels for the scope.

Securityx-api-key

Request

path Parameters

org required	string Identifier field of the organization the resource is scoped to
project required	string Identifier field of the project the resource is scoped to

query Parameters

limit	integer <= 1000 Default: 30 Number of items to return per page.
search_term	string This would be used to filter resources having attributes matching with search term.
sort	string Parameter on the basis of which sorting is done. Enum: "name" "identifier" "created" "updated"
order	string Order on the basis of which sorting is done. Enum: "ASC" "DESC"
notification_channel_type	string Notification Channel Type
page	integer Default: 0 Pagination page number strategy: Specify the page number within the paginated collection related to the number of items in each page
include_parent_scope	boolean Default: false Include entities from current and parent scopes.

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Responses

200

Example response

get/v1/orgs/{org}/projects/{project}/notification-channels

Request samples

curl
Java
Go

Response samples

[{"identifier": "string",
"org": "string",
"project": "string",
"notification_channel_type": "EMAIL",
"status": "ENABLED",
"channel": {"email_ids": ["string"
],
"slack_webhook_urls": ["string"
],
"webhook_urls": ["string"
],
"pager_duty_integration_keys": ["string"
],
"ms_team_keys": ["string"
],
"user_groups": [{"identifier": "string",
"org": "string",
"project": "string"
}
],
"headers": [{"key": "string",
"value": "string"
}
],
"datadog_urls": ["string"
],
"api_key": "string",
"delegate_selectors": ["string"
],
"execute_on_delegate": true
},
"last_modified": 0,
"created": 0,
"name": "string",
"account": "string"
}
]

Create Notification channel

Create Notification Channel

Securityx-api-key

Request

path Parameters

org required	string Identifier field of the organization the resource is scoped to
project required	string Identifier field of the project the resource is scoped to

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Request Body schema: application/json

Notification channel request

identifier	string
org	string
project	string
notification_channel_type required	string (ChannelType) Notification Channel Type Enum: "EMAIL" "SLACK" "PAGERDUTY" "MSTEAMS" "WEBHOOK" "DATADOG"
status	string (Status) Notification Rule Status Enum: "ENABLED" "DISABLED"
required	object (ChannelDTO)
last_modified	integer <int64>
created	integer <int64>
name	string
account	string

Responses

201

Notification channel response

post/v1/orgs/{org}/projects/{project}/notification-channels

Request samples

Payload
curl
Java
Go

application/json

{"identifier": "string",
"org": "string",
"project": "string",
"notification_channel_type": "EMAIL",
"status": "ENABLED",
"channel": {"email_ids": ["string"
],
"slack_webhook_urls": ["string"
],
"webhook_urls": ["string"
],
"pager_duty_integration_keys": ["string"
],
"ms_team_keys": ["string"
],
"user_groups": [{"identifier": "string",
"org": "string",
"project": "string"
}
],
"headers": [{"key": "string",
"value": "string"
}
],
"datadog_urls": ["string"
],
"api_key": "string",
"delegate_selectors": ["string"
],
"execute_on_delegate": true
},
"last_modified": 0,
"created": 0,
"name": "string",
"account": "string"
}

Response samples

{"identifier": "string",
"org": "string",
"project": "string",
"notification_channel_type": "EMAIL",
"status": "ENABLED",
"channel": {"email_ids": ["string"
],
"slack_webhook_urls": ["string"
],
"webhook_urls": ["string"
],
"pager_duty_integration_keys": ["string"
],
"ms_team_keys": ["string"
],
"user_groups": [{"identifier": "string",
"org": "string",
"project": "string"
}
],
"headers": [{"key": "string",
"value": "string"
}
],
"datadog_urls": ["string"
],
"api_key": "string",
"delegate_selectors": ["string"
],
"execute_on_delegate": true
},
"last_modified": 0,
"created": 0,
"name": "string",
"account": "string"
}

Get Notification channel

Get Notification Channel

Securityx-api-key

Request

path Parameters

notification-channel required	string identifier
org required	string Identifier field of the organization the resource is scoped to
project required	string Identifier field of the project the resource is scoped to

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Responses

200

Notification channel response

get/v1/orgs/{org}/projects/{project}/notification-channels/{notification-channel}

Request samples

curl
Java
Go

Response samples

{"identifier": "string",
"org": "string",
"project": "string",
"notification_channel_type": "EMAIL",
"status": "ENABLED",
"channel": {"email_ids": ["string"
],
"slack_webhook_urls": ["string"
],
"webhook_urls": ["string"
],
"pager_duty_integration_keys": ["string"
],
"ms_team_keys": ["string"
],
"user_groups": [{"identifier": "string",
"org": "string",
"project": "string"
}
],
"headers": [{"key": "string",
"value": "string"
}
],
"datadog_urls": ["string"
],
"api_key": "string",
"delegate_selectors": ["string"
],
"execute_on_delegate": true
},
"last_modified": 0,
"created": 0,
"name": "string",
"account": "string"
}

Delete Notification Channel

Delete notification channel

Securityx-api-key

Request

path Parameters

notification-channel required	string identifier
org required	string Identifier field of the organization the resource is scoped to
project required	string Identifier field of the project the resource is scoped to

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Responses

204

No Content

400

delete/v1/orgs/{org}/projects/{project}/notification-channels/{notification-channel}

Request samples

curl
Java
Go

Response samples

application/json

{ }

Update Notification Channel

Securityx-api-key

Request

path Parameters

notification-channel required	string identifier
org required	string Identifier field of the organization the resource is scoped to
project required	string Identifier field of the project the resource is scoped to

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Request Body schema: application/json

Notification channel request

identifier	string
org	string
project	string
notification_channel_type required	string (ChannelType) Notification Channel Type Enum: "EMAIL" "SLACK" "PAGERDUTY" "MSTEAMS" "WEBHOOK" "DATADOG"
status	string (Status) Notification Rule Status Enum: "ENABLED" "DISABLED"
required	object (ChannelDTO)
last_modified	integer <int64>
created	integer <int64>
name	string
account	string

Responses

200

Notification channel response

put/v1/orgs/{org}/projects/{project}/notification-channels/{notification-channel}

Request samples

Payload
curl
Java
Go

application/json

{"identifier": "string",
"org": "string",
"project": "string",
"notification_channel_type": "EMAIL",
"status": "ENABLED",
"channel": {"email_ids": ["string"
],
"slack_webhook_urls": ["string"
],
"webhook_urls": ["string"
],
"pager_duty_integration_keys": ["string"
],
"ms_team_keys": ["string"
],
"user_groups": [{"identifier": "string",
"org": "string",
"project": "string"
}
],
"headers": [{"key": "string",
"value": "string"
}
],
"datadog_urls": ["string"
],
"api_key": "string",
"delegate_selectors": ["string"
],
"execute_on_delegate": true
},
"last_modified": 0,
"created": 0,
"name": "string",
"account": "string"
}

Response samples

{"identifier": "string",
"org": "string",
"project": "string",
"notification_channel_type": "EMAIL",
"status": "ENABLED",
"channel": {"email_ids": ["string"
],
"slack_webhook_urls": ["string"
],
"webhook_urls": ["string"
],
"pager_duty_integration_keys": ["string"
],
"ms_team_keys": ["string"
],
"user_groups": [{"identifier": "string",
"org": "string",
"project": "string"
}
],
"headers": [{"key": "string",
"value": "string"
}
],
"datadog_urls": ["string"
],
"api_key": "string",
"delegate_selectors": ["string"
],
"execute_on_delegate": true
},
"last_modified": 0,
"created": 0,
"name": "string",
"account": "string"
}

Validate unique identifier for notification channel

Securityx-api-key

Request

path Parameters

org required	string Identifier field of the organization the resource is scoped to
notification-channel required	string identifier

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Responses

200

302

Found

get/v1/orgs/{org}/validate-channels/{notification-channel}

Request samples

curl
Java
Go

Response samples

application/json

{"exists": true
}

Validate Notification Channel Identifier

Securityx-api-key

Request

path Parameters

org required	string Identifier field of the organization the resource is scoped to
project required	string Identifier field of the project the resource is scoped to
notification-channel required	string identifier

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Responses

200

302

Found

get/v1/orgs/{org}/projects/{project}/validate-channels/{notification-channel}

Request samples

curl
Java
Go

Response samples

application/json

{"exists": true
}

Validate Notification channel identifier

Validate Notification Channel Indetifier

Securityx-api-key

Request

path Parameters

notification-channel

required

string

identifier

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Responses

200

302

Found

get/v1/validate-channels/{notification-channel}

Request samples

curl
Java
Go

Response samples

application/json

{"exists": true
}

➔ Next to Notification Rules