Skip to main content
Updates one project of the organization by project ID.

​
Basic Parameters

ParameterDescription
Business CriticalityPossible values:
* low
* medium
* high
* critical.
EnvironmentA comma-separated list of environments. Possible values:
* frontend
* backend
* internal
* external
* mobile
* saas
* onprem
* hosted
* distributed.
LifecyclePossible values:
* production
* development
* sandbox.
Organization IDThe ID of the Org the project belongs to.
Owner IDThe public ID of the user that owns the project.
Project IDThe ID of the project to patch.
Tags-
Test FrequencyTest frequency of a project. Also controls when automated PRs may be created.
User IDThe ID of user initiating the action.

​
Advanced Parameters

ParameterDescription
ExpandExpand relationships.

​
Example Output

{
	"data": {
		"attributes": {
			"build_args": {
				"root_workspace": "string"
			},
			"business_criticality": [
				"medium"
			],
			"created": "2021-05-29T09:50:54.014Z",
			"environment": [
				"external",
				"hosted"
			],
			"lifecycle": [
				"production"
			],
			"name": "snyk/goof",
			"origin": "github",
			"settings": {
				"auto_dependency_upgrade": {
					"ignored_dependencies": [
						"typescript"
					],
					"is_enabled": true,
					"is_inherited": true,
					"is_major_upgrade_enabled": true,
					"limit": 10,
					"minimum_age": 365
				},
				"auto_remediation_prs": {
					"is_backlog_prs_enabled": true,
					"is_fresh_prs_enabled": true,
					"is_patch_remediation_enabled": true
				},
				"manual_remediation_prs": {
					"is_patch_remediation_enabled": true
				},
				"pull_request_assignment": {
					"assignees": [
						"my-github-username"
					],
					"is_enabled": true,
					"type": "auto"
				},
				"pull_requests": {
					"fail_only_for_issues_with_fix": true,
					"policy": "all",
					"severity_threshold": "high"
				},
				"recurring_tests": {
					"frequency": "daily"
				}
			},
			"status": "active",
			"tags": [
				{
					"key": "tag-key",
					"value": "tag-value"
				}
			],
			"target_file": "package.json",
			"target_reference": "main",
			"target_runtime": "string",
			"type": "maven"
		},
		"id": "331ede0a-de94-456f-b788-166caeca58bf",
		"links": {
			"first": "https://example.com/api/resource",
			"last": "https://example.com/api/resource",
			"next": "https://example.com/api/resource",
			"prev": "https://example.com/api/resource",
			"related": "https://example.com/api/resource",
			"self": "https://example.com/api/resource"
		},
		"meta": {
			"cli_monitored_at": "2021-05-29T09:50:54.014Z"
		},
		"relationships": {
			"importer": {
				"data": {
					"id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
					"type": "resource"
				},
				"links": {
					"related": {
						"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
					}
				}
			},
			"organization": {
				"data": {
					"id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
					"type": "resource"
				},
				"links": {
					"related": {
						"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
					}
				}
			},
			"owner": {
				"data": {
					"id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
					"type": "resource"
				},
				"links": {
					"related": {
						"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
					}
				}
			},
			"target": {
				"data": {
					"id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
					"type": "resource"
				},
				"links": {
					"related": {
						"href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
					}
				}
			}
		},
		"type": "project"
	},
	"jsonapi": {
		"version": "1.0"
	},
	"links": {
		"first": "https://example.com/api/resource",
		"last": "https://example.com/api/resource",
		"next": "https://example.com/api/resource",
		"prev": "https://example.com/api/resource",
		"related": "https://example.com/api/resource",
		"self": "https://example.com/api/resource"
	}
}

​
Workflow Library Example

Update Organization Project with Snyk and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop