Integrations | Deckhouse Code

Use this API to manage integrations for a project, or for a group and its subgroups.

Managing integrations requires the Maintainer or Owner role for the project or group.

List all active integrations

GET /api/v4/groups/{id}/integrations

Lists all active integrations.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`401`	Unauthorized	—
`404`	Not found	—

Create or update the Apple App Store integration

PUT /api/v4/groups/{id}/integrations/apple-app-store

Creates or updates the Apple App Store integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`app_store_issuer_id` Required	String	Apple App Store Connect issuer ID
`app_store_key_id` Required	String	Apple App Store Connect key ID
`app_store_private_key` Required	String	Apple App Store Connect private key
`app_store_private_key_file_name` Required	String	Apple App Store Connect private key file name
`app_store_protected_refs`	Boolean	Set variables on protected branches and tags only
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Asana integration

PUT /api/v4/groups/{id}/integrations/asana

Creates or updates the Asana integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`api_key` Required	String	User API token. The user must have access to the task. All comments are attributed to this user
`push_events`	Boolean	Trigger event for pushes to the repository
`restrict_to_branch`	String	Comma-separated list of branches to be automatically inspected. Leave blank to include all branches
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Assembla integration

PUT /api/v4/groups/{id}/integrations/assembla

Creates or updates the Assembla integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`push_events`	Boolean	Trigger event for pushes to the repository
`subdomain`	String	The subdomain setting
`token` Required	String	The authentication token
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Bamboo integration

PUT /api/v4/groups/{id}/integrations/bamboo

Creates or updates the Bamboo integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`bamboo_url` Required	String	Bamboo root URL (for example, `https://bamboo.example.com`)
`build_key` Required	String	Bamboo build plan key (for example, `KEY`)
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`password` Required	String	Password of the user
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username` Required	String	User with API access to the Bamboo server

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Bugzilla integration

PUT /api/v4/groups/{id}/integrations/bugzilla

Creates or updates the Bugzilla integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`new_issue_url` Required	String	URL of the new issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Buildkite integration

PUT /api/v4/groups/{id}/integrations/buildkite

Creates or updates the Buildkite integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`enable_ssl_verification`	Boolean	DEPRECATED: This parameter has no effect because SSL verification is always enabled
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`project_url` Required	String	Pipeline URL (for example, `https://buildkite.com/example/pipeline`)
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`token` Required	String	Token you get after you create a Buildkite pipeline with a Deckhouse Code repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Campfire integration

PUT /api/v4/groups/{id}/integrations/campfire

Creates or updates the Campfire integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`push_events`	Boolean	Trigger event for pushes to the repository
`room`	String	ID portion of the Campfire room URL
`subdomain`	String	`.campfirenow.com` subdomain when you’re signed in
`token` Required	String	API authentication token from Campfire. To get the token, sign in to Campfire and select My info
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Clickup integration

PUT /api/v4/groups/{id}/integrations/clickup

Creates or updates the Clickup integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Code Scoring integration

PUT /api/v4/groups/{id}/integrations/code-scoring

Creates or updates the Code Scoring integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`codescoring_agent_image`	String	Optional. The image the CodeScoring scan jobs run in, with registry and tag or digest. It needs curl, ca-certificates, jq, ruby and git; the johnny agent is downloaded into it at run time. Left empty, the jobs use the default image
`codescoring_bom_format`	String	Optional. Which CycloneDX version the bill of materials is written in. They all list the same components: pick an older version for a tool downstream that needs one, or the extended 1.6 for CodeScoring’s own GOST properties. A Scan Execution Policy can name a format of its own, which wins. Left empty here and in the policy, the scan jobs write CycloneDX 1.6 JSON
`codescoring_ca_cert`	String	PEM certificate of the authority that signed the server’s certificate. Used only when the trust setting above says so
`codescoring_cloud_resolve`	Boolean	Let the CodeScoring server work out the dependency tree instead of the runner. The only resolver that needs no package manager in the scan job image, and it finds the transitive packages a manifest read misses. Known cost: the server currently returns the vulnerability report empty when this is on, so findings reach the tests summary but not the vulnerability report. Leave it off unless the dependency list matters more
`codescoring_extra_args`	String	Optional. Passed to the agent as written, for options this form does not name, such as per-manager arguments. A setting above wins over the same option written here
`codescoring_ignore_paths`	String	Optional. One glob per line. Keeps test fixtures and vendored trees out of the results
`codescoring_scan_mode`	String	What to scan: a source directory, a container image, or an existing CycloneDX document. Defaults to the source directory
`codescoring_scan_target`	String	Optional. Directory, image reference or SBOM path, depending on the scan mode. Defaults to the whole checkout
`codescoring_stage`	String	The policy stage this scan reports as. The agent takes one, so the scan reports as one. Defaults to “build”
`codescoring_tls_mode`	String	How the scan job decides whether to trust the CodeScoring server. It applies to the requests the job makes with curl – fetching the agent, and the connection test above. The johnny agent itself does not verify the certificate at all and offers no way to make it, so nothing here changes what the scan itself trusts
`codescoring_token` Required	String	API token to authenticate and download the Johnny agent
`codescoring_url` Required	String	Base URL of the CodeScoring instance
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Confluence integration

PUT /api/v4/groups/{id}/integrations/confluence

Creates or updates the Confluence integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`confluence_url` Required	String	URL of the Confluence Workspace hosted on `atlassian.net`
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Custom Issue Tracker integration

PUT /api/v4/groups/{id}/integrations/custom-issue-tracker

Creates or updates the Custom Issue Tracker integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`new_issue_url` Required	String	URL of the new issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Datadog integration

PUT /api/v4/groups/{id}/integrations/datadog

Creates or updates the Datadog integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`api_key` Required	String	API key used for authentication with Datadog
`api_url`	String	Full URL of your Datadog site. Only required if you do not use a standard Datadog site
`archive_trace_events`	Boolean	When enabled, job logs are collected by Datadog and displayed along with pipeline execution traces
`build_events`	Boolean	Trigger event when a build is created
`datadog_ci_visibility`	Boolean	Enable CI Visibility
`datadog_env`	String	For self-managed deployments, `env` tag for all the data sent to Datadog
`datadog_service`	String	Tag all pipeline data from this Deckhouse Code instance in Datadog. Can be used when managing several self-managed deployments
`datadog_site`	String	Datadog site to send data to. Learn more about Datadog sites in the documentation
`datadog_tags`	String	Custom tags in Datadog. Specify one tag per line in the format `key:value\nkey2:value2`
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`project_events`	Boolean	—
`push_events`	Boolean	Trigger event for pushes to the repository
`subgroup_events`	Boolean	—
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Defect Dojo integration

PUT /api/v4/groups/{id}/integrations/defect-dojo

Creates or updates the Defect Dojo integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`api_token` Required	String	Token used to authenticate with the DefectDojo API
`auto_create_context`	Boolean	—
`ca_cert`	String	PEM certificate of the authority that signed the server’s certificate. Used only when the trust setting above says so
`close_old_findings`	Boolean	—
`engagement_name`	String	DefectDojo engagement. Leave blank to use the branch name
`findings_active`	Boolean	—
`findings_verified`	Boolean	—
`minimum_severity`	String	Ignore findings below this severity on import
`product_name`	String	DefectDojo product. Leave blank to use the project full path
`product_type_name`	String	DefectDojo product type, used when a product is auto-created
`tls_mode`	String	How this instance decides whether to trust the DefectDojo server. Unlike a scan, this connection is made from here rather than from a job, so verification can be turned off – which leaves the upload open to interception, and the reports carry everything the scanners found
`url` Required	String	Base URL of your DefectDojo instance
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Diffblue Cover integration

PUT /api/v4/groups/{id}/integrations/diffblue-cover

Creates or updates the Diffblue Cover integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`diffblue_access_token_name` Required	String	Access token name used by Diffblue Cover in pipelines
`diffblue_access_token_secret` Required	String	Access token secret used by Diffblue Cover in pipelines
`diffblue_license_key` Required	String	Diffblue Cover license key
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Discord integration

PUT /api/v4/groups/{id}/integrations/discord

Creates or updates the Discord integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`alert_channel`	String	The name of the channel to receive alert_events notifications
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issue_channel`	String	The name of the channel to receive confidential_issues_events notifications
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_channel`	String	The name of the channel to receive confidential_note_events notifications
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`deployment_channel`	String	The name of the channel to receive deployment_events notifications
`deployment_events`	Boolean	Trigger event when a deployment starts or finishes
`incident_channel`	String	The name of the channel to receive incident_events notifications
`issue_channel`	String	The name of the channel to receive issues_events notifications
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_request_channel`	String	The name of the channel to receive merge_requests_events notifications
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_channel`	String	The name of the channel to receive note_events notifications
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_channel`	String	The name of the channel to receive pipeline_events notifications
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_channel`	String	The name of the channel to receive push_events notifications
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_channel`	String	The name of the channel to receive tag_push_events notifications
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	Discord webhook (for example, `https://discord.com/api/webhooks/…`)
`wiki_page_channel`	String	The name of the channel to receive wiki_page_events notifications
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Drone Ci integration

PUT /api/v4/groups/{id}/integrations/drone-ci

Creates or updates the Drone Ci integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`drone_url` Required	String	Drone CI URL (for example, `http://drone.example.com`)
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`token` Required	String	Drone CI token
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Emails On Push integration

PUT /api/v4/groups/{id}/integrations/emails-on-push

Creates or updates the Emails On Push integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`disable_diffs`	Boolean	Disable code diffs
`push_events`	Boolean	Trigger event for pushes to the repository
`recipients` Required	String	Emails separated by whitespace
`send_from_committer_email`	Boolean	Send from committer
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Ewm integration

PUT /api/v4/groups/{id}/integrations/ewm

Creates or updates the Ewm integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`new_issue_url` Required	String	URL of the new issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the External Wiki integration

PUT /api/v4/groups/{id}/integrations/external-wiki

Creates or updates the External Wiki integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`external_wiki_url` Required	String	URL of the external wiki
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Gitlab Slack Application integration

PUT /api/v4/groups/{id}/integrations/gitlab-slack-application

Creates or updates the Gitlab Slack Application integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`alert_channel`	String	The name of the channel to receive alert_events notifications
`alert_events`	Boolean	Trigger event when a new, unique alert is recorded
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`channel`	String	Default channel to use if no other channel is configured
`confidential_issue_channel`	String	The name of the channel to receive confidential_issues_events notifications
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_channel`	String	The name of the channel to receive confidential_note_events notifications
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`deployment_channel`	String	The name of the channel to receive deployment_events notifications
`deployment_events`	Boolean	Trigger event when a deployment starts or finishes
`incident_channel`	String	The name of the channel to receive incident_events notifications
`incident_events`	Boolean	Trigger event when an incident is created
`issue_channel`	String	The name of the channel to receive issues_events notifications
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`labels_to_be_notified`	String	Labels to send notifications for. Leave blank to receive notifications for all events
`labels_to_be_notified_behavior`	String	Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`
`merge_request_channel`	String	The name of the channel to receive merge_requests_events notifications
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_channel`	String	The name of the channel to receive note_events notifications
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_channel`	String	The name of the channel to receive pipeline_events notifications
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_channel`	String	The name of the channel to receive push_events notifications
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_channel`	String	The name of the channel to receive tag_push_events notifications
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`wiki_page_channel`	String	The name of the channel to receive wiki_page_events notifications
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Google Play integration

PUT /api/v4/groups/{id}/integrations/google-play

Creates or updates the Google Play integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`google_play_protected_refs`	Boolean	Set variables on protected branches and tags only
`package_name` Required	String	Package name of the app in Google Play
`service_account_key` Required	String	Google Play service account key
`service_account_key_file_name` Required	String	File name of the Google Play service account key
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Hangouts Chat integration

PUT /api/v4/groups/{id}/integrations/hangouts-chat

Creates or updates the Hangouts Chat integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Hangouts Chat webhook (for example, `https://chat.googleapis.com/v1/spaces...`)
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Harbor integration

PUT /api/v4/groups/{id}/integrations/harbor

Creates or updates the Harbor integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`password` Required	String	The password of the user
`project_name` Required	String	The name of the project in the Harbor instance. For example, `testproject`
`url` Required	String	The base URL to the Harbor instance linked to the Deckhouse Code project. For example, `https://demo.goharbor.io`
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username` Required	String	The username created in the Harbor interface

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Irker integration

PUT /api/v4/groups/{id}/integrations/irker

Creates or updates the Irker integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`colorize_messages`	Boolean	Colorize messages
`default_irc_uri`	String	URI to add before each recipient. The default value is `irc://irc.network.net:6697/`
`push_events`	Boolean	Trigger event for pushes to the repository
`recipients` Required	String	Comma-separated list of channels or email addresses
`server_host`	String	irker daemon hostname. The default value is `localhost`
`server_port`	Integer	irker daemon port. The default value is `6659`
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Jenkins integration

PUT /api/v4/groups/{id}/integrations/jenkins

Creates or updates the Jenkins integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`jenkins_url` Required	String	URL of the Jenkins server
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`password`	String	Password of the Jenkins server
`project_name` Required	String	Name of the Jenkins project
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username`	String	Username of the Jenkins server

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Jira integration

PUT /api/v4/groups/{id}/integrations/jira

Creates or updates the Jira integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`api_url`	String	The base URL to the Jira instance API. Web URL value is used if not set (for example, `https://jira-api.example.com`)
`comment_on_event_enabled`	Boolean	Enable comments inside Jira issues on each GitLab event (commit / merge request)
`commit_events`	Boolean	Trigger event when a commit is created or updated
`issues_enabled`	String	Enable viewing Jira issues in Deckhouse Code
`jira_auth_type`	Integer	The authentication method to use with Jira. Use `0` for basic authentication, `1` for Jira personal access token, and `2` for Jira Cloud service accounts. Defaults to `0`
`jira_issue_prefix`	String	Prefix to match Jira issue keys
`jira_issue_regex`	String	Regular expression to match Jira issue keys
`jira_issue_transition_id`	String	The ID of one or more transitions for custom issue transitions.Ignored when `jira_issue_transition_automatic` is enabled. Defaults to a blank string,which disables custom transitions
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`password` Required	String	The Jira API token, password, or personal access token to use with Jira. When using Basic Authentication (`jira_auth_type` is `0`), use an API token for Jira Cloud, and a password for Jira Data Center or Jira Server. For a Jira personal access token (`jira_auth_type` is `1`), use the personal access token
`project_keys`	Array of strings	Keys of Jira projects to display. When `issues_enabled` is `true`, this setting filters which Jira projects are shown in Deckhouse Code. It does not restrict the API token’s access
`url` Required	String	The URL to the Jira project which is being linked to this Deckhouse Code project (for example, `https://jira.example.com`)
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username`	String	The email or username to use with Jira. Use an email for Jira Cloud, and a username for Jira Data Center and Jira Server. Required when using basic authentication (`jira_auth_type` is `0`)

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Jira Cloud App integration

PUT /api/v4/groups/{id}/integrations/jira-cloud-app

Creates or updates the Jira Cloud App integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`jira_cloud_app_deployment_gating_environments`	String	Enter the environment (production,staging,testing,development) where you want to enable deployment gating. Use comma (,) to separate multiple environments
`jira_cloud_app_enable_deployment_gating`	Boolean	Enable to approve or reject blocked Deckhouse Code deployments from Jira Service Management
`jira_cloud_app_service_ids`	String	Copy and paste your JSM Service ID here. Use comma (,) to separate multiple IDs
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Linear integration

PUT /api/v4/groups/{id}/integrations/linear

Creates or updates the Linear integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`workspace_url` Required	String	Linear workspace URL (for example, https://linear.app/example)

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Matrix integration

PUT /api/v4/groups/{id}/integrations/matrix

Creates or updates the Matrix integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`hostname`	String	Custom hostname of the Matrix server. The default value is `https://matrix-client.matrix.org`
`incident_events`	Boolean	Trigger event when an incident is created
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`room` Required	String	Unique identifier for the target room (in the format `!qPKKM111FFKKsfoCVy:matrix.org`)
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`token` Required	String	The Matrix access token (for example, `syt-zyx57W2v1u123ew11`)
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Mattermost integration

PUT /api/v4/groups/{id}/integrations/mattermost

Creates or updates the Mattermost integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`alert_channel`	String	The name of the channel to receive alert_events notifications
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`channel`	String	Default channel to use if no other channel is configured
`confidential_issue_channel`	String	The name of the channel to receive confidential_issues_events notifications
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_channel`	String	The name of the channel to receive confidential_note_events notifications
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`deployment_channel`	String	The name of the channel to receive deployment_events notifications
`deployment_events`	Boolean	Trigger event when a deployment starts or finishes
`incident_channel`	String	The name of the channel to receive incident_events notifications
`incident_events`	Boolean	Trigger event when an incident is created
`issue_channel`	String	The name of the channel to receive issues_events notifications
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`labels_to_be_notified`	String	Labels to send notifications for. Leave blank to receive notifications for all events
`labels_to_be_notified_behavior`	String	Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`
`merge_request_channel`	String	The name of the channel to receive merge_requests_events notifications
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_channel`	String	The name of the channel to receive note_events notifications
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_channel`	String	The name of the channel to receive pipeline_events notifications
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_channel`	String	The name of the channel to receive push_events notifications
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_channel`	String	The name of the channel to receive tag_push_events notifications
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username`	String	Mattermost notifications username
`webhook` Required	String	Mattermost notifications webhook (for example, `http://mattermost.example.com/hooks/...`)
`wiki_page_channel`	String	The name of the channel to receive wiki_page_events notifications
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Mattermost Slash Commands integration

PUT /api/v4/groups/{id}/integrations/mattermost-slash-commands

Creates or updates the Mattermost Slash Commands integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`token` Required	String	The Mattermost token
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Microsoft Teams integration

PUT /api/v4/groups/{id}/integrations/microsoft-teams

Creates or updates the Microsoft Teams integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Microsoft Teams webhook (for example, `https://outlook.office.com/webhook/...`)
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Mock Ci integration

PUT /api/v4/groups/{id}/integrations/mock-ci

Creates or updates the Mock Ci integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`mock_service_url` Required	String	URL of the Mock CI integration
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Mock Monitoring integration

PUT /api/v4/groups/{id}/integrations/mock-monitoring

Creates or updates the Mock Monitoring integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Packagist integration

PUT /api/v4/groups/{id}/integrations/packagist

Creates or updates the Packagist integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`push_events`	Boolean	Trigger event for pushes to the repository
`server`	String	URL of the Packagist server. The default value is `https://packagist.org`
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`token` Required	String	API token of the Packagist server
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username` Required	String	Username of a Packagist account

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Phorge integration

PUT /api/v4/groups/{id}/integrations/phorge

Creates or updates the Phorge integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Pipelines Email integration

PUT /api/v4/groups/{id}/integrations/pipelines-email

Creates or updates the Pipelines Email integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`notify_child_pipelines`	Boolean	Send notifications for child pipelines
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_default_branch`	Boolean	Send notifications for the default branch
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`recipients` Required	String	Comma-separated list of recipient email addresses
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Pivotaltracker integration

PUT /api/v4/groups/{id}/integrations/pivotaltracker

Creates or updates the Pivotaltracker integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`push_events`	Boolean	Trigger event for pushes to the repository
`restrict_to_branch`	String	Comma-separated list of branches to automatically inspect. Leave blank to include all branches
`token` Required	String	The Pivotal Tracker token
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Ptai integration

PUT /api/v4/groups/{id}/integrations/ptai

Creates or updates the Ptai integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`ptai_apply_all_pm_rules`	Boolean	Widens pattern matching to every rule the server holds, not only the ones the project’s languages select
`ptai_blackbox_allowlist`	String	RegExp" for the other two
`ptai_blackbox_auth_cookie`	String	The session cookie to present, for cookie authentication
`ptai_blackbox_auth_form_address`	String	For form authentication
`ptai_blackbox_auth_form_detection`	String	Whether the form is found on its own or described below. Defaults to automatic
`ptai_blackbox_auth_form_xpath`	String	For a form the scan cannot find by itself
`ptai_blackbox_auth_login`	String	For the sign-in form and HTTP Basic
`ptai_blackbox_auth_login_key`	String	The form field the user goes into, when the form is described by hand
`ptai_blackbox_auth_password`	String	—
`ptai_blackbox_auth_password_key`	String	The form field the password goes into
`ptai_blackbox_auth_type`	String	How the black box signs in. Without it the scan only ever sees the pages a stranger sees, which on most applications is the login page and nothing else
`ptai_blackbox_auth_validation_address`	String	A page only a signed-in user reaches. The scan asks for it to find out whether it is still signed in
`ptai_blackbox_auth_validation_template`	String	Text that appears on that page when signed in, and does not when signed out
`ptai_blackbox_autocheck`	Boolean	Tries what the static analysis found against the running site, and reports which of it is genuinely reachable. This is the finding neither box produces on its own
`ptai_blackbox_denylist`	String	One per line, same form as above. This is where a sign-out link goes, and anything else the scan must not follow
`ptai_blackbox_headers`	String	One per line, as “Name: value”
`ptai_blackbox_level`	String	How thoroughly the site is explored. Defaults to Normal
`ptai_blackbox_proxy_host`	String	Optional. Setting it is what turns the proxy on; the site is then reached through it
`ptai_blackbox_proxy_login`	String	—
`ptai_blackbox_proxy_password`	String	—
`ptai_blackbox_proxy_port`	String	—
`ptai_blackbox_proxy_type`	String	—
`ptai_blackbox_scope`	String	How far from the address the scan may wander: the whole domain, the folder it is in, or that path alone. Defaults to the path
`ptai_blackbox_site`	String	Address of the running application the black box scans. Setting it is what turns the black box on: the module is added to the scan by itself, so a site configured is never a module left un-ticked
`ptai_blackbox_ssl_check`	Boolean	Leave off for a staging site with a self-signed certificate
`ptai_ca_cert`	String	PEM certificate of the authority that signed the server’s certificate. Used only when the trust setting above says so
`ptai_languages`	String	One per line, as PT AI names them: Java, CSharp (Windows, Linux), Php, JavaScript, Python, Go, Kotlin, Ruby and the rest. A line rather than a comma because one of the names has a comma in it. Required as soon as anything else in this section or the black box below is set – the agent refuses a settings file without them, and there is no honest default: a guessed list is a scan that reads none of the code
`ptai_modules`	String	Optional. Comma-separated, as PT AI names them: Configuration, Components, BlackBox, PatternMatching, StaticCodeAnalysis, SoftwareCompositionAnalysis, SecretDetection, MaliciousCodeDetection. Defaults to the static ones. BlackBox is added on its own as soon as a site is given below
`ptai_server_url` Required	String	Base URL of the PT Application Inspector server
`ptai_settings_file`	String	Optional. Path in the repository to a project-settings file written by hand. It is used as it is and everything else in this form is ignored – the way out for a setting PT AI accepts and this form does not name
`ptai_skip_dependency_download`	Boolean	The analysis kernels fetch the project’s packages before they read the code. Where the server cannot reach the package registries that restore fails the whole scan, and no report is written at all – not even the findings already made. Turn this on there
`ptai_skip_gitignore`	Boolean	Keeps build output and vendored trees out of what is uploaded
`ptai_tls_mode`	String	How the scan job decides whether to trust the PT Application Inspector server. Leave it to the runner when the certificate is already trusted there; carry the authority with the scan when it is not
`ptai_token` Required	String	API token used to authenticate with the PT Application Inspector server
`ptai_use_security_policies`	Boolean	Checks the result against the policy held on the server. The agent then exits non-zero when the policy is broken, which is what fails the job
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Pumble integration

PUT /api/v4/groups/{id}/integrations/pumble

Creates or updates the Pumble integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Pumble webhook (for example, `https://api.pumble.com/workspaces/x/...`)
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Pushover integration

PUT /api/v4/groups/{id}/integrations/pushover

Creates or updates the Pushover integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`api_key` Required	String	The application key
`device`	String	Leave blank for all active devices
`priority` Required	String	The priority
`push_events`	Boolean	Trigger event for pushes to the repository
`sound`	String	The sound of the notification
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`user_key` Required	String	The user key

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Redmine integration

PUT /api/v4/groups/{id}/integrations/redmine

Creates or updates the Redmine integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`new_issue_url` Required	String	URL of the new issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Slack integration

PUT /api/v4/groups/{id}/integrations/slack

Creates or updates the Slack integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`alert_channel`	String	The name of the channel to receive alert_events notifications
`alert_events`	Boolean	Trigger event when a new, unique alert is recorded
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`channel`	String	Default channel to use if no other channel is configured
`confidential_issue_channel`	String	The name of the channel to receive confidential_issues_events notifications
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_channel`	String	The name of the channel to receive confidential_note_events notifications
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`deployment_channel`	String	The name of the channel to receive deployment_events notifications
`deployment_events`	Boolean	Trigger event when a deployment starts or finishes
`incident_channel`	String	The name of the channel to receive incident_events notifications
`incident_events`	Boolean	Trigger event when an incident is created
`issue_channel`	String	The name of the channel to receive issues_events notifications
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`labels_to_be_notified`	String	Labels to send notifications for. Leave blank to receive notifications for all events
`labels_to_be_notified_behavior`	String	Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`
`merge_request_channel`	String	The name of the channel to receive merge_requests_events notifications
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_channel`	String	The name of the channel to receive note_events notifications
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_channel`	String	The name of the channel to receive pipeline_events notifications
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_channel`	String	The name of the channel to receive push_events notifications
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_channel`	String	The name of the channel to receive tag_push_events notifications
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username`	String	Slack notifications username
`webhook` Required	String	Slack notifications webhook (for example, `https://hooks.slack.com/services/...`)
`wiki_page_channel`	String	The name of the channel to receive wiki_page_events notifications
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Squash Tm integration

PUT /api/v4/groups/{id}/integrations/squash-tm

Creates or updates the Squash Tm integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`token`	String	Secret token
`url` Required	String	URL of the Squash TM webhook
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Teamcity integration

PUT /api/v4/groups/{id}/integrations/teamcity

Creates or updates the Teamcity integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`build_type` Required	String	The build configuration ID of the TeamCity project
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`password` Required	String	The password of the user
`push_events`	Boolean	Trigger event for pushes to the repository
`teamcity_url` Required	String	TeamCity root URL (for example, `https://teamcity.example.com`)
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username` Required	String	A user with permissions to trigger a manual build

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Telegram integration

PUT /api/v4/groups/{id}/integrations/telegram

Creates or updates the Telegram integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`hostname`	String	Custom hostname of the Telegram API. The default value is `https://api.telegram.org`
`incident_events`	Boolean	Trigger event when an incident is created
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`room` Required	String	Unique identifier for the target chat or the username of the target channel (in the format `@channelusername`)
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`thread`	String	Unique identifier for the target message thread (topic in a forum supergroup)
`token` Required	String	The Telegram bot token (for example, `123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11`)
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Trivy integration

PUT /api/v4/groups/{id}/integrations/trivy

Creates or updates the Trivy integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`trivy_ca_cert`	String	PEM certificate of the authority that signed the registry’s certificate. Used only when the trust setting above says so
`trivy_db_repository`	String	Optional. OCI repository the vulnerability database is pulled from. An installation with no route to the public registries needs its own mirror named here, or every scan fails before it reads anything
`trivy_debug`	Boolean	Logs what the scan resolved and where it read it from
`trivy_extra_args`	String	Optional. Passed to the scan as written, for the flags this form does not name
`trivy_ignore_unfixed`	Boolean	Drops findings with no fixed version published, leaving the ones a bump would close
`trivy_ignorefile`	String	Optional. Path to a .trivyignore in the repository. Defaults to .trivyignore
`trivy_image`	String	Optional. Image the container scan reads, as it is named in the registry. Defaults to this project’s own image at the commit being built
`trivy_image_sources`	String	Optional. Where the image is read from, in order: docker, containerd, podman, remote. Defaults to the registry alone, which is the only one a job with no container runtime of its own can use
`trivy_java_db_repository`	String	Optional. The separate database Trivy pulls only when it meets a jar it cannot identify from the build files
`trivy_offline_scan`	Boolean	Stops the scan making requests of its own to identify dependencies. The database is still downloaded; this is about the lookups on top of it
`trivy_package_types`	String	Optional. Comma-separated: os for the image’s own packages, library for what the application depends on. Defaults to both
`trivy_platform`	String	Optional. Which variant of a multi-platform image to scan, as os/arch. Without it the registry decides, which on a mixed fleet is not always the one that ships
`trivy_registry_password`	String	—
`trivy_registry_token`	String	Optional. For a registry that authenticates with a bearer token instead
`trivy_registry_user`	String	Optional. Leave both credentials blank to read this instance’s own registry with the job’s credentials
`trivy_scanner_image`	String	Optional. The Trivy image the job itself runs in. Point it at a mirror when the runner cannot reach Docker Hub
`trivy_scanners`	String	Optional. Comma-separated: vuln, misconfig, secret, license. Defaults to vuln, because a policy that runs this one usually runs a secret scan of its own
`trivy_severities`	String	Optional. Comma-separated: UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL. Filters what the scan reports at all, which is not the same as the severity that fails the job
`trivy_skip_dirs`	String	Optional. One directory or glob per line
`trivy_skip_files`	String	Optional. One file or glob per line
`trivy_timeout`	String	Optional. As a duration: 5m, 90s, 1h30m. A large image with many application dependencies outlives the default of 5m
`trivy_tls_mode`	String	How the scan decides whether to trust the registry it pulls from
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Unify Circuit integration

PUT /api/v4/groups/{id}/integrations/unify-circuit

Creates or updates the Unify Circuit integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Unify Circuit webhook (for example, `https://circuit.com/rest/v2/webhooks/incoming/...`)
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Webex Teams integration

PUT /api/v4/groups/{id}/integrations/webex-teams

Creates or updates the Webex Teams integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Webex Teams webhook. For example, https://api.ciscospark.com/v1/webhooks/incoming/…
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Youtrack integration

PUT /api/v4/groups/{id}/integrations/youtrack

Creates or updates the Youtrack integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Zentao integration

PUT /api/v4/groups/{id}/integrations/zentao

Creates or updates the Zentao integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Request body (application/json)

Property	Type	Description
`api_token` Required	String	—
`api_url`	String	If different from Web URL
`url` Required	String	Base URL of the ZenTao instance
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`zentao_product_xid` Required	String	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Retrieve integration settings

GET /api/v4/groups/{id}/integrations/{slug}

Retrieves the settings for a specified integration.

Parameters

Name	Type	Description
`slug` Path, required	String	The name of the integration Allowed values: `apple-app-store`, `asana`, `assembla`, `bamboo`, `bugzilla`, `buildkite`, `campfire`, `confluence`, `custom-issue-tracker`, `datadog`, `diffblue-cover`, `discord`, `drone-ci`, `emails-on-push`, `external-wiki`, `gitlab-slack-application`, `google-play`, `hangouts-chat`, `harbor`, `irker`, `jenkins`, `jira`, `jira-cloud-app`, `linear`, `matrix`, `mattermost-slash-commands`, `packagist`, `phorge`, `pipelines-email`, `pivotaltracker`, `pumble`, `pushover`, `redmine`, `ewm`, `youtrack`, `clickup`, `slack`, `microsoft-teams`, `mattermost`, `teamcity`, `telegram`, `unify-circuit`, `webex-teams`, `zentao`, `squash-tm`, `defect-dojo`, `ptai`, `code-scoring`, `trivy`, `mock-ci`, `mock-monitoring` Minimum length: `1`
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegration
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

Disable an integration

DELETE /api/v4/groups/{id}/integrations/{slug}

Disables a specified integration. Integration settings are preserved.

Parameters

Name	Type	Description
`slug` Path, required	String	The name of the integration Allowed values: `apple-app-store`, `asana`, `assembla`, `bamboo`, `bugzilla`, `buildkite`, `campfire`, `confluence`, `custom-issue-tracker`, `datadog`, `diffblue-cover`, `discord`, `drone-ci`, `emails-on-push`, `external-wiki`, `gitlab-slack-application`, `google-play`, `hangouts-chat`, `harbor`, `irker`, `jenkins`, `jira`, `jira-cloud-app`, `linear`, `matrix`, `mattermost-slash-commands`, `packagist`, `phorge`, `pipelines-email`, `pivotaltracker`, `pumble`, `pushover`, `redmine`, `ewm`, `youtrack`, `clickup`, `slack`, `microsoft-teams`, `mattermost`, `teamcity`, `telegram`, `unify-circuit`, `webex-teams`, `zentao`, `squash-tm`, `defect-dojo`, `ptai`, `code-scoring`, `trivy`, `mock-ci`, `mock-monitoring` Minimum length: `1`
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

Receive Slack events

POST /api/v4/integrations/slack/events

Request body (application/json)

Property	Type	Description
`api_app_id`	String	The Slack app ID
`authed_users`	Array of strings	(Deprecated by Slack) An array of Slack user IDs
`event`	Object	The event object with variable properties
`event_id`	String	A unique identifier for this specific event
`event_time`	Integer	The epoch timestamp in seconds when this event was dispatched
`team_id`	String	The Slack workspace ID of where the event occurred
`token`	String	(Deprecated by Slack) The request token, unused by GitLab
`type`	String	The kind of event this is, usually `event_callback`

Responses

Code	Description	Schema
`200`	Successfully processed event	—
`204`	Failed to process event	—
`400`	Bad Request	—
`401`	Unauthorized	—

Process Slack interaction events

POST /api/v4/integrations/slack/interactions

Processes interaction events from Slack

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—

Get Slack interactive component options

POST /api/v4/integrations/slack/options

Retrieves options for Slack interactive components

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—

List all active integrations

GET /api/v4/projects/{id}/integrations

Lists all active integrations.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`401`	Unauthorized	—
`404`	Not found	—

Create or update the Apple App Store integration

PUT /api/v4/projects/{id}/integrations/apple-app-store

Creates or updates the Apple App Store integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`app_store_issuer_id` Required	String	Apple App Store Connect issuer ID
`app_store_key_id` Required	String	Apple App Store Connect key ID
`app_store_private_key` Required	String	Apple App Store Connect private key
`app_store_private_key_file_name` Required	String	Apple App Store Connect private key file name
`app_store_protected_refs`	Boolean	Set variables on protected branches and tags only
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Asana integration

PUT /api/v4/projects/{id}/integrations/asana

Creates or updates the Asana integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`api_key` Required	String	User API token. The user must have access to the task. All comments are attributed to this user
`push_events`	Boolean	Trigger event for pushes to the repository
`restrict_to_branch`	String	Comma-separated list of branches to be automatically inspected. Leave blank to include all branches
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Assembla integration

PUT /api/v4/projects/{id}/integrations/assembla

Creates or updates the Assembla integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`push_events`	Boolean	Trigger event for pushes to the repository
`subdomain`	String	The subdomain setting
`token` Required	String	The authentication token
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Bamboo integration

PUT /api/v4/projects/{id}/integrations/bamboo

Creates or updates the Bamboo integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`bamboo_url` Required	String	Bamboo root URL (for example, `https://bamboo.example.com`)
`build_key` Required	String	Bamboo build plan key (for example, `KEY`)
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`password` Required	String	Password of the user
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username` Required	String	User with API access to the Bamboo server

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Bugzilla integration

PUT /api/v4/projects/{id}/integrations/bugzilla

Creates or updates the Bugzilla integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`new_issue_url` Required	String	URL of the new issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Buildkite integration

PUT /api/v4/projects/{id}/integrations/buildkite

Creates or updates the Buildkite integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`enable_ssl_verification`	Boolean	DEPRECATED: This parameter has no effect because SSL verification is always enabled
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`project_url` Required	String	Pipeline URL (for example, `https://buildkite.com/example/pipeline`)
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`token` Required	String	Token you get after you create a Buildkite pipeline with a Deckhouse Code repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Campfire integration

PUT /api/v4/projects/{id}/integrations/campfire

Creates or updates the Campfire integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`push_events`	Boolean	Trigger event for pushes to the repository
`room`	String	ID portion of the Campfire room URL
`subdomain`	String	`.campfirenow.com` subdomain when you’re signed in
`token` Required	String	API authentication token from Campfire. To get the token, sign in to Campfire and select My info
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Clickup integration

PUT /api/v4/projects/{id}/integrations/clickup

Creates or updates the Clickup integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Code Scoring integration

PUT /api/v4/projects/{id}/integrations/code-scoring

Creates or updates the Code Scoring integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`codescoring_agent_image`	String	Optional. The image the CodeScoring scan jobs run in, with registry and tag or digest. It needs curl, ca-certificates, jq, ruby and git; the johnny agent is downloaded into it at run time. Left empty, the jobs use the default image
`codescoring_bom_format`	String	Optional. Which CycloneDX version the bill of materials is written in. They all list the same components: pick an older version for a tool downstream that needs one, or the extended 1.6 for CodeScoring’s own GOST properties. A Scan Execution Policy can name a format of its own, which wins. Left empty here and in the policy, the scan jobs write CycloneDX 1.6 JSON
`codescoring_ca_cert`	String	PEM certificate of the authority that signed the server’s certificate. Used only when the trust setting above says so
`codescoring_cloud_resolve`	Boolean	Let the CodeScoring server work out the dependency tree instead of the runner. The only resolver that needs no package manager in the scan job image, and it finds the transitive packages a manifest read misses. Known cost: the server currently returns the vulnerability report empty when this is on, so findings reach the tests summary but not the vulnerability report. Leave it off unless the dependency list matters more
`codescoring_extra_args`	String	Optional. Passed to the agent as written, for options this form does not name, such as per-manager arguments. A setting above wins over the same option written here
`codescoring_ignore_paths`	String	Optional. One glob per line. Keeps test fixtures and vendored trees out of the results
`codescoring_scan_mode`	String	What to scan: a source directory, a container image, or an existing CycloneDX document. Defaults to the source directory
`codescoring_scan_target`	String	Optional. Directory, image reference or SBOM path, depending on the scan mode. Defaults to the whole checkout
`codescoring_stage`	String	The policy stage this scan reports as. The agent takes one, so the scan reports as one. Defaults to “build”
`codescoring_tls_mode`	String	How the scan job decides whether to trust the CodeScoring server. It applies to the requests the job makes with curl – fetching the agent, and the connection test above. The johnny agent itself does not verify the certificate at all and offers no way to make it, so nothing here changes what the scan itself trusts
`codescoring_token` Required	String	API token to authenticate and download the Johnny agent
`codescoring_url` Required	String	Base URL of the CodeScoring instance
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Confluence integration

PUT /api/v4/projects/{id}/integrations/confluence

Creates or updates the Confluence integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`confluence_url` Required	String	URL of the Confluence Workspace hosted on `atlassian.net`
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Custom Issue Tracker integration

PUT /api/v4/projects/{id}/integrations/custom-issue-tracker

Creates or updates the Custom Issue Tracker integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`new_issue_url` Required	String	URL of the new issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Datadog integration

PUT /api/v4/projects/{id}/integrations/datadog

Creates or updates the Datadog integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`api_key` Required	String	API key used for authentication with Datadog
`api_url`	String	Full URL of your Datadog site. Only required if you do not use a standard Datadog site
`archive_trace_events`	Boolean	When enabled, job logs are collected by Datadog and displayed along with pipeline execution traces
`build_events`	Boolean	Trigger event when a build is created
`datadog_ci_visibility`	Boolean	Enable CI Visibility
`datadog_env`	String	For self-managed deployments, `env` tag for all the data sent to Datadog
`datadog_service`	String	Tag all pipeline data from this Deckhouse Code instance in Datadog. Can be used when managing several self-managed deployments
`datadog_site`	String	Datadog site to send data to. Learn more about Datadog sites in the documentation
`datadog_tags`	String	Custom tags in Datadog. Specify one tag per line in the format `key:value\nkey2:value2`
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`project_events`	Boolean	—
`push_events`	Boolean	Trigger event for pushes to the repository
`subgroup_events`	Boolean	—
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Defect Dojo integration

PUT /api/v4/projects/{id}/integrations/defect-dojo

Creates or updates the Defect Dojo integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`api_token` Required	String	Token used to authenticate with the DefectDojo API
`auto_create_context`	Boolean	—
`ca_cert`	String	PEM certificate of the authority that signed the server’s certificate. Used only when the trust setting above says so
`close_old_findings`	Boolean	—
`engagement_name`	String	DefectDojo engagement. Leave blank to use the branch name
`findings_active`	Boolean	—
`findings_verified`	Boolean	—
`minimum_severity`	String	Ignore findings below this severity on import
`product_name`	String	DefectDojo product. Leave blank to use the project full path
`product_type_name`	String	DefectDojo product type, used when a product is auto-created
`tls_mode`	String	How this instance decides whether to trust the DefectDojo server. Unlike a scan, this connection is made from here rather than from a job, so verification can be turned off – which leaves the upload open to interception, and the reports carry everything the scanners found
`url` Required	String	Base URL of your DefectDojo instance
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Diffblue Cover integration

PUT /api/v4/projects/{id}/integrations/diffblue-cover

Creates or updates the Diffblue Cover integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`diffblue_access_token_name` Required	String	Access token name used by Diffblue Cover in pipelines
`diffblue_access_token_secret` Required	String	Access token secret used by Diffblue Cover in pipelines
`diffblue_license_key` Required	String	Diffblue Cover license key
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Discord integration

PUT /api/v4/projects/{id}/integrations/discord

Creates or updates the Discord integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`alert_channel`	String	The name of the channel to receive alert_events notifications
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issue_channel`	String	The name of the channel to receive confidential_issues_events notifications
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_channel`	String	The name of the channel to receive confidential_note_events notifications
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`deployment_channel`	String	The name of the channel to receive deployment_events notifications
`deployment_events`	Boolean	Trigger event when a deployment starts or finishes
`incident_channel`	String	The name of the channel to receive incident_events notifications
`issue_channel`	String	The name of the channel to receive issues_events notifications
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_request_channel`	String	The name of the channel to receive merge_requests_events notifications
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_channel`	String	The name of the channel to receive note_events notifications
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_channel`	String	The name of the channel to receive pipeline_events notifications
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_channel`	String	The name of the channel to receive push_events notifications
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_channel`	String	The name of the channel to receive tag_push_events notifications
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	Discord webhook (for example, `https://discord.com/api/webhooks/…`)
`wiki_page_channel`	String	The name of the channel to receive wiki_page_events notifications
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Drone Ci integration

PUT /api/v4/projects/{id}/integrations/drone-ci

Creates or updates the Drone Ci integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`drone_url` Required	String	Drone CI URL (for example, `http://drone.example.com`)
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`token` Required	String	Drone CI token
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Emails On Push integration

PUT /api/v4/projects/{id}/integrations/emails-on-push

Creates or updates the Emails On Push integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`disable_diffs`	Boolean	Disable code diffs
`push_events`	Boolean	Trigger event for pushes to the repository
`recipients` Required	String	Emails separated by whitespace
`send_from_committer_email`	Boolean	Send from committer
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Ewm integration

PUT /api/v4/projects/{id}/integrations/ewm

Creates or updates the Ewm integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`new_issue_url` Required	String	URL of the new issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the External Wiki integration

PUT /api/v4/projects/{id}/integrations/external-wiki

Creates or updates the External Wiki integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`external_wiki_url` Required	String	URL of the external wiki
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Gitlab Slack Application integration

PUT /api/v4/projects/{id}/integrations/gitlab-slack-application

Creates or updates the Gitlab Slack Application integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`alert_channel`	String	The name of the channel to receive alert_events notifications
`alert_events`	Boolean	Trigger event when a new, unique alert is recorded
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`channel`	String	Default channel to use if no other channel is configured
`confidential_issue_channel`	String	The name of the channel to receive confidential_issues_events notifications
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_channel`	String	The name of the channel to receive confidential_note_events notifications
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`deployment_channel`	String	The name of the channel to receive deployment_events notifications
`deployment_events`	Boolean	Trigger event when a deployment starts or finishes
`incident_channel`	String	The name of the channel to receive incident_events notifications
`incident_events`	Boolean	Trigger event when an incident is created
`issue_channel`	String	The name of the channel to receive issues_events notifications
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`labels_to_be_notified`	String	Labels to send notifications for. Leave blank to receive notifications for all events
`labels_to_be_notified_behavior`	String	Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`
`merge_request_channel`	String	The name of the channel to receive merge_requests_events notifications
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_channel`	String	The name of the channel to receive note_events notifications
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_channel`	String	The name of the channel to receive pipeline_events notifications
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_channel`	String	The name of the channel to receive push_events notifications
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_channel`	String	The name of the channel to receive tag_push_events notifications
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`wiki_page_channel`	String	The name of the channel to receive wiki_page_events notifications
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Google Play integration

PUT /api/v4/projects/{id}/integrations/google-play

Creates or updates the Google Play integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`google_play_protected_refs`	Boolean	Set variables on protected branches and tags only
`package_name` Required	String	Package name of the app in Google Play
`service_account_key` Required	String	Google Play service account key
`service_account_key_file_name` Required	String	File name of the Google Play service account key
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Hangouts Chat integration

PUT /api/v4/projects/{id}/integrations/hangouts-chat

Creates or updates the Hangouts Chat integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Hangouts Chat webhook (for example, `https://chat.googleapis.com/v1/spaces...`)
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Harbor integration

PUT /api/v4/projects/{id}/integrations/harbor

Creates or updates the Harbor integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`password` Required	String	The password of the user
`project_name` Required	String	The name of the project in the Harbor instance. For example, `testproject`
`url` Required	String	The base URL to the Harbor instance linked to the Deckhouse Code project. For example, `https://demo.goharbor.io`
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username` Required	String	The username created in the Harbor interface

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Irker integration

PUT /api/v4/projects/{id}/integrations/irker

Creates or updates the Irker integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`colorize_messages`	Boolean	Colorize messages
`default_irc_uri`	String	URI to add before each recipient. The default value is `irc://irc.network.net:6697/`
`push_events`	Boolean	Trigger event for pushes to the repository
`recipients` Required	String	Comma-separated list of channels or email addresses
`server_host`	String	irker daemon hostname. The default value is `localhost`
`server_port`	Integer	irker daemon port. The default value is `6659`
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Jenkins integration

PUT /api/v4/projects/{id}/integrations/jenkins

Creates or updates the Jenkins integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`jenkins_url` Required	String	URL of the Jenkins server
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`password`	String	Password of the Jenkins server
`project_name` Required	String	Name of the Jenkins project
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username`	String	Username of the Jenkins server

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Jira integration

PUT /api/v4/projects/{id}/integrations/jira

Creates or updates the Jira integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`api_url`	String	The base URL to the Jira instance API. Web URL value is used if not set (for example, `https://jira-api.example.com`)
`comment_on_event_enabled`	Boolean	Enable comments inside Jira issues on each GitLab event (commit / merge request)
`commit_events`	Boolean	Trigger event when a commit is created or updated
`issues_enabled`	String	Enable viewing Jira issues in Deckhouse Code
`jira_auth_type`	Integer	The authentication method to use with Jira. Use `0` for basic authentication, `1` for Jira personal access token, and `2` for Jira Cloud service accounts. Defaults to `0`
`jira_issue_prefix`	String	Prefix to match Jira issue keys
`jira_issue_regex`	String	Regular expression to match Jira issue keys
`jira_issue_transition_id`	String	The ID of one or more transitions for custom issue transitions.Ignored when `jira_issue_transition_automatic` is enabled. Defaults to a blank string,which disables custom transitions
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`password` Required	String	The Jira API token, password, or personal access token to use with Jira. When using Basic Authentication (`jira_auth_type` is `0`), use an API token for Jira Cloud, and a password for Jira Data Center or Jira Server. For a Jira personal access token (`jira_auth_type` is `1`), use the personal access token
`project_keys`	Array of strings	Keys of Jira projects to display. When `issues_enabled` is `true`, this setting filters which Jira projects are shown in Deckhouse Code. It does not restrict the API token’s access
`url` Required	String	The URL to the Jira project which is being linked to this Deckhouse Code project (for example, `https://jira.example.com`)
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username`	String	The email or username to use with Jira. Use an email for Jira Cloud, and a username for Jira Data Center and Jira Server. Required when using basic authentication (`jira_auth_type` is `0`)

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Jira Cloud App integration

PUT /api/v4/projects/{id}/integrations/jira-cloud-app

Creates or updates the Jira Cloud App integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`jira_cloud_app_deployment_gating_environments`	String	Enter the environment (production,staging,testing,development) where you want to enable deployment gating. Use comma (,) to separate multiple environments
`jira_cloud_app_enable_deployment_gating`	Boolean	Enable to approve or reject blocked Deckhouse Code deployments from Jira Service Management
`jira_cloud_app_service_ids`	String	Copy and paste your JSM Service ID here. Use comma (,) to separate multiple IDs
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Linear integration

PUT /api/v4/projects/{id}/integrations/linear

Creates or updates the Linear integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`workspace_url` Required	String	Linear workspace URL (for example, https://linear.app/example)

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Matrix integration

PUT /api/v4/projects/{id}/integrations/matrix

Creates or updates the Matrix integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`hostname`	String	Custom hostname of the Matrix server. The default value is `https://matrix-client.matrix.org`
`incident_events`	Boolean	Trigger event when an incident is created
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`room` Required	String	Unique identifier for the target room (in the format `!qPKKM111FFKKsfoCVy:matrix.org`)
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`token` Required	String	The Matrix access token (for example, `syt-zyx57W2v1u123ew11`)
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Mattermost integration

PUT /api/v4/projects/{id}/integrations/mattermost

Creates or updates the Mattermost integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`alert_channel`	String	The name of the channel to receive alert_events notifications
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`channel`	String	Default channel to use if no other channel is configured
`confidential_issue_channel`	String	The name of the channel to receive confidential_issues_events notifications
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_channel`	String	The name of the channel to receive confidential_note_events notifications
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`deployment_channel`	String	The name of the channel to receive deployment_events notifications
`deployment_events`	Boolean	Trigger event when a deployment starts or finishes
`incident_channel`	String	The name of the channel to receive incident_events notifications
`incident_events`	Boolean	Trigger event when an incident is created
`issue_channel`	String	The name of the channel to receive issues_events notifications
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`labels_to_be_notified`	String	Labels to send notifications for. Leave blank to receive notifications for all events
`labels_to_be_notified_behavior`	String	Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`
`merge_request_channel`	String	The name of the channel to receive merge_requests_events notifications
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_channel`	String	The name of the channel to receive note_events notifications
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_channel`	String	The name of the channel to receive pipeline_events notifications
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_channel`	String	The name of the channel to receive push_events notifications
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_channel`	String	The name of the channel to receive tag_push_events notifications
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username`	String	Mattermost notifications username
`webhook` Required	String	Mattermost notifications webhook (for example, `http://mattermost.example.com/hooks/...`)
`wiki_page_channel`	String	The name of the channel to receive wiki_page_events notifications
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Mattermost Slash Commands integration

PUT /api/v4/projects/{id}/integrations/mattermost-slash-commands

Creates or updates the Mattermost Slash Commands integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`token` Required	String	The Mattermost token
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Trigger a slash command for mattermost-slash-commands

POST /api/v4/projects/{id}/integrations/mattermost_slash_commands/trigger

Triggers a slash command for mattermost-slash-commands.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (application/json)

Property	Type	Description
`token` Required	String	The Mattermost token

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Create or update the Microsoft Teams integration

PUT /api/v4/projects/{id}/integrations/microsoft-teams

Creates or updates the Microsoft Teams integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Microsoft Teams webhook (for example, `https://outlook.office.com/webhook/...`)
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Mock Ci integration

PUT /api/v4/projects/{id}/integrations/mock-ci

Creates or updates the Mock Ci integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`mock_service_url` Required	String	URL of the Mock CI integration
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Mock Monitoring integration

PUT /api/v4/projects/{id}/integrations/mock-monitoring

Creates or updates the Mock Monitoring integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Packagist integration

PUT /api/v4/projects/{id}/integrations/packagist

Creates or updates the Packagist integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`push_events`	Boolean	Trigger event for pushes to the repository
`server`	String	URL of the Packagist server. The default value is `https://packagist.org`
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`token` Required	String	API token of the Packagist server
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username` Required	String	Username of a Packagist account

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Phorge integration

PUT /api/v4/projects/{id}/integrations/phorge

Creates or updates the Phorge integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Pipelines Email integration

PUT /api/v4/projects/{id}/integrations/pipelines-email

Creates or updates the Pipelines Email integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`notify_child_pipelines`	Boolean	Send notifications for child pipelines
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_default_branch`	Boolean	Send notifications for the default branch
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`recipients` Required	String	Comma-separated list of recipient email addresses
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Pivotaltracker integration

PUT /api/v4/projects/{id}/integrations/pivotaltracker

Creates or updates the Pivotaltracker integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`push_events`	Boolean	Trigger event for pushes to the repository
`restrict_to_branch`	String	Comma-separated list of branches to automatically inspect. Leave blank to include all branches
`token` Required	String	The Pivotal Tracker token
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Ptai integration

PUT /api/v4/projects/{id}/integrations/ptai

Creates or updates the Ptai integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`ptai_apply_all_pm_rules`	Boolean	Widens pattern matching to every rule the server holds, not only the ones the project’s languages select
`ptai_blackbox_allowlist`	String	RegExp" for the other two
`ptai_blackbox_auth_cookie`	String	The session cookie to present, for cookie authentication
`ptai_blackbox_auth_form_address`	String	For form authentication
`ptai_blackbox_auth_form_detection`	String	Whether the form is found on its own or described below. Defaults to automatic
`ptai_blackbox_auth_form_xpath`	String	For a form the scan cannot find by itself
`ptai_blackbox_auth_login`	String	For the sign-in form and HTTP Basic
`ptai_blackbox_auth_login_key`	String	The form field the user goes into, when the form is described by hand
`ptai_blackbox_auth_password`	String	—
`ptai_blackbox_auth_password_key`	String	The form field the password goes into
`ptai_blackbox_auth_type`	String	How the black box signs in. Without it the scan only ever sees the pages a stranger sees, which on most applications is the login page and nothing else
`ptai_blackbox_auth_validation_address`	String	A page only a signed-in user reaches. The scan asks for it to find out whether it is still signed in
`ptai_blackbox_auth_validation_template`	String	Text that appears on that page when signed in, and does not when signed out
`ptai_blackbox_autocheck`	Boolean	Tries what the static analysis found against the running site, and reports which of it is genuinely reachable. This is the finding neither box produces on its own
`ptai_blackbox_denylist`	String	One per line, same form as above. This is where a sign-out link goes, and anything else the scan must not follow
`ptai_blackbox_headers`	String	One per line, as “Name: value”
`ptai_blackbox_level`	String	How thoroughly the site is explored. Defaults to Normal
`ptai_blackbox_proxy_host`	String	Optional. Setting it is what turns the proxy on; the site is then reached through it
`ptai_blackbox_proxy_login`	String	—
`ptai_blackbox_proxy_password`	String	—
`ptai_blackbox_proxy_port`	String	—
`ptai_blackbox_proxy_type`	String	—
`ptai_blackbox_scope`	String	How far from the address the scan may wander: the whole domain, the folder it is in, or that path alone. Defaults to the path
`ptai_blackbox_site`	String	Address of the running application the black box scans. Setting it is what turns the black box on: the module is added to the scan by itself, so a site configured is never a module left un-ticked
`ptai_blackbox_ssl_check`	Boolean	Leave off for a staging site with a self-signed certificate
`ptai_ca_cert`	String	PEM certificate of the authority that signed the server’s certificate. Used only when the trust setting above says so
`ptai_languages`	String	One per line, as PT AI names them: Java, CSharp (Windows, Linux), Php, JavaScript, Python, Go, Kotlin, Ruby and the rest. A line rather than a comma because one of the names has a comma in it. Required as soon as anything else in this section or the black box below is set – the agent refuses a settings file without them, and there is no honest default: a guessed list is a scan that reads none of the code
`ptai_modules`	String	Optional. Comma-separated, as PT AI names them: Configuration, Components, BlackBox, PatternMatching, StaticCodeAnalysis, SoftwareCompositionAnalysis, SecretDetection, MaliciousCodeDetection. Defaults to the static ones. BlackBox is added on its own as soon as a site is given below
`ptai_server_url` Required	String	Base URL of the PT Application Inspector server
`ptai_settings_file`	String	Optional. Path in the repository to a project-settings file written by hand. It is used as it is and everything else in this form is ignored – the way out for a setting PT AI accepts and this form does not name
`ptai_skip_dependency_download`	Boolean	The analysis kernels fetch the project’s packages before they read the code. Where the server cannot reach the package registries that restore fails the whole scan, and no report is written at all – not even the findings already made. Turn this on there
`ptai_skip_gitignore`	Boolean	Keeps build output and vendored trees out of what is uploaded
`ptai_tls_mode`	String	How the scan job decides whether to trust the PT Application Inspector server. Leave it to the runner when the certificate is already trusted there; carry the authority with the scan when it is not
`ptai_token` Required	String	API token used to authenticate with the PT Application Inspector server
`ptai_use_security_policies`	Boolean	Checks the result against the policy held on the server. The agent then exits non-zero when the policy is broken, which is what fails the job
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Pumble integration

PUT /api/v4/projects/{id}/integrations/pumble

Creates or updates the Pumble integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Pumble webhook (for example, `https://api.pumble.com/workspaces/x/...`)
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Pushover integration

PUT /api/v4/projects/{id}/integrations/pushover

Creates or updates the Pushover integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`api_key` Required	String	The application key
`device`	String	Leave blank for all active devices
`priority` Required	String	The priority
`push_events`	Boolean	Trigger event for pushes to the repository
`sound`	String	The sound of the notification
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`user_key` Required	String	The user key

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Redmine integration

PUT /api/v4/projects/{id}/integrations/redmine

Creates or updates the Redmine integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`new_issue_url` Required	String	URL of the new issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Slack integration

PUT /api/v4/projects/{id}/integrations/slack

Creates or updates the Slack integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`alert_channel`	String	The name of the channel to receive alert_events notifications
`alert_events`	Boolean	Trigger event when a new, unique alert is recorded
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`channel`	String	Default channel to use if no other channel is configured
`confidential_issue_channel`	String	The name of the channel to receive confidential_issues_events notifications
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_channel`	String	The name of the channel to receive confidential_note_events notifications
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`deployment_channel`	String	The name of the channel to receive deployment_events notifications
`deployment_events`	Boolean	Trigger event when a deployment starts or finishes
`incident_channel`	String	The name of the channel to receive incident_events notifications
`incident_events`	Boolean	Trigger event when an incident is created
`issue_channel`	String	The name of the channel to receive issues_events notifications
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`labels_to_be_notified`	String	Labels to send notifications for. Leave blank to receive notifications for all events
`labels_to_be_notified_behavior`	String	Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`
`merge_request_channel`	String	The name of the channel to receive merge_requests_events notifications
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_channel`	String	The name of the channel to receive note_events notifications
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_channel`	String	The name of the channel to receive pipeline_events notifications
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_channel`	String	The name of the channel to receive push_events notifications
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_channel`	String	The name of the channel to receive tag_push_events notifications
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username`	String	Slack notifications username
`webhook` Required	String	Slack notifications webhook (for example, `https://hooks.slack.com/services/...`)
`wiki_page_channel`	String	The name of the channel to receive wiki_page_events notifications
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Squash Tm integration

PUT /api/v4/projects/{id}/integrations/squash-tm

Creates or updates the Squash Tm integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`token`	String	Secret token
`url` Required	String	URL of the Squash TM webhook
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Teamcity integration

PUT /api/v4/projects/{id}/integrations/teamcity

Creates or updates the Teamcity integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`build_type` Required	String	The build configuration ID of the TeamCity project
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`password` Required	String	The password of the user
`push_events`	Boolean	Trigger event for pushes to the repository
`teamcity_url` Required	String	TeamCity root URL (for example, `https://teamcity.example.com`)
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username` Required	String	A user with permissions to trigger a manual build

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Telegram integration

PUT /api/v4/projects/{id}/integrations/telegram

Creates or updates the Telegram integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`hostname`	String	Custom hostname of the Telegram API. The default value is `https://api.telegram.org`
`incident_events`	Boolean	Trigger event when an incident is created
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`room` Required	String	Unique identifier for the target chat or the username of the target channel (in the format `@channelusername`)
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`thread`	String	Unique identifier for the target message thread (topic in a forum supergroup)
`token` Required	String	The Telegram bot token (for example, `123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11`)
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Trivy integration

PUT /api/v4/projects/{id}/integrations/trivy

Creates or updates the Trivy integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`trivy_ca_cert`	String	PEM certificate of the authority that signed the registry’s certificate. Used only when the trust setting above says so
`trivy_db_repository`	String	Optional. OCI repository the vulnerability database is pulled from. An installation with no route to the public registries needs its own mirror named here, or every scan fails before it reads anything
`trivy_debug`	Boolean	Logs what the scan resolved and where it read it from
`trivy_extra_args`	String	Optional. Passed to the scan as written, for the flags this form does not name
`trivy_ignore_unfixed`	Boolean	Drops findings with no fixed version published, leaving the ones a bump would close
`trivy_ignorefile`	String	Optional. Path to a .trivyignore in the repository. Defaults to .trivyignore
`trivy_image`	String	Optional. Image the container scan reads, as it is named in the registry. Defaults to this project’s own image at the commit being built
`trivy_image_sources`	String	Optional. Where the image is read from, in order: docker, containerd, podman, remote. Defaults to the registry alone, which is the only one a job with no container runtime of its own can use
`trivy_java_db_repository`	String	Optional. The separate database Trivy pulls only when it meets a jar it cannot identify from the build files
`trivy_offline_scan`	Boolean	Stops the scan making requests of its own to identify dependencies. The database is still downloaded; this is about the lookups on top of it
`trivy_package_types`	String	Optional. Comma-separated: os for the image’s own packages, library for what the application depends on. Defaults to both
`trivy_platform`	String	Optional. Which variant of a multi-platform image to scan, as os/arch. Without it the registry decides, which on a mixed fleet is not always the one that ships
`trivy_registry_password`	String	—
`trivy_registry_token`	String	Optional. For a registry that authenticates with a bearer token instead
`trivy_registry_user`	String	Optional. Leave both credentials blank to read this instance’s own registry with the job’s credentials
`trivy_scanner_image`	String	Optional. The Trivy image the job itself runs in. Point it at a mirror when the runner cannot reach Docker Hub
`trivy_scanners`	String	Optional. Comma-separated: vuln, misconfig, secret, license. Defaults to vuln, because a policy that runs this one usually runs a secret scan of its own
`trivy_severities`	String	Optional. Comma-separated: UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL. Filters what the scan reports at all, which is not the same as the severity that fails the job
`trivy_skip_dirs`	String	Optional. One directory or glob per line
`trivy_skip_files`	String	Optional. One file or glob per line
`trivy_timeout`	String	Optional. As a duration: 5m, 90s, 1h30m. A large image with many application dependencies outlives the default of 5m
`trivy_tls_mode`	String	How the scan decides whether to trust the registry it pulls from
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Unify Circuit integration

PUT /api/v4/projects/{id}/integrations/unify-circuit

Creates or updates the Unify Circuit integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Unify Circuit webhook (for example, `https://circuit.com/rest/v2/webhooks/incoming/...`)
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Webex Teams integration

PUT /api/v4/projects/{id}/integrations/webex-teams

Creates or updates the Webex Teams integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Webex Teams webhook. For example, https://api.ciscospark.com/v1/webhooks/incoming/…
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Youtrack integration

PUT /api/v4/projects/{id}/integrations/youtrack

Creates or updates the Youtrack integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Zentao integration

PUT /api/v4/projects/{id}/integrations/zentao

Creates or updates the Zentao integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`api_token` Required	String	—
`api_url`	String	If different from Web URL
`url` Required	String	Base URL of the ZenTao instance
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`zentao_product_xid` Required	String	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Retrieve integration settings

GET /api/v4/projects/{id}/integrations/{slug}

Retrieves the settings for a specified integration.

Parameters

Name	Type	Description
`slug` Path, required	String	The name of the integration Allowed values: `apple-app-store`, `asana`, `assembla`, `bamboo`, `bugzilla`, `buildkite`, `campfire`, `confluence`, `custom-issue-tracker`, `datadog`, `diffblue-cover`, `discord`, `drone-ci`, `emails-on-push`, `external-wiki`, `gitlab-slack-application`, `google-play`, `hangouts-chat`, `harbor`, `irker`, `jenkins`, `jira`, `jira-cloud-app`, `linear`, `matrix`, `mattermost-slash-commands`, `packagist`, `phorge`, `pipelines-email`, `pivotaltracker`, `pumble`, `pushover`, `redmine`, `ewm`, `youtrack`, `clickup`, `slack`, `microsoft-teams`, `mattermost`, `teamcity`, `telegram`, `unify-circuit`, `webex-teams`, `zentao`, `squash-tm`, `defect-dojo`, `ptai`, `code-scoring`, `trivy`, `mock-ci`, `mock-monitoring` Minimum length: `1`
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegration
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

Disable an integration

DELETE /api/v4/projects/{id}/integrations/{slug}

Disables a specified integration. Integration settings are preserved.

Parameters

Name	Type	Description
`slug` Path, required	String	The name of the integration Allowed values: `apple-app-store`, `asana`, `assembla`, `bamboo`, `bugzilla`, `buildkite`, `campfire`, `confluence`, `custom-issue-tracker`, `datadog`, `diffblue-cover`, `discord`, `drone-ci`, `emails-on-push`, `external-wiki`, `gitlab-slack-application`, `google-play`, `hangouts-chat`, `harbor`, `irker`, `jenkins`, `jira`, `jira-cloud-app`, `linear`, `matrix`, `mattermost-slash-commands`, `packagist`, `phorge`, `pipelines-email`, `pivotaltracker`, `pumble`, `pushover`, `redmine`, `ewm`, `youtrack`, `clickup`, `slack`, `microsoft-teams`, `mattermost`, `teamcity`, `telegram`, `unify-circuit`, `webex-teams`, `zentao`, `squash-tm`, `defect-dojo`, `ptai`, `code-scoring`, `trivy`, `mock-ci`, `mock-monitoring` Minimum length: `1`
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

List all active integrations

GET /api/v4/projects/{id}/services

Lists all active integrations.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`401`	Unauthorized	—
`404`	Not found	—

Create or update the Apple App Store integration

PUT /api/v4/projects/{id}/services/apple-app-store

Creates or updates the Apple App Store integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`app_store_issuer_id` Required	String	Apple App Store Connect issuer ID
`app_store_key_id` Required	String	Apple App Store Connect key ID
`app_store_private_key` Required	String	Apple App Store Connect private key
`app_store_private_key_file_name` Required	String	Apple App Store Connect private key file name
`app_store_protected_refs`	Boolean	Set variables on protected branches and tags only
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Asana integration

PUT /api/v4/projects/{id}/services/asana

Creates or updates the Asana integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`api_key` Required	String	User API token. The user must have access to the task. All comments are attributed to this user
`push_events`	Boolean	Trigger event for pushes to the repository
`restrict_to_branch`	String	Comma-separated list of branches to be automatically inspected. Leave blank to include all branches
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Assembla integration

PUT /api/v4/projects/{id}/services/assembla

Creates or updates the Assembla integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`push_events`	Boolean	Trigger event for pushes to the repository
`subdomain`	String	The subdomain setting
`token` Required	String	The authentication token
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Bamboo integration

PUT /api/v4/projects/{id}/services/bamboo

Creates or updates the Bamboo integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`bamboo_url` Required	String	Bamboo root URL (for example, `https://bamboo.example.com`)
`build_key` Required	String	Bamboo build plan key (for example, `KEY`)
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`password` Required	String	Password of the user
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username` Required	String	User with API access to the Bamboo server

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Bugzilla integration

PUT /api/v4/projects/{id}/services/bugzilla

Creates or updates the Bugzilla integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`new_issue_url` Required	String	URL of the new issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Buildkite integration

PUT /api/v4/projects/{id}/services/buildkite

Creates or updates the Buildkite integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`enable_ssl_verification`	Boolean	DEPRECATED: This parameter has no effect because SSL verification is always enabled
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`project_url` Required	String	Pipeline URL (for example, `https://buildkite.com/example/pipeline`)
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`token` Required	String	Token you get after you create a Buildkite pipeline with a Deckhouse Code repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Campfire integration

PUT /api/v4/projects/{id}/services/campfire

Creates or updates the Campfire integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`push_events`	Boolean	Trigger event for pushes to the repository
`room`	String	ID portion of the Campfire room URL
`subdomain`	String	`.campfirenow.com` subdomain when you’re signed in
`token` Required	String	API authentication token from Campfire. To get the token, sign in to Campfire and select My info
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Clickup integration

PUT /api/v4/projects/{id}/services/clickup

Creates or updates the Clickup integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Code Scoring integration

PUT /api/v4/projects/{id}/services/code-scoring

Creates or updates the Code Scoring integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`codescoring_agent_image`	String	Optional. The image the CodeScoring scan jobs run in, with registry and tag or digest. It needs curl, ca-certificates, jq, ruby and git; the johnny agent is downloaded into it at run time. Left empty, the jobs use the default image
`codescoring_bom_format`	String	Optional. Which CycloneDX version the bill of materials is written in. They all list the same components: pick an older version for a tool downstream that needs one, or the extended 1.6 for CodeScoring’s own GOST properties. A Scan Execution Policy can name a format of its own, which wins. Left empty here and in the policy, the scan jobs write CycloneDX 1.6 JSON
`codescoring_ca_cert`	String	PEM certificate of the authority that signed the server’s certificate. Used only when the trust setting above says so
`codescoring_cloud_resolve`	Boolean	Let the CodeScoring server work out the dependency tree instead of the runner. The only resolver that needs no package manager in the scan job image, and it finds the transitive packages a manifest read misses. Known cost: the server currently returns the vulnerability report empty when this is on, so findings reach the tests summary but not the vulnerability report. Leave it off unless the dependency list matters more
`codescoring_extra_args`	String	Optional. Passed to the agent as written, for options this form does not name, such as per-manager arguments. A setting above wins over the same option written here
`codescoring_ignore_paths`	String	Optional. One glob per line. Keeps test fixtures and vendored trees out of the results
`codescoring_scan_mode`	String	What to scan: a source directory, a container image, or an existing CycloneDX document. Defaults to the source directory
`codescoring_scan_target`	String	Optional. Directory, image reference or SBOM path, depending on the scan mode. Defaults to the whole checkout
`codescoring_stage`	String	The policy stage this scan reports as. The agent takes one, so the scan reports as one. Defaults to “build”
`codescoring_tls_mode`	String	How the scan job decides whether to trust the CodeScoring server. It applies to the requests the job makes with curl – fetching the agent, and the connection test above. The johnny agent itself does not verify the certificate at all and offers no way to make it, so nothing here changes what the scan itself trusts
`codescoring_token` Required	String	API token to authenticate and download the Johnny agent
`codescoring_url` Required	String	Base URL of the CodeScoring instance
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Confluence integration

PUT /api/v4/projects/{id}/services/confluence

Creates or updates the Confluence integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`confluence_url` Required	String	URL of the Confluence Workspace hosted on `atlassian.net`
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Custom Issue Tracker integration

PUT /api/v4/projects/{id}/services/custom-issue-tracker

Creates or updates the Custom Issue Tracker integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`new_issue_url` Required	String	URL of the new issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Datadog integration

PUT /api/v4/projects/{id}/services/datadog

Creates or updates the Datadog integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`api_key` Required	String	API key used for authentication with Datadog
`api_url`	String	Full URL of your Datadog site. Only required if you do not use a standard Datadog site
`archive_trace_events`	Boolean	When enabled, job logs are collected by Datadog and displayed along with pipeline execution traces
`build_events`	Boolean	Trigger event when a build is created
`datadog_ci_visibility`	Boolean	Enable CI Visibility
`datadog_env`	String	For self-managed deployments, `env` tag for all the data sent to Datadog
`datadog_service`	String	Tag all pipeline data from this Deckhouse Code instance in Datadog. Can be used when managing several self-managed deployments
`datadog_site`	String	Datadog site to send data to. Learn more about Datadog sites in the documentation
`datadog_tags`	String	Custom tags in Datadog. Specify one tag per line in the format `key:value\nkey2:value2`
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`project_events`	Boolean	—
`push_events`	Boolean	Trigger event for pushes to the repository
`subgroup_events`	Boolean	—
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Defect Dojo integration

PUT /api/v4/projects/{id}/services/defect-dojo

Creates or updates the Defect Dojo integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`api_token` Required	String	Token used to authenticate with the DefectDojo API
`auto_create_context`	Boolean	—
`ca_cert`	String	PEM certificate of the authority that signed the server’s certificate. Used only when the trust setting above says so
`close_old_findings`	Boolean	—
`engagement_name`	String	DefectDojo engagement. Leave blank to use the branch name
`findings_active`	Boolean	—
`findings_verified`	Boolean	—
`minimum_severity`	String	Ignore findings below this severity on import
`product_name`	String	DefectDojo product. Leave blank to use the project full path
`product_type_name`	String	DefectDojo product type, used when a product is auto-created
`tls_mode`	String	How this instance decides whether to trust the DefectDojo server. Unlike a scan, this connection is made from here rather than from a job, so verification can be turned off – which leaves the upload open to interception, and the reports carry everything the scanners found
`url` Required	String	Base URL of your DefectDojo instance
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Diffblue Cover integration

PUT /api/v4/projects/{id}/services/diffblue-cover

Creates or updates the Diffblue Cover integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`diffblue_access_token_name` Required	String	Access token name used by Diffblue Cover in pipelines
`diffblue_access_token_secret` Required	String	Access token secret used by Diffblue Cover in pipelines
`diffblue_license_key` Required	String	Diffblue Cover license key
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Discord integration

PUT /api/v4/projects/{id}/services/discord

Creates or updates the Discord integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`alert_channel`	String	The name of the channel to receive alert_events notifications
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issue_channel`	String	The name of the channel to receive confidential_issues_events notifications
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_channel`	String	The name of the channel to receive confidential_note_events notifications
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`deployment_channel`	String	The name of the channel to receive deployment_events notifications
`deployment_events`	Boolean	Trigger event when a deployment starts or finishes
`incident_channel`	String	The name of the channel to receive incident_events notifications
`issue_channel`	String	The name of the channel to receive issues_events notifications
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_request_channel`	String	The name of the channel to receive merge_requests_events notifications
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_channel`	String	The name of the channel to receive note_events notifications
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_channel`	String	The name of the channel to receive pipeline_events notifications
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_channel`	String	The name of the channel to receive push_events notifications
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_channel`	String	The name of the channel to receive tag_push_events notifications
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	Discord webhook (for example, `https://discord.com/api/webhooks/…`)
`wiki_page_channel`	String	The name of the channel to receive wiki_page_events notifications
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Drone Ci integration

PUT /api/v4/projects/{id}/services/drone-ci

Creates or updates the Drone Ci integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`drone_url` Required	String	Drone CI URL (for example, `http://drone.example.com`)
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`token` Required	String	Drone CI token
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Emails On Push integration

PUT /api/v4/projects/{id}/services/emails-on-push

Creates or updates the Emails On Push integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`disable_diffs`	Boolean	Disable code diffs
`push_events`	Boolean	Trigger event for pushes to the repository
`recipients` Required	String	Emails separated by whitespace
`send_from_committer_email`	Boolean	Send from committer
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Ewm integration

PUT /api/v4/projects/{id}/services/ewm

Creates or updates the Ewm integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`new_issue_url` Required	String	URL of the new issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the External Wiki integration

PUT /api/v4/projects/{id}/services/external-wiki

Creates or updates the External Wiki integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`external_wiki_url` Required	String	URL of the external wiki
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Gitlab Slack Application integration

PUT /api/v4/projects/{id}/services/gitlab-slack-application

Creates or updates the Gitlab Slack Application integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`alert_channel`	String	The name of the channel to receive alert_events notifications
`alert_events`	Boolean	Trigger event when a new, unique alert is recorded
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`channel`	String	Default channel to use if no other channel is configured
`confidential_issue_channel`	String	The name of the channel to receive confidential_issues_events notifications
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_channel`	String	The name of the channel to receive confidential_note_events notifications
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`deployment_channel`	String	The name of the channel to receive deployment_events notifications
`deployment_events`	Boolean	Trigger event when a deployment starts or finishes
`incident_channel`	String	The name of the channel to receive incident_events notifications
`incident_events`	Boolean	Trigger event when an incident is created
`issue_channel`	String	The name of the channel to receive issues_events notifications
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`labels_to_be_notified`	String	Labels to send notifications for. Leave blank to receive notifications for all events
`labels_to_be_notified_behavior`	String	Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`
`merge_request_channel`	String	The name of the channel to receive merge_requests_events notifications
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_channel`	String	The name of the channel to receive note_events notifications
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_channel`	String	The name of the channel to receive pipeline_events notifications
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_channel`	String	The name of the channel to receive push_events notifications
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_channel`	String	The name of the channel to receive tag_push_events notifications
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`wiki_page_channel`	String	The name of the channel to receive wiki_page_events notifications
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Google Play integration

PUT /api/v4/projects/{id}/services/google-play

Creates or updates the Google Play integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`google_play_protected_refs`	Boolean	Set variables on protected branches and tags only
`package_name` Required	String	Package name of the app in Google Play
`service_account_key` Required	String	Google Play service account key
`service_account_key_file_name` Required	String	File name of the Google Play service account key
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Hangouts Chat integration

PUT /api/v4/projects/{id}/services/hangouts-chat

Creates or updates the Hangouts Chat integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Hangouts Chat webhook (for example, `https://chat.googleapis.com/v1/spaces...`)
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Harbor integration

PUT /api/v4/projects/{id}/services/harbor

Creates or updates the Harbor integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`password` Required	String	The password of the user
`project_name` Required	String	The name of the project in the Harbor instance. For example, `testproject`
`url` Required	String	The base URL to the Harbor instance linked to the Deckhouse Code project. For example, `https://demo.goharbor.io`
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username` Required	String	The username created in the Harbor interface

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Irker integration

PUT /api/v4/projects/{id}/services/irker

Creates or updates the Irker integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`colorize_messages`	Boolean	Colorize messages
`default_irc_uri`	String	URI to add before each recipient. The default value is `irc://irc.network.net:6697/`
`push_events`	Boolean	Trigger event for pushes to the repository
`recipients` Required	String	Comma-separated list of channels or email addresses
`server_host`	String	irker daemon hostname. The default value is `localhost`
`server_port`	Integer	irker daemon port. The default value is `6659`
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Jenkins integration

PUT /api/v4/projects/{id}/services/jenkins

Creates or updates the Jenkins integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`jenkins_url` Required	String	URL of the Jenkins server
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`password`	String	Password of the Jenkins server
`project_name` Required	String	Name of the Jenkins project
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username`	String	Username of the Jenkins server

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Jira integration

PUT /api/v4/projects/{id}/services/jira

Creates or updates the Jira integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`api_url`	String	The base URL to the Jira instance API. Web URL value is used if not set (for example, `https://jira-api.example.com`)
`comment_on_event_enabled`	Boolean	Enable comments inside Jira issues on each GitLab event (commit / merge request)
`commit_events`	Boolean	Trigger event when a commit is created or updated
`issues_enabled`	String	Enable viewing Jira issues in Deckhouse Code
`jira_auth_type`	Integer	The authentication method to use with Jira. Use `0` for basic authentication, `1` for Jira personal access token, and `2` for Jira Cloud service accounts. Defaults to `0`
`jira_issue_prefix`	String	Prefix to match Jira issue keys
`jira_issue_regex`	String	Regular expression to match Jira issue keys
`jira_issue_transition_id`	String	The ID of one or more transitions for custom issue transitions.Ignored when `jira_issue_transition_automatic` is enabled. Defaults to a blank string,which disables custom transitions
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`password` Required	String	The Jira API token, password, or personal access token to use with Jira. When using Basic Authentication (`jira_auth_type` is `0`), use an API token for Jira Cloud, and a password for Jira Data Center or Jira Server. For a Jira personal access token (`jira_auth_type` is `1`), use the personal access token
`project_keys`	Array of strings	Keys of Jira projects to display. When `issues_enabled` is `true`, this setting filters which Jira projects are shown in Deckhouse Code. It does not restrict the API token’s access
`url` Required	String	The URL to the Jira project which is being linked to this Deckhouse Code project (for example, `https://jira.example.com`)
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username`	String	The email or username to use with Jira. Use an email for Jira Cloud, and a username for Jira Data Center and Jira Server. Required when using basic authentication (`jira_auth_type` is `0`)

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Jira Cloud App integration

PUT /api/v4/projects/{id}/services/jira-cloud-app

Creates or updates the Jira Cloud App integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`jira_cloud_app_deployment_gating_environments`	String	Enter the environment (production,staging,testing,development) where you want to enable deployment gating. Use comma (,) to separate multiple environments
`jira_cloud_app_enable_deployment_gating`	Boolean	Enable to approve or reject blocked Deckhouse Code deployments from Jira Service Management
`jira_cloud_app_service_ids`	String	Copy and paste your JSM Service ID here. Use comma (,) to separate multiple IDs
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Linear integration

PUT /api/v4/projects/{id}/services/linear

Creates or updates the Linear integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`workspace_url` Required	String	Linear workspace URL (for example, https://linear.app/example)

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Matrix integration

PUT /api/v4/projects/{id}/services/matrix

Creates or updates the Matrix integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`hostname`	String	Custom hostname of the Matrix server. The default value is `https://matrix-client.matrix.org`
`incident_events`	Boolean	Trigger event when an incident is created
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`room` Required	String	Unique identifier for the target room (in the format `!qPKKM111FFKKsfoCVy:matrix.org`)
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`token` Required	String	The Matrix access token (for example, `syt-zyx57W2v1u123ew11`)
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Mattermost integration

PUT /api/v4/projects/{id}/services/mattermost

Creates or updates the Mattermost integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`alert_channel`	String	The name of the channel to receive alert_events notifications
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`channel`	String	Default channel to use if no other channel is configured
`confidential_issue_channel`	String	The name of the channel to receive confidential_issues_events notifications
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_channel`	String	The name of the channel to receive confidential_note_events notifications
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`deployment_channel`	String	The name of the channel to receive deployment_events notifications
`deployment_events`	Boolean	Trigger event when a deployment starts or finishes
`incident_channel`	String	The name of the channel to receive incident_events notifications
`incident_events`	Boolean	Trigger event when an incident is created
`issue_channel`	String	The name of the channel to receive issues_events notifications
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`labels_to_be_notified`	String	Labels to send notifications for. Leave blank to receive notifications for all events
`labels_to_be_notified_behavior`	String	Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`
`merge_request_channel`	String	The name of the channel to receive merge_requests_events notifications
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_channel`	String	The name of the channel to receive note_events notifications
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_channel`	String	The name of the channel to receive pipeline_events notifications
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_channel`	String	The name of the channel to receive push_events notifications
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_channel`	String	The name of the channel to receive tag_push_events notifications
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username`	String	Mattermost notifications username
`webhook` Required	String	Mattermost notifications webhook (for example, `http://mattermost.example.com/hooks/...`)
`wiki_page_channel`	String	The name of the channel to receive wiki_page_events notifications
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Mattermost Slash Commands integration

PUT /api/v4/projects/{id}/services/mattermost-slash-commands

Creates or updates the Mattermost Slash Commands integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`token` Required	String	The Mattermost token
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Trigger a slash command for mattermost-slash-commands

POST /api/v4/projects/{id}/services/mattermost_slash_commands/trigger

Triggers a slash command for mattermost-slash-commands.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (application/json)

Property	Type	Description
`token` Required	String	The Mattermost token

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Create or update the Microsoft Teams integration

PUT /api/v4/projects/{id}/services/microsoft-teams

Creates or updates the Microsoft Teams integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Microsoft Teams webhook (for example, `https://outlook.office.com/webhook/...`)
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Mock Ci integration

PUT /api/v4/projects/{id}/services/mock-ci

Creates or updates the Mock Ci integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`mock_service_url` Required	String	URL of the Mock CI integration
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Mock Monitoring integration

PUT /api/v4/projects/{id}/services/mock-monitoring

Creates or updates the Mock Monitoring integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Packagist integration

PUT /api/v4/projects/{id}/services/packagist

Creates or updates the Packagist integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`push_events`	Boolean	Trigger event for pushes to the repository
`server`	String	URL of the Packagist server. The default value is `https://packagist.org`
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`token` Required	String	API token of the Packagist server
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username` Required	String	Username of a Packagist account

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Phorge integration

PUT /api/v4/projects/{id}/services/phorge

Creates or updates the Phorge integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Pipelines Email integration

PUT /api/v4/projects/{id}/services/pipelines-email

Creates or updates the Pipelines Email integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`notify_child_pipelines`	Boolean	Send notifications for child pipelines
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_default_branch`	Boolean	Send notifications for the default branch
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`recipients` Required	String	Comma-separated list of recipient email addresses
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Pivotaltracker integration

PUT /api/v4/projects/{id}/services/pivotaltracker

Creates or updates the Pivotaltracker integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`push_events`	Boolean	Trigger event for pushes to the repository
`restrict_to_branch`	String	Comma-separated list of branches to automatically inspect. Leave blank to include all branches
`token` Required	String	The Pivotal Tracker token
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Ptai integration

PUT /api/v4/projects/{id}/services/ptai

Creates or updates the Ptai integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`ptai_apply_all_pm_rules`	Boolean	Widens pattern matching to every rule the server holds, not only the ones the project’s languages select
`ptai_blackbox_allowlist`	String	RegExp" for the other two
`ptai_blackbox_auth_cookie`	String	The session cookie to present, for cookie authentication
`ptai_blackbox_auth_form_address`	String	For form authentication
`ptai_blackbox_auth_form_detection`	String	Whether the form is found on its own or described below. Defaults to automatic
`ptai_blackbox_auth_form_xpath`	String	For a form the scan cannot find by itself
`ptai_blackbox_auth_login`	String	For the sign-in form and HTTP Basic
`ptai_blackbox_auth_login_key`	String	The form field the user goes into, when the form is described by hand
`ptai_blackbox_auth_password`	String	—
`ptai_blackbox_auth_password_key`	String	The form field the password goes into
`ptai_blackbox_auth_type`	String	How the black box signs in. Without it the scan only ever sees the pages a stranger sees, which on most applications is the login page and nothing else
`ptai_blackbox_auth_validation_address`	String	A page only a signed-in user reaches. The scan asks for it to find out whether it is still signed in
`ptai_blackbox_auth_validation_template`	String	Text that appears on that page when signed in, and does not when signed out
`ptai_blackbox_autocheck`	Boolean	Tries what the static analysis found against the running site, and reports which of it is genuinely reachable. This is the finding neither box produces on its own
`ptai_blackbox_denylist`	String	One per line, same form as above. This is where a sign-out link goes, and anything else the scan must not follow
`ptai_blackbox_headers`	String	One per line, as “Name: value”
`ptai_blackbox_level`	String	How thoroughly the site is explored. Defaults to Normal
`ptai_blackbox_proxy_host`	String	Optional. Setting it is what turns the proxy on; the site is then reached through it
`ptai_blackbox_proxy_login`	String	—
`ptai_blackbox_proxy_password`	String	—
`ptai_blackbox_proxy_port`	String	—
`ptai_blackbox_proxy_type`	String	—
`ptai_blackbox_scope`	String	How far from the address the scan may wander: the whole domain, the folder it is in, or that path alone. Defaults to the path
`ptai_blackbox_site`	String	Address of the running application the black box scans. Setting it is what turns the black box on: the module is added to the scan by itself, so a site configured is never a module left un-ticked
`ptai_blackbox_ssl_check`	Boolean	Leave off for a staging site with a self-signed certificate
`ptai_ca_cert`	String	PEM certificate of the authority that signed the server’s certificate. Used only when the trust setting above says so
`ptai_languages`	String	One per line, as PT AI names them: Java, CSharp (Windows, Linux), Php, JavaScript, Python, Go, Kotlin, Ruby and the rest. A line rather than a comma because one of the names has a comma in it. Required as soon as anything else in this section or the black box below is set – the agent refuses a settings file without them, and there is no honest default: a guessed list is a scan that reads none of the code
`ptai_modules`	String	Optional. Comma-separated, as PT AI names them: Configuration, Components, BlackBox, PatternMatching, StaticCodeAnalysis, SoftwareCompositionAnalysis, SecretDetection, MaliciousCodeDetection. Defaults to the static ones. BlackBox is added on its own as soon as a site is given below
`ptai_server_url` Required	String	Base URL of the PT Application Inspector server
`ptai_settings_file`	String	Optional. Path in the repository to a project-settings file written by hand. It is used as it is and everything else in this form is ignored – the way out for a setting PT AI accepts and this form does not name
`ptai_skip_dependency_download`	Boolean	The analysis kernels fetch the project’s packages before they read the code. Where the server cannot reach the package registries that restore fails the whole scan, and no report is written at all – not even the findings already made. Turn this on there
`ptai_skip_gitignore`	Boolean	Keeps build output and vendored trees out of what is uploaded
`ptai_tls_mode`	String	How the scan job decides whether to trust the PT Application Inspector server. Leave it to the runner when the certificate is already trusted there; carry the authority with the scan when it is not
`ptai_token` Required	String	API token used to authenticate with the PT Application Inspector server
`ptai_use_security_policies`	Boolean	Checks the result against the policy held on the server. The agent then exits non-zero when the policy is broken, which is what fails the job
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Pumble integration

PUT /api/v4/projects/{id}/services/pumble

Creates or updates the Pumble integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Pumble webhook (for example, `https://api.pumble.com/workspaces/x/...`)
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Pushover integration

PUT /api/v4/projects/{id}/services/pushover

Creates or updates the Pushover integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`api_key` Required	String	The application key
`device`	String	Leave blank for all active devices
`priority` Required	String	The priority
`push_events`	Boolean	Trigger event for pushes to the repository
`sound`	String	The sound of the notification
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`user_key` Required	String	The user key

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Redmine integration

PUT /api/v4/projects/{id}/services/redmine

Creates or updates the Redmine integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`new_issue_url` Required	String	URL of the new issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Slack integration

PUT /api/v4/projects/{id}/services/slack

Creates or updates the Slack integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`alert_channel`	String	The name of the channel to receive alert_events notifications
`alert_events`	Boolean	Trigger event when a new, unique alert is recorded
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`channel`	String	Default channel to use if no other channel is configured
`confidential_issue_channel`	String	The name of the channel to receive confidential_issues_events notifications
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_channel`	String	The name of the channel to receive confidential_note_events notifications
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`deployment_channel`	String	The name of the channel to receive deployment_events notifications
`deployment_events`	Boolean	Trigger event when a deployment starts or finishes
`incident_channel`	String	The name of the channel to receive incident_events notifications
`incident_events`	Boolean	Trigger event when an incident is created
`issue_channel`	String	The name of the channel to receive issues_events notifications
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`labels_to_be_notified`	String	Labels to send notifications for. Leave blank to receive notifications for all events
`labels_to_be_notified_behavior`	String	Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`
`merge_request_channel`	String	The name of the channel to receive merge_requests_events notifications
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_channel`	String	The name of the channel to receive note_events notifications
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_channel`	String	The name of the channel to receive pipeline_events notifications
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_channel`	String	The name of the channel to receive push_events notifications
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_channel`	String	The name of the channel to receive tag_push_events notifications
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username`	String	Slack notifications username
`webhook` Required	String	Slack notifications webhook (for example, `https://hooks.slack.com/services/...`)
`wiki_page_channel`	String	The name of the channel to receive wiki_page_events notifications
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Squash Tm integration

PUT /api/v4/projects/{id}/services/squash-tm

Creates or updates the Squash Tm integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`token`	String	Secret token
`url` Required	String	URL of the Squash TM webhook
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Teamcity integration

PUT /api/v4/projects/{id}/services/teamcity

Creates or updates the Teamcity integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`build_type` Required	String	The build configuration ID of the TeamCity project
`enable_ssl_verification`	Boolean	Enable SSL verification. Defaults to `true` (enabled)
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`password` Required	String	The password of the user
`push_events`	Boolean	Trigger event for pushes to the repository
`teamcity_url` Required	String	TeamCity root URL (for example, `https://teamcity.example.com`)
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`username` Required	String	A user with permissions to trigger a manual build

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Telegram integration

PUT /api/v4/projects/{id}/services/telegram

Creates or updates the Telegram integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`hostname`	String	Custom hostname of the Telegram API. The default value is `https://api.telegram.org`
`incident_events`	Boolean	Trigger event when an incident is created
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`room` Required	String	Unique identifier for the target chat or the username of the target channel (in the format `@channelusername`)
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`thread`	String	Unique identifier for the target message thread (topic in a forum supergroup)
`token` Required	String	The Telegram bot token (for example, `123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11`)
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Trivy integration

PUT /api/v4/projects/{id}/services/trivy

Creates or updates the Trivy integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`trivy_ca_cert`	String	PEM certificate of the authority that signed the registry’s certificate. Used only when the trust setting above says so
`trivy_db_repository`	String	Optional. OCI repository the vulnerability database is pulled from. An installation with no route to the public registries needs its own mirror named here, or every scan fails before it reads anything
`trivy_debug`	Boolean	Logs what the scan resolved and where it read it from
`trivy_extra_args`	String	Optional. Passed to the scan as written, for the flags this form does not name
`trivy_ignore_unfixed`	Boolean	Drops findings with no fixed version published, leaving the ones a bump would close
`trivy_ignorefile`	String	Optional. Path to a .trivyignore in the repository. Defaults to .trivyignore
`trivy_image`	String	Optional. Image the container scan reads, as it is named in the registry. Defaults to this project’s own image at the commit being built
`trivy_image_sources`	String	Optional. Where the image is read from, in order: docker, containerd, podman, remote. Defaults to the registry alone, which is the only one a job with no container runtime of its own can use
`trivy_java_db_repository`	String	Optional. The separate database Trivy pulls only when it meets a jar it cannot identify from the build files
`trivy_offline_scan`	Boolean	Stops the scan making requests of its own to identify dependencies. The database is still downloaded; this is about the lookups on top of it
`trivy_package_types`	String	Optional. Comma-separated: os for the image’s own packages, library for what the application depends on. Defaults to both
`trivy_platform`	String	Optional. Which variant of a multi-platform image to scan, as os/arch. Without it the registry decides, which on a mixed fleet is not always the one that ships
`trivy_registry_password`	String	—
`trivy_registry_token`	String	Optional. For a registry that authenticates with a bearer token instead
`trivy_registry_user`	String	Optional. Leave both credentials blank to read this instance’s own registry with the job’s credentials
`trivy_scanner_image`	String	Optional. The Trivy image the job itself runs in. Point it at a mirror when the runner cannot reach Docker Hub
`trivy_scanners`	String	Optional. Comma-separated: vuln, misconfig, secret, license. Defaults to vuln, because a policy that runs this one usually runs a secret scan of its own
`trivy_severities`	String	Optional. Comma-separated: UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL. Filters what the scan reports at all, which is not the same as the severity that fails the job
`trivy_skip_dirs`	String	Optional. One directory or glob per line
`trivy_skip_files`	String	Optional. One file or glob per line
`trivy_timeout`	String	Optional. As a duration: 5m, 90s, 1h30m. A large image with many application dependencies outlives the default of 5m
`trivy_tls_mode`	String	How the scan decides whether to trust the registry it pulls from
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Unify Circuit integration

PUT /api/v4/projects/{id}/services/unify-circuit

Creates or updates the Unify Circuit integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Unify Circuit webhook (for example, `https://circuit.com/rest/v2/webhooks/incoming/...`)
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Webex Teams integration

PUT /api/v4/projects/{id}/services/webex-teams

Creates or updates the Webex Teams integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`branches_to_be_notified`	String	Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`
`confidential_issues_events`	Boolean	Trigger event when a confidential work item is created, updated, or closed
`confidential_note_events`	Boolean	Trigger event for new comments on confidential work items
`confidential_work_item_events`	Boolean	—
`issues_events`	Boolean	Trigger event when a work item is created, updated, or closed
`merge_requests_events`	Boolean	Trigger event when a merge request is created, updated, or merged
`note_events`	Boolean	Trigger event for new comments
`notify_only_broken_pipelines`	Boolean	Send notifications for broken pipelines
`notify_only_when_pipeline_status_changes`	Boolean	Send notifications only when the pipeline status changes
`pipeline_events`	Boolean	Trigger event when a pipeline status changes
`push_events`	Boolean	Trigger event for pushes to the repository
`tag_push_events`	Boolean	Trigger event for new tags pushed to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`webhook` Required	String	The Webex Teams webhook. For example, https://api.ciscospark.com/v1/webhooks/incoming/…
`wiki_page_events`	Boolean	Trigger event when a wiki page is created or updated
`work_item_events`	Boolean	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Youtrack integration

PUT /api/v4/projects/{id}/services/youtrack

Creates or updates the Youtrack integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`issues_url` Required	String	URL of the issue
`project_url` Required	String	URL of the project
`push_events`	Boolean	Trigger event for pushes to the repository
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create or update the Zentao integration

PUT /api/v4/projects/{id}/services/zentao

Creates or updates the Zentao integration.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`api_token` Required	String	—
`api_url`	String	If different from Web URL
`url` Required	String	Base URL of the ZenTao instance
`use_inherited_settings`	Boolean	Indicates whether to inherit the default settings. Defaults to `false`
`zentao_product_xid` Required	String	—

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegrationBasic
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Retrieve integration settings

GET /api/v4/projects/{id}/services/{slug}

Retrieves the settings for a specified integration.

Parameters

Name	Type	Description
`slug` Path, required	String	The name of the integration Allowed values: `apple-app-store`, `asana`, `assembla`, `bamboo`, `bugzilla`, `buildkite`, `campfire`, `confluence`, `custom-issue-tracker`, `datadog`, `diffblue-cover`, `discord`, `drone-ci`, `emails-on-push`, `external-wiki`, `gitlab-slack-application`, `google-play`, `hangouts-chat`, `harbor`, `irker`, `jenkins`, `jira`, `jira-cloud-app`, `linear`, `matrix`, `mattermost-slash-commands`, `packagist`, `phorge`, `pipelines-email`, `pivotaltracker`, `pumble`, `pushover`, `redmine`, `ewm`, `youtrack`, `clickup`, `slack`, `microsoft-teams`, `mattermost`, `teamcity`, `telegram`, `unify-circuit`, `webex-teams`, `zentao`, `squash-tm`, `defect-dojo`, `ptai`, `code-scoring`, `trivy`, `mock-ci`, `mock-monitoring` Minimum length: `1`
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIntegration
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

Disable an integration

DELETE /api/v4/projects/{id}/services/{slug}

Disables a specified integration. Integration settings are preserved.

Parameters

Name	Type	Description
`slug` Path, required	String	The name of the integration Allowed values: `apple-app-store`, `asana`, `assembla`, `bamboo`, `bugzilla`, `buildkite`, `campfire`, `confluence`, `custom-issue-tracker`, `datadog`, `diffblue-cover`, `discord`, `drone-ci`, `emails-on-push`, `external-wiki`, `gitlab-slack-application`, `google-play`, `hangouts-chat`, `harbor`, `irker`, `jenkins`, `jira`, `jira-cloud-app`, `linear`, `matrix`, `mattermost-slash-commands`, `packagist`, `phorge`, `pipelines-email`, `pivotaltracker`, `pumble`, `pushover`, `redmine`, `ewm`, `youtrack`, `clickup`, `slack`, `microsoft-teams`, `mattermost`, `teamcity`, `telegram`, `unify-circuit`, `webex-teams`, `zentao`, `squash-tm`, `defect-dojo`, `ptai`, `code-scoring`, `trivy`, `mock-ci`, `mock-monitoring` Minimum length: `1`
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

Trigger a global slack command

POST /api/v4/slack/trigger

Triggers a global slack command.

Request body (application/json)

Property	Type	Description
`text` Required	String	Text of the slack command

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`401`	Unauthorized	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesIntegration

Property	Type	Description
`active`	Boolean	—
`alert_events`	Boolean	—
`comment_on_event_enabled`	Boolean	—
`commit_events`	Boolean	—
`confidential_issues_events`	Boolean	—
`confidential_note_events`	Boolean	—
`created_at`	String (date-time)	Example: `2019-11-20T11:20:25.297Z`
`deployment_events`	Boolean	—
`id`	Integer (int64)	Example: `75`
`incident_events`	Boolean	—
`inherited`	Boolean	—
`issues_events`	Boolean	—
`job_events`	Boolean	—
`merge_requests_events`	Boolean	—
`note_events`	Boolean	—
`pipeline_events`	Boolean	—
`properties`	Object	Example: `{"token":"secr3t"}`
`push_events`	Boolean	—
`slug`	String	Example: `jenkins`
`tag_push_events`	Boolean	—
`title`	String	Example: `Jenkins CI`
`updated_at`	String (date-time)	Example: `2019-11-20T12:24:37.498Z`
`wiki_page_events`	Boolean	—

APIEntitiesIntegrationBasic

Property	Type	Description
`active`	Boolean	—
`alert_events`	Boolean	—
`comment_on_event_enabled`	Boolean	—
`commit_events`	Boolean	—
`confidential_issues_events`	Boolean	—
`confidential_note_events`	Boolean	—
`created_at`	String (date-time)	Example: `2019-11-20T11:20:25.297Z`
`deployment_events`	Boolean	—
`id`	Integer (int64)	Example: `75`
`incident_events`	Boolean	—
`inherited`	Boolean	—
`issues_events`	Boolean	—
`job_events`	Boolean	—
`merge_requests_events`	Boolean	—
`note_events`	Boolean	—
`pipeline_events`	Boolean	—
`push_events`	Boolean	—
`slug`	String	Example: `jenkins`
`tag_push_events`	Boolean	—
`title`	String	Example: `Jenkins CI`
`updated_at`	String (date-time)	Example: `2019-11-20T12:24:37.498Z`
`wiki_page_events`	Boolean	—