{"components":{"examples":{"CloudListIssuesResponse":{"summary":"An example of a list issue response for a Cloud issue.","value":{"data":[{"attributes":{"classes":[{"id":"data","source":"snyk-cloud","type":"rule-category"},{"id":"CIS-AWS_v1.3.0_2.1.2","source":"CIS-AWS_v1.3.0","type":"compliance"},{"id":"CIS-AWS_v1.4.0_2.1.2","source":"CIS-AWS_v1.4.0","type":"compliance"},{"id":"HIPAA_§164.306(a)","source":"HIPAA_v2013","type":"compliance"},{"id":"HIPAA_§164.312(a)(2)(iv)","source":"HIPAA_v2013","type":"compliance"},{"id":"HIPAA_v2013_164.312(e)(2)(ii)","source":"HIPAA_v2013","type":"compliance"}],"coordinates":[{"remedies":[{"description":"1. Go to the AWS console\n2. Navigate to the S3 service page\n3. ...","type":"manual"},{"description":"1. Find the corresponding AWS::S3::Bucket resource\n2. ...","type":"cloudformation"},{"description":"1. Find the corresponding aws_s3_bucket resource\n2. ...","type":"terraform"},{"description":"Buckets should not ...","type":"rule_result_message"}],"representations":[{"cloud_resource":{"environment":{"id":"b50f2832-a901-565e-9e06-e4e59e8582b6","name":"Staging","native_id":"721018433921","type":"aws"},"resource":{"id":"b50f2832-a901-565e-9e06-e4e59e8582b7","input_type":"cloud_scan","location":"us-east-1","name":"policy-test-remediation","native_id":"arn:aws:s3:::policy-test-remediation","platform":"aws","resource_type":"aws_s3_bucket","tags":{"Stage":"Prod"},"type":"cloud"}}}]}],"created_at":"2022-09-27T20:09:05Z","description":"To protect data in transit, an S3 bucket policy should deny all HTTP requests to its objects and allow only HTTPS requests. HTTPS uses Transport Layer Security (TLS) to encrypt data, which preserves integrity and prevents tampering.","effective_severity_level":"medium","ignored":false,"key":"b50f2832-a901-565e-9e06-e4e59e8582b6","problems":[{"id":"SNYK-CC-00181","source":"snyk-cloud","type":"rule"}],"resolution":{"details":"rule_passed","resolved_at":"2022-09-28T20:09:05Z","type":"fixed"},"status":"resolved","title":"S3 bucket policies should only allow requests that use HTTPS","tool":"snyk://cloud","type":"cloud","updated_at":"2022-09-28T20:09:05Z"},"id":"d8db944b-d25a-477d-9c26-a63befad8ada","relationships":{"organization":{"data":{"id":"81e93f62-135f-48bc-84d0-47f16822313f","type":"organization"}},"scan_item":{"data":{"id":"24c8e771-ab3b-4e85-ac4f-f73950ba4acf","type":"environment"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}},"CodeListIssuesResponse20240123":{"summary":"An example of a list issue response for a Code issue.","value":{"data":[{"attributes":{"created_at":"2022-09-27T20:09:05Z","effective_severity_level":"low","ignored":false,"key":"24018479-6bb1-4196-a41b-e54c7c5dcc82:1c6ddc45.7f41fd64.a214ef38.72ad650e.f0ecbaa5.18c3080a.b570850e.89112ac5.1a6d2cd5.71413d6f.a924ef28.71cdd50e.d0e1bea5.52c3a80a.1a0c4319.a9127ac5:1","status":"resolved","title":"Insecure hash function used","type":"code","updated_at":"2022-09-27T20:09:05Z"},"id":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","relationships":{"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}},"IaCListIssuesResponse20240123":{"summary":"An example of a list issue response for an Infrastructure as Code issue.","value":{"data":[{"attributes":{"created_at":"2022-09-27T20:09:05Z","effective_severity_level":"low","ignored":false,"key":"ff35a5c4d1cb4a1fd29c38b70f8ab89d1efea9d75aabf3a202d94f4776714b6191e2747cded23ba6cd7a47017a505a5d2c0823b69106ee2be0c11a18aa44b8a4","status":"resolved","title":"Container is running with writable root filesystem","type":"cloud","updated_at":"2022-09-27T20:09:05Z"},"id":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","relationships":{"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}},"OpenSourceListIssuesResponse20240123":{"summary":"An example of a list issue response for an Open Source issue.","value":{"data":[{"attributes":{"created_at":"2022-09-27T20:09:05Z","effective_severity_level":"medium","ignored":false,"key":"npm:hoek:20180212:hoek:2.16.3","status":"resolved","title":"Hoek - Prototype Pollution","type":"package_vulnerability","updated_at":"2022-09-27T20:09:05Z"},"id":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","relationships":{"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}}},"type":"issue"}],"jsonapi":{"version":"1.0"}}}},"headers":{"DeprecationHeader":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"DeprecationHeader__0":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"Location":{"schema":{"type":"string"}},"LocationHeader":{"description":"A header providing a URL for the location of a resource\n","example":"https://example.com/resource/4","schema":{"format":"url","type":"string"}},"RequestIdResponseHeader":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"RequestIdResponseHeader__0":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"RetryAfter":{"description":"Retry after seconds","example":45,"schema":{"type":"integer"}},"SunsetHeader":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}},"SunsetHeader__0":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}},"VersionRequestedResponseHeader":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"$ref":"#/components/schemas/QueryVersion"}},"VersionRequestedResponseHeader__0":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"VersionServedResponseHeader":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"$ref":"#/components/schemas/ActualVersion"}},"VersionServedResponseHeader__0":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"VersionStageResponseHeader":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"VersionStageResponseHeader__0":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}}},"parameters":{"Accept":{"in":"header","name":"Accept","schema":{"type":"string"}},"AggregateGroupValues":{"description":"Per-field aggregate function override for meta fields.\nAll fields default to `last` when not specified.\n`max`/`min` compute the SQL MAX/MIN across all assets in the group (scalar fields only).\n`first`/`last` returns the value from the single asset with the earliest/latest\nupdated_at in the group (all field types).\n`sum` computes the total across all assets (numeric fields, issues, labels, tags).\n","explode":true,"in":"query","name":"aggregate","schema":{"properties":{"issues":{"default":"last","enum":["first","last","sum"],"type":"string"},"labels":{"default":"last","enum":["first","last","sum"],"type":"string"},"last_seen_at":{"default":"last","enum":["max","min","first","last"],"type":"string"},"risk_score":{"default":"last","enum":["max","min","first","last","sum"],"type":"string"},"tags":{"default":"last","enum":["first","last","sum"],"type":"string"},"updated_at":{"default":"last","enum":["max","min","first","last"],"type":"string"}},"type":"object"},"style":"deepObject"},"AiBomIdParam":{"description":"The ai_bom id","in":"path","name":"ai_bom_id","required":true,"schema":{"format":"uuid","type":"string"}},"ApiVersion":{"description":"The requested version of the endpoint to process the request","example":"2025-11-05","in":"query","name":"version","required":true,"schema":{"default":"2025-11-05","description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"AppId":{"description":"App ID","in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},"AssetId":{"description":"Unique identifier for the Asset","in":"path","name":"asset_id","required":true,"schema":{"format":"uuid","type":"string"}},"AssetTypeFilter":{"description":"Filter by asset type","in":"query","name":"type","schema":{"enum":["repository","package","image"],"type":"string"}},"AssignableByMe":{"description":"When true, only return roles that the current user can assign to others in the tenant.","in":"query","name":"assignable_by_me","schema":{"$ref":"#/components/schemas/AssignableByMe"}},"BotId":{"description":"Bot ID","in":"path","name":"bot_id","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},"Cascade":{"description":"indicates whether to delete the child org memberships of the group membership.","in":"query","name":"cascade","schema":{"type":"boolean"}},"ChannelId":{"description":"Slack Channel ID","in":"path","name":"channel_id","required":true,"schema":{"format":"uri","type":"string"}},"ChannelLimit":{"description":"Number of results to return per page","example":100,"in":"query","name":"limit","schema":{"default":1000,"format":"int32","maximum":1000,"minimum":10,"multipleOf":10,"type":"integer"}},"ClientId":{"description":"Client ID","in":"path","name":"client_id","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},"CollectionId":{"description":"Unique identifier for a collection","in":"path","name":"collection_id","required":true,"schema":{"format":"uuid","type":"string"}},"CompletionInterval":{"description":"Filter by date interval in ISO 8601 format (e.g. 2024-01-01/2024-02-01)","in":"query","name":"completion_interval","schema":{"$ref":"#/components/schemas/DateInterval"}},"ConnectionId":{"description":"Connection ID","in":"path","name":"connection_id","required":true,"schema":{"format":"uuid","type":"string"}},"ConnectionTypeFilter":{"description":"Filter the response by Users that match the provided connection type","in":"query","name":"connection_type","schema":{"type":"string"}},"ContentSource":{"description":"The source of educational resources","in":"query","name":"content_source","schema":{"enum":["source-preview","cache"],"type":"string"}},"ContextId":{"description":"Context ID","in":"path","name":"context_id","required":true,"schema":{"format":"uuid","type":"string"}},"CreatedAfter":{"description":"Return environments created after this date","example":"2022-05-06T12:25:15-04:00","in":"query","name":"created_after","schema":{"format":"date-time","type":"string"}},"CreatedBefore":{"description":"Return environments created before this date","example":"2022-05-06T12:25:15-04:00","in":"query","name":"created_before","schema":{"format":"date-time","type":"string"}},"CredentialId":{"description":"Credential ID","in":"path","name":"credential_id","required":true,"schema":{"format":"uuid","type":"string"}},"Cursor":{"description":"The ID for the next page of results.","in":"query","name":"cursor","schema":{"type":"string"}},"Custom":{"description":"Whether role is custom or not.","in":"query","name":"custom","schema":{"$ref":"#/components/schemas/Custom"}},"CustomBaseImageId":{"description":"Unique identifier for custom base image","in":"path","name":"custombaseimage_id","required":true,"schema":{"format":"uuid","type":"string"}},"Cves":{"description":"Filter by CVE rules","in":"query","name":"cves","schema":{"$ref":"#/components/schemas/Cves"}},"Cwes":{"description":"Filter by CWE rules","in":"query","name":"cwes","schema":{"$ref":"#/components/schemas/Cwes"}},"DeploymentId":{"description":"Deployment ID","in":"path","name":"deployment_id","required":true,"schema":{"format":"uuid","type":"string"}},"Ecosystem":{"description":"The package ecosystem","in":"path","name":"ecosystem","required":true,"schema":{"enum":["npm","pypi","maven","nuget","golang"],"example":"npm","type":"string"}},"EffectiveSeverityLevel":{"description":"One or more effective severity levels to filter issues.","explode":false,"in":"query","name":"effective_severity_level","schema":{"items":{"enum":["info","low","medium","high","critical"],"type":"string"},"type":"array"},"style":"form"},"EmailFilter":{"description":"Filter the response by Users that match the provided email","in":"query","name":"email","schema":{"type":"string"}},"Emails":{"description":"Filter by user email addresses","example":["john.doe@example.com","jane.smith@example.com"],"explode":false,"in":"query","name":"emails","schema":{"$ref":"#/components/schemas/Emails"},"style":"form"},"EndingBefore":{"description":"Return the page of results immediately before this cursor","example":"v1.eyJpZCI6IjExMDAifQo=","in":"query","name":"ending_before","schema":{"type":"string"}},"EndingBeforeCursor":{"description":"Return records before the record identified by cursor position ending_before","in":"query","name":"ending_before","schema":{"type":"string"}},"EnvironmentId":{"description":"Unique identifier for an environment","example":"052781a7-17f6-494d-0000-25c8b509abcd","in":"path","name":"environment_id","required":true,"schema":{"format":"uuid","type":"string"}},"EnvironmentIdQuery":{"description":"Filter resources by environment ID (multi-value, comma-separated)","example":"052781a7-17f6-494d-0000-25c8b509abcd","explode":false,"in":"query","name":"environment_id","schema":{"format":"uuid","type":"string"},"style":"form"},"Events":{"description":"Filter logs by event types, cannot be used in conjunction with exclude_events parameter.","in":"query","name":"events","schema":{"items":{"type":"string"},"type":"array"}},"Exclude":{"description":"An array of features to be excluded from the generated SBOM.","in":"query","name":"exclude","schema":{"items":{"enum":["licenses"],"type":"string"},"type":"array"}},"ExcludeEvents":{"description":"Exclude event types from results, cannot be used in conjunctions with events parameter.","in":"query","name":"exclude_events","schema":{"items":{"type":"string"},"type":"array"}},"ExpandPermissions":{"description":"option to show all permission types","in":"query","name":"expand_permissions","schema":{"default":false,"type":"boolean"}},"ForceUpdate":{"description":"flag to force the update of a role, required if users are assigned to the role","in":"query","name":"force","schema":{"$ref":"#/components/schemas/ForceUpdate"}},"Format":{"description":"The desired SBOM format of the response.","in":"query","name":"format","schema":{"enum":["cyclonedx1.6+json","cyclonedx1.6+xml","cyclonedx1.5+json","cyclonedx1.5+xml","cyclonedx1.4+json","cyclonedx1.4+xml","spdx2.3+json"],"example":"cyclonedx1.6+json","type":"string"}},"From":{"description":"The start date (inclusive) of the audit logs search. If not specified, the start of yesterday is used. Dates should be formatted as RFC3339, e.g. 2024-01-02T16:30:00Z.\n","in":"query","name":"from","schema":{"format":"date-time","type":"string"}},"GoModuleLevel":{"description":"When true, consolidate Go package-level dependencies into module-level components in the SBOM. Only applies to gomodules graphs; default is false.","in":"query","name":"go_module_level","schema":{"default":false,"type":"boolean"}},"GroupId":{"description":"The ID of the Group.","example":"0d3728ec-eebf-484d-9907-ba238019f10b","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},"HasUsersAssigned":{"description":"returns current memberships of the role in the meta relationships section","in":"query","name":"has_users_assigned","schema":{"default":false,"type":"boolean"}},"Id":{"description":"Filter resources by resource UUID (multi-value, comma-separated)","example":"4a662442-7445-55c3-adcc-cbbbdd99999","explode":false,"in":"query","name":"id","schema":{"type":"string"},"style":"form"},"IdInQuery":{"description":"Filter environments by environment ID (multi-value, comma-separated)","example":"052781a7-17f6-494d-0000-25c8b509abcd","in":"query","name":"id","schema":{"format":"uuid","type":"string"}},"Ignored":{"description":"Whether an issue is ignored or not.","in":"query","name":"ignored","schema":{"type":"boolean"},"style":"form"},"ImageId20231102":{"description":"Image ID","in":"path","name":"image_id","required":true,"schema":{"example":"sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676","format":"uri","pattern":"^sha256(:|%3A)[a-f0-9]{64}$","type":"string"}},"ImageIds":{"description":"A comma-separated list of Image IDs","example":["sha256:b26f21f90920dba8401e30b89ad803587f81cce9bd1f92750f963556da2f930f","sha256:28984a62eb713aa5fff922ba06e8689f20e4b2f07de30f3d753b868389c0904f"],"explode":false,"in":"query","name":"image_ids","schema":{"items":{"format":"uri","pattern":"^sha256(:|%3A)[a-f0-9]{64}$","type":"string"},"maxItems":100,"type":"array"},"style":"form"},"IncludeGroupMembershipCount":{"description":"indicates whether the count of group memberships is included","in":"query","name":"include_group_membership_count","schema":{"type":"boolean"}},"IncludeInRecommendations":{"description":"Whether this image should be recommended as a base image upgrade","in":"query","name":"include_in_recommendations","schema":{"type":"boolean"}},"InstallId":{"description":"Install ID","in":"path","name":"install_id","required":true,"schema":{"format":"uuid","type":"string"}},"IntegrationId":{"description":"Integration ID","in":"path","name":"integration_id","required":true,"schema":{"format":"uuid","type":"string"}},"JobId":{"description":"Job ID","in":"path","name":"job_id","required":true,"schema":{"format":"uuid","type":"string"}},"JobIdParam":{"description":"The job id","in":"path","name":"job_id","required":true,"schema":{"format":"uuid","type":"string"}},"Kind":{"description":"Filter resources by kind (multi-value, comma-separated): cloud","example":"cloud","explode":false,"in":"query","name":"kind","schema":{"$ref":"#/components/schemas/ResourceKind"},"style":"form"},"KindInQuery":{"description":"Filter environments by kind (multi-value, comma-separated): aws","example":"aws","in":"query","name":"kind","schema":{"$ref":"#/components/schemas/EnvironmentKind"}},"Limit":{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":10,"multipleOf":10,"type":"integer"}},"Location":{"description":"Filter resources by location (multi-value, comma-separated) (AWS region)","example":"us-west-2","explode":false,"in":"query","name":"location","schema":{"type":"string"},"style":"form"},"MembershipId":{"description":"Unique identifier of the tenant membership.","in":"path","name":"membership_id","required":true,"schema":{"$ref":"#/components/schemas/TenantMembershipId"}},"MetaCount":{"description":"Provide summary count in the response meta object when requested.\nWhen `with` is provided, the count will be included in the response meta object.\nWhen `only` is provided, the count will be included in the response meta object and no data will be returned.\n","example":"with","in":"query","name":"meta_count","schema":{"enum":["with","only"],"type":"string"}},"MetaFieldsGroupValues":{"description":"Meta fields to include in the response. Multiple fields can be specified.\n\nAvailable fields:\n - `count` - Number of assets with this value\n - `last_seen_at` - Aggregated last_seen_at timestamp (default aggregation: last)\n - `updated_at` - Aggregated updated_at timestamp (default aggregation: last)\n - `risk_score` - Aggregated risk score from discovery sources (default aggregation: last)\n - `issues` - Aggregated issue counts (critical, high, medium, low, total) (default aggregation: last)\n - `labels` - Labels across assets (default aggregation: last)\n - `tags` - Tags across assets (default aggregation: last)\n - `all` - Include all available meta fields\n\nAll fields default to the `last` aggregation function, which returns the value\nfrom the asset with the most recent updated_at in the group. Use the `aggregate`\nparameter to override the aggregation function per field.\n\nIf not specified, the meta object is not included in the response.\n\nNote: Requesting meta fields may impact response time as aggregations\nrequire additional computation.\n","example":["count","risk_score","issues","labels"],"explode":false,"in":"query","name":"meta_fields","schema":{"items":{"enum":["count","last_seen_at","updated_at","risk_score","issues","labels","tags","all"],"type":"string"},"type":"array"},"style":"form"},"Name":{"description":"Filter resources by name (multi-value, comma-separated)","example":"example-bucket","explode":false,"in":"query","name":"name","schema":{"type":"string"},"style":"form"},"NameFilter":{"description":"Filter the response by Users that match the provided name","in":"query","name":"name","schema":{"type":"string"}},"NameInQuery":{"description":"Filter environments by name (multi-value, comma-separated)","example":"Demo AWS Environment","in":"query","name":"name","schema":{"$ref":"#/components/schemas/EnvironmentName"}},"Names":{"description":"The container registry names","example":["gcr.io/snyk/redis:5"],"explode":false,"in":"query","name":"names","schema":{"items":{"$ref":"#/components/schemas/ImageName"},"maxItems":1,"type":"array"},"style":"form"},"NativeId":{"description":"Filter resources by native ID (multi-value, comma-separated) (AWS ARN)","example":"arn:aws:s3:::example-bucket","explode":false,"in":"query","name":"native_id","schema":{"type":"string"},"style":"form"},"OrderBy":{"description":"The column name to sort on","in":"query","name":"order_by","schema":{"enum":["created","expires","ignore-type","requested-by"],"type":"string"}},"OrderDirection":{"description":"Sorting direction ASC/DESC","in":"query","name":"order_direction","schema":{"enum":["asc","desc"],"type":"string"}},"OrgId":{"description":"The ID of the organization.","example":"0d3728ec-eebf-484d-9907-ba238019f10b","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},"OrgIdFilter":{"description":"The IDs of the org to filter by","explode":false,"in":"query","name":"org_id","schema":{"items":{"format":"uuid","type":"string"},"type":"array"},"style":"form"},"OrgIdParam":{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},"OrgId__0":{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},"OrgMembershipId":{"description":"The id of the org membership","in":"path","name":"membership_id","required":true,"schema":{"format":"uuid","type":"string"}},"OrgName":{"description":"The Name of the org","in":"query","name":"org_name","schema":{"description":"Organization name","example":"Org name","type":"string"}},"PackageName":{"description":"Package name (URL encoded if needed)","in":"path","name":"package_name","required":true,"schema":{"example":"express","type":"string"}},"PackageUrl":{"description":"A URI-encoded Package URL (purl). Supported purl types are apk, cargo, cocoapods, composer, conan, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. A version for the package is also required. Maven packages support an optional checksum qualifier to request checksum validation. When provided, the response will include checksum validation metadata indicating whether the package and checksum match records in Snyk's database. Checksum format: `algorithm:hex_value` (lowercase), for example `sha1:ad9503c3e994a4f611a4892f2e67ac82df727086`. Only one checksum is supported per request. Supported algorithms: md5, sha1, sha256, sha512.","example":"pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0?checksum=sha1:ad9503c3e994a4f611a4892f2e67ac82df727086","in":"path","name":"purl","required":true,"schema":{"type":"string"}},"PackageVersion":{"description":"Package version (URL encoded if needed). Accepts semantic versioning formats (e.g., 1.2.3, v1.2.3).\nNote: Golang commit hashes are NOT supported.\n","in":"path","name":"package_version","required":true,"schema":{"example":"4.19.2","type":"string"}},"PathGroupId":{"description":"Unique identifier for group","in":"path","name":"group_id","required":true,"schema":{"example":"b667f176-df52-4b0a-9954-117af6b05ab7","format":"uuid","type":"string"}},"PathIssueId20240123":{"description":"Issue ID","in":"path","name":"issue_id","required":true,"schema":{"example":"4a18d42f-0706-4ad0-b127-24078731fbed","format":"uuid","type":"string"}},"PathOrgId":{"description":"Unique identifier for org","in":"path","name":"org_id","required":true,"schema":{"example":"b667f176-df52-4b0a-9954-117af6b05ab7","format":"uuid","type":"string"}},"PersonalAccessTokenId":{"description":"The personal access token id","in":"path","name":"personal_access_token_id","required":true,"schema":{"example":"01HSBP9DKDK39KWZQV84PSPRHY","format":"ulid","type":"string"}},"Platform":{"description":"Filter resources by platform (multi-value, comma-separated): aws","example":"aws","explode":false,"in":"query","name":"platform","schema":{"type":"string"},"style":"form"},"PolicyId":{"description":"Policy ID","in":"path","name":"policy_id","required":true,"schema":{"format":"uuid","type":"string"}},"ProjectId":{"description":"Filter logs by project ID.","example":"0d3728ec-eebf-484d-9907-ba238019f10b","in":"query","name":"project_id","schema":{"format":"uuid","type":"string"}},"QueryNameFilter":{"description":"Only return organizations whose name contains this value. Case insensitive.","in":"query","name":"name","schema":{"type":"string"}},"QuerySlugFilter":{"description":"Only return organizations whose slug exactly matches this value. Case sensitive.","in":"query","name":"slug","schema":{"type":"string"}},"Removed":{"description":"Filter resources by whether they have been removed or not.","example":true,"explode":false,"in":"query","name":"removed","schema":{"type":"boolean"},"style":"form"},"Repository":{"description":"The image repository","in":"query","name":"repository","schema":{"type":"string"}},"ResourceId":{"description":"Filter resources by resource ID (multi-value, comma-separated)","example":"example-bucket","explode":false,"in":"query","name":"resource_id","schema":{"type":"string"},"style":"form"},"ResourceType":{"description":"Filter resources by resource type (multi-value, comma-separated)","example":"aws_s3_bucket","explode":false,"in":"query","name":"resource_type","schema":{"type":"string"},"style":"form"},"Review":{"description":"Policy rule review state e.g. approved","explode":false,"in":"query","name":"review","schema":{"items":{"$ref":"#/components/schemas/PolicyReview"},"type":"array"},"style":"form"},"RoleFilter":{"description":"Filter the response for results only with the specified role.","in":"query","name":"role_name","schema":{"type":"string"}},"RoleId":{"description":"Unique identifier of the role.","in":"path","name":"role_id","required":true,"schema":{"$ref":"#/components/schemas/RoleId"}},"RsqlFilter":{"description":"RSQL filter expression for filtering results. See schema for full documentation.","in":"query","name":"filter","schema":{"$ref":"#/components/schemas/RsqlFilterString"}},"RsqlFilterGroupValues":{"description":"RSQL filter expression for filtering which assets are included in aggregation.\nSupports the same syntax as the main search filter including full text search with the `q` field.\nSee the RsqlFilterString schema for complete documentation.\n","in":"query","name":"filter","schema":{"$ref":"#/components/schemas/RsqlFilterString"}},"ScanId":{"description":"Scan ID","example":"56465b1d-8764-458c-1234-0987abcd6543","in":"path","name":"scan_id","required":true,"schema":{"format":"uuid","type":"string"}},"ScanItemId":{"description":"A scan item id to filter issues through their scan item relationship.","in":"query","name":"scan_item.id","schema":{"example":"4a18d42f-0706-4ad0-b127-24078731fbee","format":"uuid","type":"string"},"style":"form"},"ScanItemType":{"description":"A scan item types to filter issues through their scan item relationship.","in":"query","name":"scan_item.type","schema":{"$ref":"#/components/schemas/ScanItemType"},"style":"form"},"Search":{"description":"Search keyword for searching fields ignored_by.name, ignored_by.email, ignore_type in policy_rules","in":"query","name":"search","schema":{"type":"string"}},"SearchId":{"description":"The unique identifier of the search operation","in":"path","name":"search_id","required":true,"schema":{"format":"uuid","type":"string"}},"Size":{"description":"Number of results to return per page.","example":10,"in":"query","name":"size","schema":{"default":100,"format":"int32","maximum":100,"minimum":1,"multipleOf":1,"type":"integer"}},"SortBy":{"description":"Which column to sort by.","in":"query","name":"sort_by","schema":{"enum":["username","user_display_name","email","login_method","role_name"],"type":"string"}},"SortBy__0":{"description":"Which column to sort by.","in":"query","name":"sort_by","schema":{"enum":["username","user_display_name","email","login_method","role_name"],"type":"string"}},"SortDirection":{"description":"Which direction to sort","in":"query","name":"sort_direction","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}},"SortGroupValues":{"description":"Comma-separated sort fields for group values. Prefix with `-` for descending order.\nMultiple sort fields are supported (e.g., `-issues,count`).\nDefaults to `count` (ascending) when not specified.\nResults are always tie-broken by `value` for deterministic ordering.\n\nAvailable sort fields:\n - `value` - Sort by the group value string (alphabetical)\n - `count` - Sort by the number of assets in each group\n - `last_seen_at` - Sort by the aggregated last_seen_at timestamp\n - `updated_at` - Sort by the aggregated updated_at timestamp\n - `risk_score` - Sort by the aggregated risk score\n - `issues` - Sort by issue severity (critical → high → medium → low)\n","example":"-count","in":"query","name":"sort","schema":{"type":"string"}},"SortOrder":{"description":"Order in which results are returned.","example":"ASC","in":"query","name":"sort_order","schema":{"default":"DESC","enum":["ASC","DESC"],"type":"string"}},"SortOrder__0":{"description":"Order in which results are returned.","example":"ASC","in":"query","name":"sort_order","schema":{"default":"DESC","enum":["ASC","DESC"],"type":"string"}},"SparseFieldsets":{"description":"Sparse fieldsets allow clients to request only specific fields for a given resource type.\nUse the format `fields[\u003ctype\u003e]=field1,field2` where `\u003ctype\u003e` is the JSON:API resource type.\n\n**Container image fields** (use with `fields[container_images]`):\n- `class` - Classification of the asset\n- `registry` - Container registry hostname\n- `repository` - Repository path\n- `config_digest` - Image config digest\n- `distribution_digests` - Distribution digests (manifest/index pairs)\n- `image_tags` - Distinct image tags across all discovery sources\n- `built_at` - When the image was built\n- `size_bytes` - Size of the image in bytes\n- `author` - Image author\n- `architecture` - CPU architecture\n- `os` - Operating system\n- `variant` - CPU architecture variant\n- `os_version` - Operating system version\n- `os_features` - OS features\n- `config` - Image runtime configuration (OCI config)\n- `root_fs` - Root filesystem information\n- `history` - Image build history\n- `inferred_base_images` - Inferred base images\n- `teams` - Teams associated with the asset\n- `labels` - Labels associated with the asset\n- `tags` - Key-value tags for the asset\n- `risk_score` - Risk score for the asset\n- `test_surfaces` - Test surfaces for the asset\n- `issues` - Issue counts by severity\n- `created_at` - When the asset was created\n- `updated_at` - When the asset was last updated\n- `last_scan` - When the asset was last scanned\n- `scan_engines` - Scan engines applied to the asset\n\nNote: `type` and `id` are always included regardless of field selection.\n","example":{"container_images":"registry,repository,config_digest"},"explode":true,"in":"query","name":"fields","schema":{"additionalProperties":{"type":"string"},"type":"object"},"style":"deepObject"},"SsoId":{"description":"The ID of the SSO","in":"path","name":"sso_id","required":true,"schema":{"format":"uuid","type":"string"}},"StartingAfter":{"description":"Return the page of results immediately after this cursor","example":"v1.eyJpZCI6IjEwMDAifQo=","in":"query","name":"starting_after","schema":{"type":"string"}},"StartingAfterCursor":{"description":"Return records after the record identified by cursor position starting_after","in":"query","name":"starting_after","schema":{"type":"string"}},"Status":{"description":"An issue's status","explode":false,"in":"query","name":"status","schema":{"items":{"enum":["open","resolved"],"type":"string"},"type":"array"},"style":"form"},"StatusInQuery":{"description":"Filter environments by latest scan status (multi-value, comma-separated)","example":"error","in":"query","name":"status","schema":{"enum":["queued","in_progress","success","error","null"],"type":"string"}},"Tag":{"description":"The image tag","in":"query","name":"tag","schema":{"type":"string"}},"TenantId":{"description":"Tenant ID","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},"TenantId20240411":{"description":"Unique identifier for tenant","in":"path","name":"tenant_id","required":true,"schema":{"example":"b667f176-df52-4b0a-9954-117af6b05ab7","format":"uuid","type":"string"}},"TenantId__0":{"description":"Unique identifier of the tenant.","in":"path","name":"tenant_id","required":true,"schema":{"$ref":"#/components/schemas/TenantId__0"}},"TestIdParam":{"description":"Test ID returned from the Test API to query.","in":"path","name":"test_id","required":true,"schema":{"format":"uuid","type":"string"}},"Title":{"deprecated":true,"description":"This is deprecated, use Titles instead","in":"query","name":"title","schema":{"type":"string"}},"Titles":{"description":"Filter by the title of the learning path or lesson resource","in":"query","name":"titles","schema":{"$ref":"#/components/schemas/Titles"}},"To":{"description":"The end date (exclusive) of the audit logs search. Dates should be formatted as RFC3339, e.g. 2024-01-02T16:30:00Z.\n","in":"query","name":"to","schema":{"format":"date-time","type":"string"}},"Type":{"description":"An issue type to filter issues.","in":"query","name":"type","schema":{"$ref":"#/components/schemas/TypeDef"},"style":"form"},"UpdatedAfter":{"description":"Return environments updated after this date","example":"2022-05-06T12:25:15-04:00","in":"query","name":"updated_after","schema":{"format":"date-time","type":"string"}},"UpdatedBefore":{"description":"Return environments updated before this date","example":"2022-05-06T12:25:15-04:00","in":"query","name":"updated_before","schema":{"format":"date-time","type":"string"}},"UserId":{"description":"Filter logs by user ID.","example":"0d3728ec-eebf-484d-9907-ba238019f10b","in":"query","name":"user_id","schema":{"format":"uuid","type":"string"}},"UserId20230130":{"description":"The ID of the User","in":"path","name":"user_id","required":true,"schema":{"format":"uuid","type":"string"}},"UserIdFilter":{"description":"Filter the response by Users that match the provided user ID","in":"query","name":"user_id","schema":{"type":"string"}},"UserIdSearchFilter":{"description":"Filter the response by Users that match the provided user ID","in":"query","name":"user_id","schema":{"$ref":"#/components/schemas/UserId"}},"UsernameFilter":{"description":"Filter the response by Users that match the provided username","in":"query","name":"username","schema":{"type":"string"}},"Version":{"description":"The requested version of the endpoint to process the request","example":"2024-10-15","in":"query","name":"version","required":true,"schema":{"$ref":"#/components/schemas/QueryVersion"}},"exportId":{"description":"Unique export identifier","in":"path","name":"export_id","required":true,"schema":{"format":"uuid","type":"string"}},"groupId":{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},"include_deactivated":{"description":"Optional parameter to include disabled issues in results","in":"query","name":"include_deactivated","schema":{"type":"string"}},"include_deleted":{"description":"Optional parameter to include deleted issues in results","in":"query","name":"include_deleted","schema":{"type":"string"}},"io.snyk.api.request.PaginatedRequest.ending_before":{"description":"Opaque pagination cursor for reverse traversal.","explode":false,"in":"query","name":"ending_before","schema":{"type":"string"}},"io.snyk.api.request.PaginatedRequest.limit":{"description":"The number of items to return.","explode":false,"in":"query","name":"limit","schema":{"default":10,"format":"int8","maximum":100,"minimum":1,"type":"integer"}},"io.snyk.api.request.PaginatedRequest.starting_after":{"description":"Opaque pagination cursor for forward traversal.","explode":false,"in":"query","name":"starting_after","schema":{"type":"string"}},"io.snyk.api.request.SnykApiRequest.interaction_id":{"description":"Identifies the Snyk client interaction in which this API request occurs.\n\nThe identifier is an opaque string. though at the time of writing it may either be a\nuuid or a urn containing a uuid and some metadata.","in":"header","name":"snyk-interaction-id","schema":{"maxLength":128,"minLength":36,"type":"string"}},"io.snyk.api.request.SnykApiRequest.request_id":{"description":"A unique ID assigned to each API request, for tracing and troubleshooting.\n\nSnyk clients can optionally provide this ID.","in":"header","name":"snyk-request-id","schema":{"format":"uuid","type":"string"}},"io.snyk.api.request.SnykApiRequest.version":{"description":"The API version requested.","explode":false,"in":"query","name":"version","required":true,"schema":{"type":"string"}},"orgId":{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}},"requestBodies":{"CreateGroupExport":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/ExportGroupAttributes"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"CreateOrgExport":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ExportOrgAttributes"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}}}},"responses":{"204":{"description":"The operation completed successfully with no content","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400__0":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument__0"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"401":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"401__0":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument__0"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"403":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Forbidden: the request requires an authentication token with more or different permissions.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"404__0":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument__0"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"409":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"500":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"500__0":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument__0"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"503":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrence of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Service Unavailable: The server is currently unavailable to handle the request.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"CreateExport":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"description":"export resource object","properties":{"attributes":{"example":{"created":"2022-01-14T00:23:50Z"},"properties":{"created":{"format":"date-time","type":"string"}},"required":["created"],"type":"object"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"links":{"additionalProperties":false,"properties":{"self":{"example":"/orgs/826e79b7-0073-44c3-a5ea-e0aa8a3dbf38/export/jobs/4d593250-aaf3-48ec-bf5a-1d9a7c0f80db","format":"uri","type":"string"}},"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"}},"type":"object"}}},"description":"Created an Export successfully","headers":{"content-location":{"$ref":"#/components/headers/LocationHeader"},"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"retry-after":{"description":"A header providing guidance on how long to wait before retrying the request\n","schema":{"example":"10","format":"number","type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"GetExport":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"description":"export resource object","properties":{"attributes":{"additionalProperties":false,"properties":{"created":{"format":"date-time","type":"string"},"finished":{"format":"date-time","type":"string"},"formats":{"items":{"enum":["csv"],"type":"string"},"type":"array"},"introduced_date_range":{"properties":{"from":{"format":"date-time","type":"string"},"to":{"format":"date-time","type":"string"}},"type":"object"},"results":{"items":{"type":"object"},"type":"array"},"row_count":{"type":"integer"},"status":{"enum":["PENDING","FINISHED","ERRORED"],"type":"string"},"updated_date_range":{"properties":{"from":{"format":"date-time","type":"string"},"to":{"format":"date-time","type":"string"}},"type":"object"}},"required":["status","row_count"],"type":"object"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"properties":{"self":{"example":"/orgs/826e79b7-0073-44c3-a5ea-e0aa8a3dbf38/export/4d593250-aaf3-48ec-bf5a-1d9a7c0f80db","format":"uri","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Getting an export job results","headers":{"content-location":{"$ref":"#/components/headers/LocationHeader"},"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"GetExportJob":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"description":"export resource object","properties":{"attributes":{"additionalProperties":false,"properties":{"created":{"format":"date-time","type":"string"},"formats":{"items":{"enum":["csv"],"type":"string"},"type":"array"},"status":{"enum":["PENDING","FINISHED","ERRORED","STARTED"],"type":"string"}},"required":["status"],"type":"object"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"properties":{"self":{"example":"/orgs/826e79b7-0073-44c3-a5ea-e0aa8a3dbf38/export/4d593250-aaf3-48ec-bf5a-1d9a7c0f80db","format":"uri","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Getting an export job status","headers":{"content-location":{"$ref":"#/components/headers/LocationHeader"},"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"GetIssue20020240123":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Issue"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["jsonapi","data"]}}},"description":"Returns an instance of an issue","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader__0"},"location":{"description":"A header providing a URL for the location of a resource\n","example":"https://example.com/resource/4","schema":{"format":"uri","type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader__0"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader__0"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader__0"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader__0"},"sunset":{"$ref":"#/components/headers/SunsetHeader__0"}}},"ListIssues200":{"content":{"application/vnd.api+json":{"examples":{"Cloud":{"$ref":"#/components/examples/CloudListIssuesResponse"},"Code":{"$ref":"#/components/examples/CodeListIssuesResponse20240123"},"IaC":{"$ref":"#/components/examples/IaCListIssuesResponse20240123"},"OpenSource":{"$ref":"#/components/examples/OpenSourceListIssuesResponse20240123"}},"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Issue"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["jsonapi","data"]}}},"description":"Returns a collection of issues.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader__0"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader__0"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader__0"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader__0"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader__0"},"sunset":{"$ref":"#/components/headers/SunsetHeader__0"}}},"TooManyRequests":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Too many requests","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"retry-after":{"$ref":"#/components/headers/RetryAfter"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}}},"schemas":{"AccessRequest":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AccessRequestAttributes"},"id":{"description":"The Snyk ID of the access request.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id","attributes"],"type":"object"},"AccessRequestAttributes":{"additionalProperties":false,"properties":{"status":{"enum":["pending","expired"],"type":"string"}},"required":["status"],"type":"object"},"AccessTokenTtlSeconds":{"description":"The access token time to live for your app, in seconds. It only affects the newly generated access tokens, existing access token will continue to have their previous time to live as expiration.","example":3600,"maximum":86400,"minimum":3600,"type":"number"},"AcrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["acr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"ActualVersion":{"description":"Resolved API version","example":"2024-10-15","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"},"AiBomAttributes":{"additionalProperties":true,"description":"The AI-Bom document","type":"object"},"AllAppRiskAttributes":{"allOf":[{"$ref":"#/components/schemas/CheckmarxAttributes"},{"$ref":"#/components/schemas/SonarqubeAttributes"}]},"AppBot":{"additionalProperties":false,"properties":{"attributes":{"type":"object"},"id":{"$ref":"#/components/schemas/Id"},"links":{"$ref":"#/components/schemas/Links"},"relationships":{"properties":{"app":{"properties":{"data":{"$ref":"#/components/schemas/PublicApp"}},"type":"object"}},"required":["app"],"type":"object"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","relationships"],"type":"object"},"AppData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AppResourceAttributes"},"id":{"$ref":"#/components/schemas/Id"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppData20220311":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AppResourceAttributes20220311"},"id":{"$ref":"#/components/schemas/Id"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppDataWithSecret":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AppResourceAttributesWithSecret"},"id":{"$ref":"#/components/schemas/Id"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppDataWithSecret20220311":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AppResourceAttributesWithSecret20220311"},"id":{"$ref":"#/components/schemas/Id"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppInstallData":{"additionalProperties":false,"properties":{"attributes":{"properties":{"client_id":{"$ref":"#/components/schemas/ClientId"},"installed_at":{"$ref":"#/components/schemas/InstalledAt"}},"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"links":{"$ref":"#/components/schemas/Links"},"relationships":{"properties":{"app":{"properties":{"data":{"$ref":"#/components/schemas/PublicAppData"}},"type":"object"}},"type":"object"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppInstallDataWithSecret":{"additionalProperties":false,"properties":{"attributes":{"properties":{"client_id":{"$ref":"#/components/schemas/ClientId"},"client_secret":{"$ref":"#/components/schemas/ClientSecret20240523"},"installed_at":{"$ref":"#/components/schemas/InstalledAt"}},"required":["client_id","client_secret"],"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"links":{"$ref":"#/components/schemas/Links"},"relationships":{"properties":{"app":{"properties":{"data":{"$ref":"#/components/schemas/PublicAppData"}},"type":"object"}},"type":"object"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"AppInstallWithClient":{"additionalProperties":false,"properties":{"attributes":{"properties":{"client_id":{"format":"uuid","type":"string"},"client_secret":{"type":"string"}},"required":["client_id","client_secret"],"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"links":{"$ref":"#/components/schemas/Links"},"relationships":{"properties":{"app":{"properties":{"data":{"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/Uuid"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id"],"type":"object"}},"type":"object"}},"type":"object"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes","relationships"],"type":"object"},"AppInstance":{"additionalProperties":false,"properties":{"default_org_context":{"description":"ID of the default org for the service account.","format":"uuid","type":"string"},"name":{"description":"The name of the service account.","example":"user","type":"string"}},"required":["name"],"type":"object"},"AppName":{"description":"New name of the app to display to users during authorization flow.","example":"My App","minLength":1,"type":"string"},"AppPatchRequest":{"properties":{"data":{"properties":{"attributes":{"additionalProperties":false,"minProperties":1,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"name":{"$ref":"#/components/schemas/AppName"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"}},"type":"object"},"type":{"enum":["app"],"type":"string"}},"type":"object"}},"required":["data"],"type":"object"},"AppPatchRequest20220311":{"additionalProperties":false,"minProperties":1,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"name":{"$ref":"#/components/schemas/AppName"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"}},"type":"object"},"AppPostRequest":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"context":{"$ref":"#/components/schemas/Context__0"},"name":{"$ref":"#/components/schemas/AppName"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["name","redirect_uris","scopes","context"],"type":"object"},"type":{"enum":["app"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"},"AppPostRequest20220311":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"context":{"$ref":"#/components/schemas/Context"},"name":{"$ref":"#/components/schemas/AppName"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["name","redirect_uris","scopes"],"type":"object"},"AppPostResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppDataWithSecret"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"},"AppPostResponse20220311":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppDataWithSecret20220311"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"},"AppResourceAttributes":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"client_id":{"$ref":"#/components/schemas/ClientId__0"},"context":{"$ref":"#/components/schemas/Context__0"},"grant_type":{"$ref":"#/components/schemas/GrantType"},"is_confidential":{"$ref":"#/components/schemas/IsConfidential"},"is_public":{"$ref":"#/components/schemas/IsPublic"},"name":{"$ref":"#/components/schemas/AppName"},"org_public_id":{"$ref":"#/components/schemas/Uuid"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["name","scopes","access_token_ttl_seconds","is_public","is_confidential","context","grant_type"],"type":"object"},"AppResourceAttributes20220311":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"client_id":{"$ref":"#/components/schemas/ClientId__1"},"context":{"$ref":"#/components/schemas/Context"},"grant_type":{"$ref":"#/components/schemas/GrantType20220311"},"is_confidential":{"$ref":"#/components/schemas/IsConfidential20220311"},"is_public":{"$ref":"#/components/schemas/IsPublic"},"name":{"$ref":"#/components/schemas/AppName"},"org_public_id":{"$ref":"#/components/schemas/Uuid"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUrisNoMin"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["client_id","name","redirect_uris","scopes","access_token_ttl_seconds","is_public","is_confidential","context","grant_type"],"type":"object"},"AppResourceAttributesWithSecret":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"client_id":{"$ref":"#/components/schemas/ClientId__0"},"client_secret":{"$ref":"#/components/schemas/ClientSecret"},"context":{"$ref":"#/components/schemas/Context__0"},"grant_type":{"$ref":"#/components/schemas/GrantType"},"is_confidential":{"$ref":"#/components/schemas/IsConfidential"},"is_public":{"$ref":"#/components/schemas/IsPublic"},"name":{"$ref":"#/components/schemas/AppName"},"org_public_id":{"$ref":"#/components/schemas/Uuid"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["client_id","name","redirect_uris","scopes","access_token_ttl_seconds","is_public","is_confidential","client_secret","context","grant_type"],"type":"object"},"AppResourceAttributesWithSecret20220311":{"additionalProperties":false,"properties":{"access_token_ttl_seconds":{"$ref":"#/components/schemas/AccessTokenTtlSeconds"},"client_id":{"$ref":"#/components/schemas/ClientId__1"},"client_secret":{"$ref":"#/components/schemas/ClientSecret"},"context":{"$ref":"#/components/schemas/Context"},"grant_type":{"$ref":"#/components/schemas/GrantType20220311"},"is_confidential":{"$ref":"#/components/schemas/IsConfidential20220311"},"is_public":{"$ref":"#/components/schemas/IsPublic"},"name":{"$ref":"#/components/schemas/AppName"},"org_public_id":{"$ref":"#/components/schemas/Uuid"},"redirect_uris":{"$ref":"#/components/schemas/RedirectUris"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["client_id","name","redirect_uris","scopes","access_token_ttl_seconds","is_public","is_confidential","client_secret","context","grant_type"],"type":"object"},"AppRiskAttributes":{"properties":{"required":{"oneOf":[{"$ref":"#/components/schemas/CheckmarxAttributes"},{"$ref":"#/components/schemas/SonarqubeAttributes"},{"$ref":"#/components/schemas/AllAppRiskAttributes"}],"type":"object"},"type":{"enum":["apprisk"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"AppliedIntegrationRelationship":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"description":"Associated item id","type":"string"},"org_id":{"description":"Associated org id","type":"string"},"type":{"description":"Associated item type","type":"string"}},"required":["id","org_id","type"],"type":"object"}},"required":["data"],"type":"object"},"AppliedIntegrationsRelationships":{"additionalProperties":true,"properties":{"applied_integrations":{"items":{"$ref":"#/components/schemas/AppliedIntegrationRelationship"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["applied_integrations"],"type":"object"},"Architecture":{"description":"CPU architecture for container images (Go GOARCH conventions)","enum":["386","amd64","arm","arm64","loong64","mips","mips64","mips64le","mipsle","ppc64","ppc64le","riscv64","s390x","wasm","other"],"type":"string"},"ArtifactoryAttributes":{"properties":{"required":{"properties":{"artifactory_url":{"format":"uuid","type":"string"}},"required":["artifactory_url"],"type":"object"},"type":{"enum":["artifactory"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"ArtifactoryCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["artifactory-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"AssetAttributes":{"properties":{"app_context":{"description":"asset metadata from App Context integrations","nullable":true,"type":"object"},"archived":{"description":"Indicates if the asset is archived","type":"boolean"},"base_image":{"description":"Base image of the container image","nullable":true,"type":"string"},"browse_url":{"description":"URL to browse the asset","format":"uri","nullable":true,"type":"string"},"class":{"$ref":"#/components/schemas/AssetClassAttributes"},"coverage_controls":{"items":{"$ref":"#/components/schemas/CoverageControlAttributes"},"type":"array"},"created_at":{"description":"Creation timestamp","format":"date-time","type":"string"},"default_branch_name":{"description":"Default branch name of the repository","example":"main","nullable":true,"type":"string"},"developers":{"description":"List of developers associated with the asset","items":{"$ref":"#/components/schemas/DeveloperAttributes"},"type":"array"},"file_path":{"description":"File path of the asset","nullable":true,"type":"string"},"image_digests":{"description":"List of digests for the container image","items":{"type":"string"},"nullable":true,"type":"array"},"image_id":{"description":"ID of the container image","nullable":true,"type":"string"},"image_registries":{"description":"List of registries containing the container image","items":{"type":"string"},"nullable":true,"type":"array"},"image_repositories":{"description":"List of repositories containing the container image","items":{"type":"string"},"nullable":true,"type":"array"},"image_tags":{"description":"List of tags for the container image","items":{"type":"string"},"nullable":true,"type":"array"},"languages":{"additionalProperties":{"type":"integer"},"description":"Languages used in the asset with usage counts","nullable":true,"type":"object"},"name":{"description":"Name of the asset of the file path","nullable":true,"type":"string"},"repository_freshness":{"description":"Indicating the activity level of the repository","format":"byte","nullable":true,"type":"string"},"repository_url":{"description":"URL to the asset's repository","nullable":true,"type":"string"},"risk_factors":{"description":"Runtime context that indicates increased asset risk","items":{"type":"string"},"type":"array"},"sources":{"description":"List of source identifiers for the asset","items":{"type":"string"},"type":"array"},"tags":{"description":"Tags associated with the asset","items":{"type":"string"},"type":"array"},"updated_at":{"description":"Last update timestamp","format":"date-time","type":"string"}},"type":"object"},"AssetBaseAttributes":{"description":"Asset-level fields shared across all asset types.","properties":{"class":{"$ref":"#/components/schemas/ClassResponse"},"created_at":{"description":"When the asset was created","format":"date-time","type":"string"},"issues":{"$ref":"#/components/schemas/IssueCounts"},"labels":{"description":"Labels associated with the asset","items":{"maxLength":40,"type":"string"},"maxItems":50,"type":"array"},"last_scan":{"format":"date-time","type":"string"},"last_seen_at":{"description":"When the asset was last seen (i.e., confirmed to exist) via any discovery source.\nUpdated on every upsert operation.\n","format":"date-time","type":"string"},"risk_score":{"description":"Risk score for the asset","format":"int32","type":"integer"},"scan_engines":{"description":"Scan engines applied to the asset","items":{"$ref":"#/components/schemas/ScanEngine"},"maxItems":50,"type":"array"},"tags":{"additionalProperties":{"maxLength":40,"type":"string"},"description":"Key-value tags for the asset","maxProperties":100,"type":"object"},"teams":{"description":"Teams associated with the asset","items":{"maxLength":64,"type":"string"},"maxItems":20,"type":"array"},"test_surfaces":{"description":"Test surfaces for the asset","items":{"type":"string"},"maxItems":100,"type":"array"},"updated_at":{"description":"When the asset was last updated","format":"date-time","type":"string"}},"type":"object"},"AssetBulkPatchRequestBody":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/AssetPatchData"},"maxItems":100,"minItems":1,"type":"array"}},"required":["data"],"type":"object"},"AssetClassAttributes":{"example":{"locked":true,"name":"A","rank":1},"properties":{"locked":{"description":"Whether the asset class is locked","type":"boolean"},"name":{"description":"class name of the asset","type":"string"},"rank":{"description":"Rank associated with the asset class","type":"integer"}},"type":"object"},"AssetListResponse":{"additionalProperties":false,"properties":{"data":{"description":"Polymorphic array of asset objects of different types","items":{"$ref":"#/components/schemas/PolymorphicAssetData"},"type":"array"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"meta":{"description":"Metadata about the response","properties":{"count":{"description":"Total number of assets matching the query","type":"integer"}},"type":"object"}},"type":"object"},"AssetPatchAttributes":{"additionalProperties":false,"description":"Attributes that can be updated via PATCH.\nAt least one attribute must be provided.\nLabels and tags support add/remove operations for atomic modifications.\n","properties":{"class":{"additionalProperties":false,"anyOf":[{"required":["display_name"]},{"required":["rank"]}],"description":"Asset classification for input. Either display_name or rank must be provided.","properties":{"display_name":{"enum":["A","B","C","D"],"type":"string"},"locked":{"type":"boolean"},"rank":{"enum":[1,2,3,4],"type":"integer"}},"type":"object"},"labels":{"oneOf":[{"$ref":"#/components/schemas/LabelsUpdate"},{"$ref":"#/components/schemas/LabelsReplace"}]},"tags":{"oneOf":[{"$ref":"#/components/schemas/TagsUpdate"},{"$ref":"#/components/schemas/TagsReplace"}]}},"type":"object"},"AssetPatchData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/AssetPatchAttributes"},"id":{"description":"The unique identifier of the asset","format":"uuid","type":"string"},"type":{"description":"The JSON:API resource type","enum":["container_images"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"AssetPatchRequestBody":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AssetPatchData"}},"required":["data"],"type":"object"},"AssetProjectAttributes":{"properties":{"issues_counts":{"properties":{"critical":{"type":"number"},"high":{"type":"number"},"low":{"type":"number"},"medium":{"type":"number"}},"type":"object"},"last_scan":{"type":"string"},"name":{"type":"string"},"organization_id":{"type":"string"},"organization_name":{"type":"string"},"project_type":{"type":"string"},"target_file":{"type":"string"},"target_id":{"type":"string"},"target_reference":{"type":"string"},"test_surface":{"type":"string"},"url":{"type":"string"}},"type":"object"},"AssetProjectResponseData":{"description":"asset project resource object","properties":{"attributes":{"$ref":"#/components/schemas/AssetProjectAttributes"},"id":{"format":"uuid","type":"string"},"type":{"enum":["project"],"example":"project","type":"string"}},"required":["id","type"],"type":"object"},"AssetRelationships":{"properties":{"assets":{"properties":{"links":{"properties":{"related":{"type":"string"}},"type":"object"}},"type":"object"},"organizations":{"description":"Snyk Organizations with Projects that map to this asset","nullable":true,"properties":{"data":{"items":{"properties":{"attributes":{"properties":{"name":{"nullable":true,"type":"string"}},"type":"object"},"id":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"projects":{"properties":{"links":{"properties":{"related":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"AssetResponseData":{"description":"asset resource object","properties":{"attributes":{"$ref":"#/components/schemas/AssetAttributes"},"id":{"format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/AssetRelationships"},"removed":{"type":"boolean"},"type":{"enum":["repository","image","package"],"example":"repository","type":"string"}},"required":["id","type"],"type":"object"},"AssignableByMe":{"example":false,"type":"boolean"},"AssignmentCreationAttributes":{"properties":{"learning_path_ids":{"description":"Optional array of learning path IDs for tracking and metadata purposes only.\n\n**Important:** This field does NOT automatically expand learning paths into lessons. \nYou must explicitly provide all lesson IDs in the **lesson_ids** field.\n\nUse this field to record which learning paths these lessons belong to for reporting \nand analytics purposes.\n","example":["30526dd7-efbd-4254-a963-3e6383c6ebdc"],"items":{"type":"string"},"type":"array"},"lesson_ids":{"description":"Array of lesson IDs to assign. Must contain at least one lesson ID.\n\n**To assign all lessons from a learning path:**\n1. Call [List Snyk Learn's resources](#operation/listLearnCatalog) (GET /rest/learn/catalog)\n2. Find the learning path in the response data array\n3. Extract the **lesson_ids** array from the learning path's **attributes**\n4. Pass those lesson IDs to this field\n","example":["215947a8-d678-50aa-56e0-270c983b4c48","12cde434-5fcb-4c9c-92d0-c4040b735a77","83bc3aa6-df84-478c-8b46-f8499a60129f","eb44604a-48e2-49af-d86b-8ddc2ead52b0","2bcea8ed-fb48-4563-9c1a-10e37bbf70c6","af794526-aa3b-476b-9d20-6806ea87f0b6","f654aed0-4c94-4e83-791f-6d39630ce0ed","7ebd499c-973e-4ec0-4d93-07dbe68a9d9b","cd0b4c2b-b6c9-4c04-f3dd-4094a2819b36","ab3f6f4c-3a45-4388-32b0-5f97e24d46b6"],"items":{"type":"string"},"minItems":1,"type":"array"},"user_ids":{"description":"Array of user IDs (UUIDs) to assign lessons to. Must contain at least one user ID.","example":["00000000-0000-0000-0000-000000000001"],"items":{"format":"uuid","type":"string"},"minItems":1,"type":"array"}},"required":["user_ids","lesson_ids"],"type":"object"},"AssignmentCreationResource":{"properties":{"attributes":{"$ref":"#/components/schemas/AssignmentCreationAttributes"},"type":{"enum":["lesson_assignment"],"type":"string"}},"required":["type","attributes"],"type":"object"},"AuditLogSearch":{"properties":{"items":{"items":{"properties":{"content":{"type":"object"},"created":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"},"event":{"example":"org.create","type":"string"},"group_id":{"example":"0d3728ec-eebf-484d-9907-ba238019f10b","type":"string"},"org_id":{"example":"0d3728ec-eebf-484d-9907-ba238019f10b","type":"string"},"project_id":{"example":"0d3728ec-eebf-484d-9907-ba238019f10b","type":"string"}},"required":["created","event"],"type":"object"},"type":"array"},"type":{"type":"string"}},"type":"object"},"AutoDependencyUpgradeSettings20240531":{"additionalProperties":false,"description":"Automatically create pull requests on recurring tests for dependencies as upgrades become available. If not specified, settings will be inherited from the Organization's integration.","properties":{"ignored_dependencies":{"description":"Dependencies which should NOT be included in an automatic upgrade operation.","example":["typescript"],"items":{"type":"string"},"type":"array"},"is_enabled":{"description":"Automatically raise pull requests to update out-of-date dependencies.","example":true,"type":"boolean"},"is_inherited":{"description":"Apply the auto dependency integration settings of the Organization to this project.","example":true,"type":"boolean"},"is_major_upgrade_enabled":{"description":"Include major version in dependency upgrade recommendation.","example":true,"type":"boolean"},"limit":{"description":"Limit of dependency upgrade PRs which can be opened simultaneously. When the limit is reached, no new upgrade PRs are created. If specified, must be between 1 and 10.","example":10,"maximum":10,"minimum":1,"type":"number"},"minimum_age":{"description":"Minimum dependency maturity period in days. If specified, must be between 1 and 365.","example":365,"type":"number"}},"type":"object"},"AutoRemediationPRsSettings20240531":{"additionalProperties":false,"description":"Automatically raise pull requests on recurring tests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Organization's integration.","properties":{"is_backlog_prs_enabled":{"description":"Automatically create pull requests on scheduled tests for known (backlog) vulnerabilities.","example":true,"type":"boolean"},"is_fresh_prs_enabled":{"description":"Automatically create pull requests on scheduled tests for new vulnerabilities.","example":true,"type":"boolean"},"is_patch_remediation_enabled":{"description":"Include vulnerability patches in automatic pull requests.","example":true,"type":"boolean"}},"type":"object"},"AwsOptions":{"additionalProperties":false,"description":"Options for creating an AWS environment","example":{"role_arn":"arn:aws:iam::12345678910:role/SnykCloud1234"},"properties":{"role_arn":{"description":"AWS IAM role ARN for Snyk","example":"arn:aws:iam::12345678910:role/SnykCloud1234","type":"string"}},"required":["role_arn"],"type":"object"},"AzureOptions":{"description":"Options for generating an Azure environment permissions script","example":{"subscription_id":"6884d000-8dd4-11ed-a1eb-0242ac120002","tenant_id":"51627f08-8dd4-11ed-a1eb-0242ac120002"},"properties":{"subscription_id":{"description":"ID of the Azure subscription to be scanned","example":"6884d000-8dd4-11ed-a1eb-0242ac120002","type":"string"},"tenant_id":{"description":"Azure Tenant (directory) ID","example":"51627f08-8dd4-11ed-a1eb-0242ac120002","type":"string"}},"required":["tenant_id","subscription_id"],"type":"object"},"AzureOptions__0":{"additionalProperties":false,"description":"Options for creating an Azure environment","example":{"application_id":"1234d000-8dd4-11ed-a1eb-5678ac120002","subscription_id":"6884d000-8dd4-11ed-a1eb-0242ac120002","tenant_id":"51627f08-8dd4-11ed-a1eb-0242ac120002"},"properties":{"application_id":{"description":"ID of the Azure app registration with permissions to scan","example":"1234d000-8dd4-11ed-a1eb-5678ac120002","type":"string"},"subscription_id":{"description":"ID of the Azure subscription to be scanned","example":"6884d000-8dd4-11ed-a1eb-0242ac120002","type":"string"},"tenant_id":{"description":"Azure Tenant (directory) ID","example":"51627f08-8dd4-11ed-a1eb-0242ac120002","type":"string"}},"required":["tenant_id","subscription_id"],"type":"object"},"AzureReposAttributes":{"properties":{"required":{"properties":{"azure_repos_host":{"example":"my-azure-repos-host/tfs","type":"string"},"azure_repos_org":{"example":"\u003cusername\u003e:\u003cpassword\u003e@\u003cyourdomain.artifactory.com\u003e/artifactory","type":"string"},"azure_repos_token":{"format":"uuid","type":"string"},"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"}},"required":["azure_repos_host","azure_repos_org","azure_repos_token","broker_client_url"],"type":"object"},"type":{"enum":["azure-repos"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"BaseFilters":{"properties":{"cve":{"description":"CVE identifier(s) to filter by (e.g. CVE-2024-1234). Rows whose cve is in this list are included.","items":{"type":"string"},"type":"array"},"empty_project_tags":{"enum":["include","exclude","only"],"type":"string"},"environment":{"items":{"type":"string"},"type":"array"},"introduced":{"properties":{"from":{"format":"date-time","type":"string"},"to":{"format":"date-time","type":"string"}},"type":"object"},"issue_status":{"items":{"type":"string"},"type":"array"},"issue_type":{"items":{"type":"string"},"type":"array"},"lifecycle":{"items":{"type":"string"},"type":"array"},"nvd_severity":{"items":{"type":"string"},"type":"array"},"product_name":{"items":{"type":"string"},"type":"array"},"project_origin":{"items":{"type":"string"},"type":"array"},"project_tags":{"items":{"type":"string"},"type":"array"},"project_target_display_name":{"items":{"type":"string"},"type":"array"},"project_target_ref":{"items":{"type":"string"},"type":"array"},"project_type":{"items":{"type":"string"},"type":"array"},"reachability":{"items":{"type":"string"},"type":"array"},"updated":{"properties":{"from":{"format":"date-time","type":"string"},"to":{"format":"date-time","type":"string"}},"type":"object"}},"type":"object"},"BaseImageRemediation":{"description":"Base image upgrade recommendation data from container scanning","properties":{"base_image":{"$ref":"#/components/schemas/ImageInfo"},"base_image_name":{"description":"The name of the current base image","type":"string"},"base_image_outdated":{"description":"Whether the current base image is outdated","type":"boolean"},"code":{"description":"Remediation code identifying the type of recommendation","type":"string"},"distro_alert":{"description":"Alert message about the base image distribution","type":"string"},"proposed_base_images":{"$ref":"#/components/schemas/ProposedBaseImages"}},"required":["code","base_image_name"],"type":"object"},"BasePackageAttributes":{"description":"Common attributes shared between package and package version resources","properties":{"description":{"description":"Package description from the registry (max 255 characters)","example":"Fast, unopinionated, minimalist web framework","type":"string"},"ecosystem":{"description":"The package ecosystem","enum":["npm","pypi","maven","nuget","golang"],"example":"npm","type":"string"},"keywords":{"description":"Searchable terms defined by the package maintainer in the registry (e.g., in package.json for npm). Used for package discovery (max 20 keywords).","example":["node","javascript","express","server"],"items":{"type":"string"},"type":"array"},"language":{"description":"Primary programming language of the package","example":"JavaScript","type":"string"},"owner_details":{"$ref":"#/components/schemas/OwnerDetails"},"package_health":{"$ref":"#/components/schemas/PackageHealth"},"package_id":{"description":"Package identifier in PURL format","example":"pkg:npm/express","type":"string"},"package_name":{"description":"Name of the package","example":"express","type":"string"}},"required":["package_id","ecosystem","package_name","language"],"type":"object"},"BaseResource":{"description":"BaseResources contain a single instance of testable content.","example":{"resource":{"content_type":"source","file_patterns":[],"repository_url":"https://github.com/example/repo","revision_id":"00000000-0000-0000-0000-000000000000","root_folder_id":".","type":"upload"},"type":"base"},"properties":{"resource":{"allOf":[{"$ref":"#/components/schemas/BaseResourceVariant"}],"description":"The specific representation of what content to test."},"type":{"enum":["base"],"type":"string"}},"required":["type","resource"],"type":"object"},"BaseResourceCreateItem":{"description":"BaseResources contain a single instance of testable content.","example":{"resource":{"content_type":"source","file_patterns":[],"repository_url":"https://github.com/example/repo","revision_id":"00000000-0000-0000-0000-000000000000","root_folder_id":".","type":"upload"},"type":"base"},"properties":{"resource":{"allOf":[{"$ref":"#/components/schemas/BaseResourceVariantCreateItem"}],"description":"The specific representation of what content to test."},"type":{"enum":["base"],"type":"string"}},"required":["type","resource"],"type":"object"},"BaseResourceVariant":{"discriminator":{"mapping":{"bundle":"#/components/schemas/BundleResource","container":"#/components/schemas/ContainerRepoResource","inline":"#/components/schemas/InlineResource","scm":"#/components/schemas/ScmResource","snyk_ref":"#/components/schemas/SnykReferenceResource","upload":"#/components/schemas/UploadResource"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InlineResource"},{"$ref":"#/components/schemas/BundleResource"},{"$ref":"#/components/schemas/UploadResource"},{"$ref":"#/components/schemas/ScmResource"},{"$ref":"#/components/schemas/ContainerRepoResource"},{"$ref":"#/components/schemas/SnykReferenceResource"}]},"BaseResourceVariantCreateItem":{"discriminator":{"mapping":{"bundle":"#/components/schemas/BundleResource","container":"#/components/schemas/ContainerRepoResource","inline":"#/components/schemas/InlineResourceCreateItem","scm":"#/components/schemas/ScmResource","snyk_ref":"#/components/schemas/SnykReferenceResource","upload":"#/components/schemas/UploadResource"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/InlineResourceCreateItem"},{"$ref":"#/components/schemas/BundleResource"},{"$ref":"#/components/schemas/UploadResource"},{"$ref":"#/components/schemas/ScmResource"},{"$ref":"#/components/schemas/ContainerRepoResource"},{"$ref":"#/components/schemas/SnykReferenceResource"}]},"BitbucketServer":{"properties":{"bitbucket":{"example":"bitbucket.yourdomain.com","type":"string"},"bitbucket_password":{"format":"uuid","type":"string"},"bitbucket_username":{"example":"\u003cusername\u003e","type":"string"},"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"}},"required":["bitbucket","bitbucket_password","bitbucket_username","broker_client_url"],"type":"object"},"BitbucketServerAttributes":{"properties":{"required":{"oneOf":[{"$ref":"#/components/schemas/BitbucketServer"},{"$ref":"#/components/schemas/BitbucketServerBearerAuth"}]},"type":{"enum":["bitbucket-server"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"BitbucketServerBearerAuth":{"properties":{"bitbucket":{"example":"bitbucket.yourdomain.com","type":"string"},"bitbucket_pat":{"format":"uuid","type":"string"},"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"}},"required":["bitbucket","bitbucket_pat","broker_client_url"],"type":"object"},"BrokerConnectionIntegrationWithContextResource":{"additionalProperties":false,"properties":{"id":{"format":"uuid","readOnly":true,"type":"string"},"relationships":{"$ref":"#/components/schemas/IntegrationRelationships"},"type":{"enum":["broker_context"],"type":"string"}},"required":["relationships","id","type"],"type":"object"},"BrokerConnectionResponseResource":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CommonConnectionResponseAttributes"},"id":{"format":"uuid","readOnly":true,"type":"string"},"relationships":{"items":{"$ref":"#/components/schemas/BrokerContextResource"},"type":"array"},"type":{"enum":["broker_connection"],"type":"string"}},"required":["attributes","id","type"],"type":"object"},"BrokerConnectionSummaryResponseResource":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ConnectionSummaryAttributes"},"id":{"format":"uuid","readOnly":true,"type":"string"},"type":{"enum":["broker_connection"],"type":"string"}},"required":["attributes","id","type"],"type":"object"},"BrokerContextAttributes":{"additionalProperties":false,"properties":{"context":{"additionalProperties":{"type":"string"},"type":"object"}},"required":["context"],"type":"object"},"BrokerContextCreateAttributes":{"additionalProperties":false,"properties":{"connection_id":{"format":"uuid","type":"string"},"context":{"additionalProperties":{"type":"string"},"type":"object"}},"required":["context","connection_id"],"type":"object"},"BrokerContextResource":{"additionalProperties":true,"properties":{"attributes":{"$ref":"#/components/schemas/BrokerContextAttributes"},"id":{"format":"uuid","readOnly":true,"type":"string"},"relationships":{"allOf":[{"$ref":"#/components/schemas/ConnectionRelationships__0"},{"$ref":"#/components/schemas/AppliedIntegrationsRelationships"}]},"type":{"enum":["broker_context"],"type":"string"}},"required":["attributes","id","type"],"type":"object"},"BrokerDeploymentAttributes":{"additionalProperties":false,"properties":{"broker_app_installed_in_org_id":{"description":"Org Id in which the Broker App is installed","format":"uuid","type":"string"},"install_id":{"description":"Associated Install ID","format":"uuid","readOnly":true,"type":"string"},"metadata":{"description":"Metadata information such user/org id or metrics","type":"object"}},"required":["broker_app_installed_in_org_id","metadata"],"type":"object"},"BrokerDeploymentResource":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/BrokerDeploymentAttributes"},"id":{"format":"uuid","readOnly":true,"type":"string"},"type":{"enum":["broker_deployment"],"type":"string"}},"required":["attributes","id","type"],"type":"object"},"BrokerDeploymentUpdateAttributes":{"additionalProperties":false,"properties":{"broker_app_installed_in_org_id":{"description":"Org Id in which the Broker App is installed","format":"uuid","type":"string"},"install_id":{"description":"Associated Install ID","format":"uuid","type":"string"},"metadata":{"description":"Metadata information such user/org id or metrics","type":"object"}},"required":["broker_app_installed_in_org_id","install_id"],"type":"object"},"BrokerDeploymentUpdateResource":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/BrokerDeploymentUpdateAttributes"},"id":{"format":"uuid","readOnly":true,"type":"string"},"type":{"enum":["broker_deployment"],"type":"string"}},"required":["attributes","id","type"],"type":"object"},"BulkMigrationCreateResponse":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"properties":{"status":{"type":"string"}},"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"enum":["broker_migration"],"type":"string"}},"required":["attributes","id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"BulkPackageUrlsRequestBody":{"properties":{"data":{"properties":{"attributes":{"properties":{"purls":{"description":"An array of Package URLs (purl). Supported purl types are apk, cargo, cocoapods, composer, conan, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, and swift. A version for the package is also required.","items":{"type":"string"},"type":"array"}},"required":["purls"],"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"required":["attributes"],"type":"object"}},"required":["data"],"type":"object"},"BundleResource":{"description":"Resource representing Bundles of files created through the\nDeepcode Bundle API.\n\nBundles contain collections of files uploaded by clients to\nSnyk for testing.\n\nBundleResources can be marked either as SBOM or Source to\nindicate the contents of the Bundle.\n\nSBOM BundleResources should provide the following fields:\n- type\n- bundle_id\n- name\n- file_patterns (may be empty)\n\nSource BundleResources should provide the following fields:\n- type\n- bundle_id\n- repository_url\n- root_folder_id\n- file_patterns (may be empty)\n\nCurrently supported scans utilizing BundleResources are:\n- SAST: (1) BundleResource containing Source files.\n- SBOM (SCA): (1) BundleResource containing an SBOM\n- SBOM + Reachability Analysis (SCA): (1) BundleResource containing an SBOM, (1) BundleResource containing Source files.","example":{"bundle_id":"0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef","content_type":"source","file_patterns":[],"repository_url":"https://github.com/example/repo","root_folder_id":".","type":"bundle"},"properties":{"bundle_id":{"description":"The ID returned from the Files Bundle Store API for a given Bundle.\nThe Deepcode Bundle API is not intended for direct public use,\nand will be replaced with the File Upload API in the future.\n\nThese IDs are sha256 digests (32 bytes or 64 hex digits).","example":"0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef","pattern":"^[a-fA-F0-9]{64}$","type":"string"},"content_type":{"description":"Content present in the Bundle.\n\nCurrently only SBOMs and Source files are accepted\ncontent types.","enum":["sbom","source"],"type":"string"},"file_patterns":{"description":"File Patterns to include in the scan. Elements must be less than 256 characters.\n\nCurrently unsupported. Provide an empty list.","items":{"$ref":"#/components/schemas/String256"},"maxItems":20,"type":"array"},"name":{"description":"A name to assign to the SBOM contained in the BundleRevision.\n\nOverrides the filename in the BundleRevision.","maxLength":256,"type":"string"},"repository_url":{"description":"Repository URL at which the Source files are stored.","maxLength":1024,"type":"string"},"root_folder_id":{"description":"Folder inside the BundleRevision at which the Source files are located.","maxLength":1024,"type":"string"},"scm_context":{"$ref":"#/components/schemas/ScmContext"},"type":{"enum":["bundle"],"type":"string"}},"required":["type","bundle_id","content_type","file_patterns"],"type":"object"},"CVSSSource":{"additionalProperties":false,"properties":{"level":{"example":"medium","minLength":1,"type":"string"},"modification_time":{"description":"The time this CVSS data was last updated","format":"date-time","type":"string"},"score":{"example":4.2,"format":"float","type":"number"},"source":{"example":"snyk","minLength":1,"type":"string"},"vector":{"example":"CVSS:4.0/AV:N/AC:H/AT:N/PR:L/UI:A/VC:N/VI:N/VA:N/SC:H/SI:L/SA:L/E:A","minLength":1,"type":"string"},"version":{"example":"4.0","minLength":1,"type":"string"}},"required":["level","source","score","vector","version","modification_time"],"type":"object"},"CatalogProgress":{"properties":{"attributes":{"$ref":"#/components/schemas/CatalogProgressAttributes"},"id":{"format":"uuid","type":"string"},"relationships":{"properties":{"catalog":{"$ref":"#/components/schemas/CatalogRelationship"}},"required":["catalog"],"type":"object"},"type":{"enum":["progress"],"type":"string"}},"required":["id","type","attributes","relationships"],"type":"object"},"CatalogProgressAttributes":{"properties":{"completed_count":{"description":"Percentage of users in the organization who have completed the resource.","maximum":100,"minimum":0,"type":"number"},"in_progress_count":{"description":"Percentage of users in the organization who have started progress on the resource.","maximum":100,"minimum":0,"type":"number"},"todo_count":{"description":"Percentage of users in the organization who have not started progress on the resource.","maximum":100,"minimum":0,"type":"number"},"users_completed_count":{"description":"Number of users in the organization who have completed the resource.","minimum":0,"type":"integer"},"users_in_progress_count":{"description":"Number of users in the organization who are in-progress who have started progress on the resource.","minimum":0,"type":"integer"},"users_todo_count":{"description":"Number of users in the organization who have not started not started progress on the resource.","minimum":0,"type":"integer"}},"required":["todo_count","in_progress_count","completed_count"],"type":"object"},"CatalogProgressResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CatalogProgress"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"},"meta":{"properties":{"total_org_members":{"description":"Total number of organization members for which the progress report is generated","minimum":0,"type":"integer"}},"required":["total_org_members"],"type":"object"}},"required":["jsonapi","links","data"],"type":"object"},"CatalogRelationship":{"properties":{"data":{"properties":{"attributes":{"properties":{"cves":{"items":{"type":"string"},"type":"array"},"cwes":{"items":{"type":"string"},"type":"array"},"slug":{"type":"string"},"title":{"type":"string"}},"required":["title","slug","cwes","cves"],"type":"object"},"id":{"type":"string"},"type":{"enum":["lesson","learning_path"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"links":{"properties":{"self":{"type":"string"}},"required":["self"],"type":"object"}},"required":["links","data"],"type":"object"},"CheckmarxAttributes":{"properties":{"checkmarx":{"example":"checkmarx.customer.com","type":"string"},"checkmarx_password":{"format":"uuid","type":"string"},"checkmarx_username":{"example":"\u003cusername\u003e","type":"string"}},"required":["checkmarx","checkmarx_password","checkmarx_username"],"type":"object"},"Class":{"additionalProperties":false,"example":{"id":"CWE-190","source":"CWE","type":"weakness"},"properties":{"id":{"maxLength":1024,"minLength":1,"type":"string"},"source":{"example":"CWE","maxLength":64,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/ClassTypeDef"},"url":{"description":"An optional URL for this class.","format":"uri","maxLength":4096,"minLength":1,"type":"string"}},"required":["id","type","source"],"type":"object"},"ClassResponse":{"additionalProperties":false,"description":"Asset classification in response","properties":{"display_name":{"enum":["A","B","C","D"],"type":"string"},"locked":{"default":false,"type":"boolean"},"rank":{"enum":[1,2,3,4],"type":"integer"}},"required":["display_name","rank"],"type":"object"},"ClassTypeDef":{"enum":["rule-category","compliance","weakness"],"example":"compliance","type":"string"},"ClientId":{"description":"The OAuth2 client id for the app installation. Only provided for installations of non-interactive Snyk Apps.","example":"941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf","format":"uuid","type":"string"},"ClientId__0":{"description":"The oauth2 client id for the app.","example":"941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf","format":"uuid","type":"string"},"ClientId__1":{"description":"The OAuth2 client id for the app when available. If an app can have multiple OAuth2 clients then this field with return all zeros. This field is not present for such apps in future versions of this api.","example":"941b423a-e0a0-4a33-a7ca-dd9e9e6bd8cf","format":"uuid","type":"string"},"ClientSecret":{"description":"The oauth2 client secret for the app. This is the only time this secret will be returned, store it securely and don’t lose it.","example":"snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht\u003c]S_v1","minLength":1,"type":"string"},"ClientSecret20240523":{"description":"The OAuth2 client secret for the app. This is the only time this secret will be returned, store it securely and don’t lose it. Only provided for installations of non-interactive Snyk Apps.","example":"snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht\u003c]S_v1","minLength":1,"type":"string"},"CollectionAttributes":{"additionalProperties":false,"properties":{"is_generated":{"type":"boolean"},"name":{"description":"User-defined name of the collection","type":"string"}},"required":["name"],"type":"object"},"CollectionMeta":{"additionalProperties":false,"properties":{"issues_critical_count":{"description":"The sum of critical severity issues of the collection's projects","example":10,"type":"number"},"issues_high_count":{"description":"The sum of high severity issues of the collection's projects","example":10,"type":"number"},"issues_low_count":{"description":"The sum of low severity issues of the collection's projects","example":10,"type":"number"},"issues_medium_count":{"description":"The sum of medium severity issues of the collection's projects","example":10,"type":"number"},"projects_count":{"description":"The amount of projects belonging to this collection","example":7,"type":"number"}},"required":["projects_count","issues_critical_count","issues_high_count","issues_medium_count","issues_low_count"],"type":"object"},"CollectionRelationships":{"additionalProperties":false,"properties":{"created_by_user":{"properties":{"data":{"properties":{"id":{"description":"ID of the user that created the collection. Null for auto-collections.","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","nullable":true,"type":"string"},"type":{"enum":["user"]}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"org":{"properties":{"data":{"properties":{"id":{"description":"ID of the org that this collection belongs to","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"enum":["org"]}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"required":["org","created_by_user"],"type":"object"},"CollectionResponse":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CollectionAttributes"},"id":{"format":"uuid","type":"string"},"meta":{"$ref":"#/components/schemas/CollectionMeta"},"relationships":{"$ref":"#/components/schemas/CollectionRelationships"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type","meta","attributes","relationships"],"type":"object"},"CommonConnectionAttributes":{"allOf":[{"$ref":"#/components/schemas/ConnectionAttributes"},{"$ref":"#/components/schemas/ConfigurationAttributes"}]},"CommonConnectionResponseAttributes":{"allOf":[{"$ref":"#/components/schemas/ConnectionAttributes"},{"$ref":"#/components/schemas/ConfigurationResponseAttributes"}]},"CommonIssueModelVThree":{"properties":{"attributes":{"properties":{"coordinates":{"items":{"$ref":"#/components/schemas/Coordinate"},"type":"array"},"created_at":{"example":"2022-06-16T13:51:13Z","format":"date-time","type":"string"},"description":{"description":"A description of the issue in Markdown format","example":"## Overview\\n\\n\\nAffected versions of this package are vulnerable to XML External Entity (XXE) Injection.","type":"string"},"effective_severity_level":{"description":"The type from enumeration of the issue’s severity level. This is usually set from the issue’s producer, but can be overridden by policies.","enum":["info","low","medium","high","critical"],"type":"string"},"problems":{"items":{"$ref":"#/components/schemas/Problem3"},"type":"array"},"severities":{"description":"An array of dictionaries containing all known data related to the vulnerability","items":{"$ref":"#/components/schemas/Severity3"},"type":"array"},"slots":{"$ref":"#/components/schemas/Slots"},"title":{"description":"A human-readable title for this issue.","example":"XML External Entity (XXE) Injection","type":"string"},"type":{"description":"The issue type","example":"package_vulnerability","type":"string"},"updated_at":{"description":"When the vulnerability information was last modified.","example":"2022-06-16T14:00:24.315507Z","format":"date-time","type":"string"}},"type":"object"},"id":{"description":"The Snyk ID of the vulnerability.","example":"SNYK-JAVA-COMFASTERXMLWOODSTOX-2928754","type":"string"},"type":{"description":"The type of the REST resource. Always ‘issue’.","example":"issue","type":"string"}},"type":"object"},"CommunityDetails":{"additionalProperties":false,"description":"Community health signals for the package","properties":{"description":{"description":"Human-readable explanation of the community rating","type":"string"},"has_code_of_conduct_file":{"description":"Whether the repository has a CODE_OF_CONDUCT file","type":"boolean"},"has_contributing_file":{"description":"Whether the repository has a CONTRIBUTING file","type":"boolean"},"has_funding_file":{"description":"Whether the repository has a FUNDING file","type":"boolean"},"has_readme_file":{"description":"Whether the repository has a README file","type":"boolean"},"rating":{"description":"Overall community health level, reflecting how active and engaged the package's community appears to be","enum":["Active","Sustainable","Limited"],"type":"string"},"stargazers_count":{"description":"Number of GitHub stars (\u003e= 0)","minimum":0,"type":"integer"}},"required":["has_code_of_conduct_file","has_contributing_file","has_funding_file","has_readme_file","stargazers_count"],"type":"object"},"ConfigurationAttributes":{"properties":{"configuration":{"discriminator":{"mapping":{"acr":"#/components/schemas/AcrAttributes","apprisk":"#/components/schemas/AppRiskAttributes","artifactory":"#/components/schemas/ArtifactoryAttributes","artifactory-cr":"#/components/schemas/ArtifactoryCrAttributes","azure-repos":"#/components/schemas/AzureReposAttributes","bitbucket-server":"#/components/schemas/BitbucketServerAttributes","digitalocean-cr":"#/components/schemas/DigitalOceanCrAttributes","docker-hub":"#/components/schemas/DockerHubAttributes","ecr":"#/components/schemas/EcrAttributes","gcr":"#/components/schemas/GcrAttributes","github":"#/components/schemas/GitHubAttributes","github-cloud-app":"#/components/schemas/GitHubCloudAppAttributes","github-cr":"#/components/schemas/GithubCrAttributes","github-enterprise":"#/components/schemas/GitHubEnterpriseAttributes","github-server-app":"#/components/schemas/GitHubServerAppAttributes","gitlab":"#/components/schemas/GitLabAttributes","gitlab-cr":"#/components/schemas/GitlabCrAttributes","google-artifact-cr":"#/components/schemas/GoogleArtifactCrAttributes","harbor-cr":"#/components/schemas/HarborCrAttributes","jira":"#/components/schemas/JiraAttributes","nexus":"#/components/schemas/NexusAttributes","nexus-cr":"#/components/schemas/NexusCrAttributes","quay-cr":"#/components/schemas/QuayCrAttributes","workload":"#/components/schemas/WorkloadAttributes"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AppRiskAttributes"},{"$ref":"#/components/schemas/ArtifactoryAttributes"},{"$ref":"#/components/schemas/AzureReposAttributes"},{"$ref":"#/components/schemas/BitbucketServerAttributes"},{"$ref":"#/components/schemas/GitHubAttributes"},{"$ref":"#/components/schemas/GitHubEnterpriseAttributes"},{"$ref":"#/components/schemas/GitHubServerAppAttributes"},{"$ref":"#/components/schemas/GitHubCloudAppAttributes"},{"$ref":"#/components/schemas/GitLabAttributes"},{"$ref":"#/components/schemas/JiraAttributes"},{"$ref":"#/components/schemas/NexusAttributes"},{"$ref":"#/components/schemas/AcrAttributes"},{"$ref":"#/components/schemas/ArtifactoryCrAttributes"},{"$ref":"#/components/schemas/DigitalOceanCrAttributes"},{"$ref":"#/components/schemas/DockerHubAttributes"},{"$ref":"#/components/schemas/EcrAttributes"},{"$ref":"#/components/schemas/GcrAttributes"},{"$ref":"#/components/schemas/GithubCrAttributes"},{"$ref":"#/components/schemas/GitlabCrAttributes"},{"$ref":"#/components/schemas/GoogleArtifactCrAttributes"},{"$ref":"#/components/schemas/HarborCrAttributes"},{"$ref":"#/components/schemas/NexusCrAttributes"},{"$ref":"#/components/schemas/QuayCrAttributes"},{"$ref":"#/components/schemas/WorkloadAttributes"}]}},"required":["configuration"],"type":"object"},"ConfigurationResponseAttributes":{"allOf":[{"$ref":"#/components/schemas/GenericConfigurationAttributes"}]},"ConnectionAttributes":{"properties":{"deployment_id":{"description":"Associated Deployment ID","format":"uuid","type":"string"},"identifier":{"description":"Broker identifier","format":"uuid","type":"string"},"name":{"description":"Associated name","type":"string"},"secrets":{"properties":{"primary":{"$ref":"#/components/schemas/SecretAttributes"},"secondary":{"$ref":"#/components/schemas/SecretAttributes"}},"required":["primary","secondary"],"type":"object"}},"required":["deployment_id","name"],"type":"object"},"ConnectionRelationship":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"description":"Associated item id","type":"string"},"type":{"description":"Associated item type","type":"string"}},"required":["id","type"],"type":"object"}},"required":["data"],"type":"object"},"ConnectionRelationships":{"additionalProperties":false,"properties":{"broker_connections":{"items":{"$ref":"#/components/schemas/ConnectionRelationship"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["broker_connections"],"type":"object"},"ConnectionRelationships__0":{"additionalProperties":true,"properties":{"broker_connections":{"items":{"$ref":"#/components/schemas/ConnectionRelationship"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["broker_connections"],"type":"object"},"ConnectionSummaryAttributes":{"properties":{"connection_type":{"description":"Connection type","type":"string"},"context":{"description":"Broker Context","format":"uuid","type":"string"},"deployment_id":{"description":"Associated Deployment ID","format":"uuid","type":"string"},"name":{"description":"Associated name","type":"string"}},"required":["deployment_id","name","connection_type"],"type":"object"},"ContainerBuildArgs":{"additionalProperties":false,"properties":{"platform":{"type":"string"}},"required":["platform"],"type":"object"},"ContainerImageAttributesResponse":{"allOf":[{"$ref":"#/components/schemas/AssetBaseAttributes"},{"description":"Attributes specific to container image assets.","properties":{"architecture":{"$ref":"#/components/schemas/Architecture"},"author":{"description":"Author of the image","maxLength":256,"type":"string"},"built_at":{"description":"When the image was built","format":"date-time","type":"string"},"config":{"$ref":"#/components/schemas/ImageConfig"},"config_digest":{"description":"Image config digest","maxLength":256,"type":"string"},"distribution_digests":{"description":"Distribution digests (manifest/index pairs)","items":{"$ref":"#/components/schemas/DistributionDigest"},"maxItems":100,"type":"array"},"history":{"description":"Image build history","items":{"$ref":"#/components/schemas/History"},"maxItems":1000,"type":"array"},"image_tags":{"description":"Distinct image tags across all discovery sources","items":{"maxLength":256,"type":"string"},"maxItems":20,"type":"array"},"inferred_base_images":{"description":"Inferred base images","items":{"maxLength":512,"type":"string"},"maxItems":100,"type":"array"},"os":{"$ref":"#/components/schemas/OperatingSystem"},"os_features":{"description":"OS features","items":{"maxLength":256,"type":"string"},"maxItems":100,"type":"array"},"os_version":{"description":"Operating system version","maxLength":256,"type":"string"},"registry":{"description":"Container registry hostname","maxLength":256,"type":"string"},"repository":{"description":"Repository path, e.g. \"library/nginx\"","maxLength":256,"type":"string"},"root_fs":{"$ref":"#/components/schemas/RootFs"},"size_bytes":{"description":"Size of the image in bytes","format":"int64","type":"integer"},"total_image_tags":{"description":"Total count of distinct image tags across all discovery sources","minimum":0,"type":"integer"},"variant":{"description":"Variant of the CPU architecture","maxLength":64,"type":"string"}},"type":"object"}]},"ContainerRegistryImportPolicyAttributes":{"additionalProperties":false,"properties":{"policy":{"$ref":"#/components/schemas/ContainerRegistryPolicy"}},"required":["policy"],"type":"object"},"ContainerRegistryPolicy":{"description":"A policy","properties":{"delete_images":{"description":"Delete images no longer matching the policy. False by default.","type":"boolean"},"import_policy":{"$ref":"#/components/schemas/PolicyComponent"},"name":{"type":"string"},"schedule_frequency_hours":{"description":"The frequency of the import policy in hours.","minimum":2,"type":"integer"}},"required":["name","import_policy"],"type":"object"},"ContainerRepoResource":{"description":"Resource representing a container repository.\n\nContainer Repos identify a specific container\nimage in a container registry. These images can be scanned\nusing the Snyk Container scanner.\n\nCurrently no scans are supported through the Test API for\nContainerRepoResources.","example":{"image_url":"https://docker.io/example/image","tag":"version_0.0.0","type":"container"},"properties":{"image_url":{"description":"URL at which the specific container image can be found\nin a container registry.","format":"url","maxLength":1024,"type":"string"},"scm_context":{"$ref":"#/components/schemas/ScmContext"},"tag":{"description":"Tagged version of the container to scan.","type":"string"},"type":{"enum":["container"],"type":"string"}},"required":["type","image_url","tag"],"type":"object"},"ContainerScanConfiguration":{"description":"Scan configuration parameters for the Container scanner.","type":"object"},"Context":{"description":"Allow installing the app to a org/group or to a user, default tenant.","enum":["tenant","user"],"type":"string"},"Context__0":{"description":"Allow installing the app to at org/group level or user level. Defaults to tenant.","enum":["tenant","user"],"type":"string"},"Coordinate":{"properties":{"remedies":{"items":{"$ref":"#/components/schemas/Remedy3"},"type":"array"},"representations":{"description":"The affected versions of this vulnerability.","items":{"anyOf":[{"$ref":"#/components/schemas/ResourcePathRepresentation"},{"$ref":"#/components/schemas/PackageRepresentation"}]},"type":"array"}},"required":["representations"],"type":"object"},"CoverageControlAttributes":{"example":{"category":"security","gap":true,"issues_count":{"critical":1,"high":2,"low":0,"medium":0},"last_scan":"2023-10-10T08:00:00Z","name":"control1"},"properties":{"category":{"description":"Category of the control","type":"string"},"gap":{"description":"indicates if there is a coverage gap","type":"boolean"},"issues_count":{"$ref":"#/components/schemas/IssuesCountAttributes"},"last_scan":{"description":"Last scan date for this control","format":"date-time","type":"string"},"name":{"description":"Name of the control","type":"string"}},"type":"object"},"CreateAiBomRequestBody":{"properties":{"data":{"$ref":"#/components/schemas/CreateAiBomRequestData"}},"required":["data"],"type":"object"},"CreateAiBomRequestData":{"discriminator":{"mapping":{"ai_bom_file_bundle":"#/components/schemas/FileBundleStoreData","ai_bom_file_upload":"#/components/schemas/FileUploadApiData","ai_bom_scm_bundle":"#/components/schemas/ScmBundleStoreData"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/FileBundleStoreData"},{"$ref":"#/components/schemas/ScmBundleStoreData"},{"$ref":"#/components/schemas/FileUploadApiData"}]},"CreateAiBomResponseBody":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/JobData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"},"CreateAndUploadAiBomFileBundleAttributes":{"properties":{"bundle_id":{"description":"The id of the bundle that has been uploaded by the user, sha256 hash","pattern":"^[0-9a-fA-F]{64}$","type":"string"},"repo_name":{"description":"The name of the repository","maxLength":200,"minLength":1,"type":"string"}},"required":["bundle_id","repo_name"],"type":"object"},"CreateAndUploadAiBomFileBundleData":{"properties":{"attributes":{"$ref":"#/components/schemas/CreateAndUploadAiBomFileBundleAttributes"},"type":{"enum":["ai_bom_file_bundle"],"type":"string"}},"required":["type","attributes"],"type":"object"},"CreateAndUploadAiBomFileUploadAttributes":{"properties":{"repo_name":{"description":"The name of the repository","maxLength":200,"minLength":1,"type":"string"},"upload_revision_id":{"description":"The id of the upload revision the has been created by the user","format":"uuid","type":"string"}},"required":["upload_revision_id","repo_name"],"type":"object"},"CreateAndUploadAiBomFileUploadData":{"properties":{"attributes":{"$ref":"#/components/schemas/CreateAndUploadAiBomFileUploadAttributes"},"type":{"enum":["ai_bom_file_upload"],"type":"string"}},"required":["type","attributes"],"type":"object"},"CreateAndUploadAiBomRequestBody":{"properties":{"data":{"$ref":"#/components/schemas/CreateAndUploadAiBomRequestData"}},"required":["data"],"type":"object"},"CreateAndUploadAiBomRequestData":{"discriminator":{"mapping":{"ai_bom_file_bundle":"#/components/schemas/CreateAndUploadAiBomFileBundleData","ai_bom_file_upload":"#/components/schemas/CreateAndUploadAiBomFileUploadData"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/CreateAndUploadAiBomFileBundleData"},{"$ref":"#/components/schemas/CreateAndUploadAiBomFileUploadData"}]},"CreateAssignmentsPayload":{"properties":{"contact_email":{"description":"Custom contact email to display in email templates when customized_contact_details is true","format":"email","type":"string"},"contact_name":{"description":"Custom contact name to display in email templates when customized_contact_details is true","type":"string"},"customized_contact_details":{"default":false,"description":"Flag to indicate if custom contact details should be used in email templates","type":"boolean"},"data":{"description":"Array of assignment creation objects. Must contain at least one assignment.","items":{"$ref":"#/components/schemas/AssignmentCreationResource"},"minItems":1,"type":"array"},"due_date":{"format":"date","type":"string"},"email_custom_message":{"description":"Custom message given by assignment creator for email notification.","type":"string"},"email_notification":{"description":"Email notification is enabled or not for new assignment creation","type":"boolean"},"email_receive_copy":{"description":"Assigner will receive a copy of the email","type":"boolean"},"reset_learning_progress":{"description":"Global flag to reset progress for all lesson assignments in the request","type":"boolean"},"reset_progress_before":{"description":"Reset progress for all lesson assignments before this date (exclusive)","format":"date","type":"string"}},"required":["data"],"type":"object"},"CreateBrokerConnectionIntegration":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/IntegrationResource"}},"required":["data"],"type":"object"},"CreateBrokerConnectionRequest":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/CommonConnectionAttributes"},"type":{"enum":["broker_connection"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"},"CreateBrokerContextRequest":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/BrokerContextCreateAttributes"},"type":{"enum":["broker_context"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"},"CreateBrokerDeploymentRequest":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/BrokerDeploymentAttributes"}]},"type":{"enum":["broker_deployment"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"},"CreateBulkMigrationRequest":{"additionalProperties":false,"properties":{"data":{"properties":{"type":{"enum":["broker_migration"],"type":"string"}},"required":["type"],"type":"object"}},"required":["data"],"type":"object"},"CreateCollectionRequest":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/name"}},"required":["name"],"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"CreateDeploymentCredentialRequest":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/DeploymentCredentialsAttributes"},"type":{"enum":["deployment_credential"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"},"CreateGroupMembershipRequestBody":{"properties":{"data":{"additionalProperties":false,"properties":{"relationships":{"additionalProperties":false,"properties":{"group":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"example":"8aab168e-fb3b-47c0-9d87-442715788b31","format":"uuid","type":"string"},"type":{"description":"Always \"group\"","enum":["group"],"example":"group","type":"string"}},"type":"object"}},"type":"object"},"role":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"description":"Always \"group_role\"","enum":["group_role"],"example":"group_role","type":"string"}},"type":"object"}},"type":"object"},"user":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"example":"677d5f47-a8bf-4090-ba52-680903e7c8b5","format":"uuid","type":"string"},"type":{"description":"Always \"user\"","enum":["user"],"example":"user","type":"string"}},"type":"object"}},"type":"object"}},"required":["role","user","group"],"type":"object"},"type":{"description":"type of membership according to its entity","enum":["group_membership"],"example":"group_membership","type":"string"}},"type":"object"}},"type":"object"},"CreateGroupPolicyPayload":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/GroupPolicyRequestAttributes"},"type":{"enum":["policy"],"type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"CreateOrgMembershipRequestBody20240825":{"properties":{"data":{"additionalProperties":false,"properties":{"relationships":{"additionalProperties":false,"properties":{"org":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"example":"8aab168e-fb3b-47c0-9d87-442715788b31","format":"uuid","type":"string"},"type":{"description":"Always \"org\"","enum":["org"],"example":"org","type":"string"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"role":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"description":"Always \"org_role\"","enum":["org_role"],"example":"org_role","type":"string"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"user":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"example":"677d5f47-a8bf-4090-ba52-680903e7c8b5","format":"uuid","type":"string"},"type":{"description":"Always \"user\"","enum":["user"],"example":"user","type":"string"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"required":["role","user","org"],"type":"object"},"type":{"description":"type of membership according to its entity","enum":["org_membership"],"example":"org_membership","type":"string"}},"required":["type","relationships"],"type":"object"}},"required":["data"],"type":"object"},"CreatePermissionsAttributes":{"example":{"platform":"aws","type":"cf"},"properties":{"options":{"anyOf":[{"$ref":"#/components/schemas/AzureOptions"}]},"platform":{"$ref":"#/components/schemas/PlatformType"},"type":{"$ref":"#/components/schemas/PermissionType"}},"required":["type","platform"],"type":"object"},"CreatePolicyPayload":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/PolicyAttributes"},"meta":{"$ref":"#/components/schemas/Meta"},"type":{"enum":["policy"],"type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"CreateSearchRequestBody":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"filter":{"$ref":"#/components/schemas/RsqlFilterString"},"limit":{"default":10,"description":"Number of results to return per page","maximum":100,"minimum":10,"type":"integer"},"meta_count":{"description":"Whether to include the total count of results in the response meta object.\nWhen `with` is provided, the count will be included in the response meta object.\nWhen `only` is provided, the count will be included in the response meta object and no data will be returned.\n","enum":["with","only"],"example":"with","type":"string"},"sort":{"description":"Comma-separated sort fields. Prefix with `-` for descending order.\n\n**Supported fields:**\n- `created_at` - Asset creation timestamp\n- `updated_at` - Asset last update timestamp\n- `type` - Asset type (container_images)\n- `class` - Asset class\n- `risk_score` - Asset risk score (max across project sources)\n- `issues` - Issue counts by severity (critical, high, medium, low)\n- `built_at` - Image build timestamp (container images only)\n- `last_scan` - Last scan timestamp\n","example":"-created_at","type":"string"}},"type":"object"},"type":{"enum":["searches"],"type":"string"}},"type":"object"}},"type":"object"},"CreateTenantRoleRequestAttributes":{"additionalProperties":false,"properties":{"description":{"description":"The description of the tenant role.","maxLength":160,"minLength":1,"type":"string"},"name":{"description":"The name of the tenant role.","maxLength":60,"minLength":1,"type":"string"},"permissions":{"description":"Requested permissions of the tenant role. Must be the entire set of permissions.","items":{"type":"string"},"type":"array"}},"required":["name","description","permissions"],"type":"object"},"CreatedAt":{"description":"The time at which the resource was created.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"},"Custom":{"example":false,"type":"boolean"},"CustomBaseImageAttributes":{"additionalProperties":false,"properties":{"include_in_recommendations":{"description":"Whether this image should be recommended as a base image upgrade. \nIf set to true, this image could be shown as a base image upgrade to other projects.\nIf set to false this image will never be recommended as an upgrade.\n","example":true,"type":"boolean"},"project_id":{"description":"The ID of the container project that the custom base image is based off of.\nThe attributes of this custom base image are taken from the latest snapshot at the time of creation.\nThis means that no changes should be made to the original project after the creation of the custom base image,\nas new snapshots created from any changes will NOT be picked up.\n","example":"2cab3939-d112-4ef0-836d-e09c87cbe69b","format":"uuid","type":"string"},"versioning_schema":{"$ref":"#/components/schemas/VersioningSchema"}},"required":["project_id","include_in_recommendations"],"type":"object"},"CustomBaseImageCollectionResponse":{"additionalProperties":false,"properties":{"data":{"items":{"properties":{"attributes":{"$ref":"#/components/schemas/CustomBaseImageSnapshot"},"id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi"],"type":"object"},"CustomBaseImagePatchRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"minProperties":1,"properties":{"include_in_recommendations":{"example":true,"type":"boolean"},"versioning_schema":{"$ref":"#/components/schemas/VersioningSchema"}},"type":"object"},"id":{"description":"The ID of the custom base image that should be updated. (Same one used in the URI)","format":"uuid","type":"string"},"type":{"description":"This should always be \"custom_base_image\"","example":"custom_base_image","type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"CustomBaseImagePostRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CustomBaseImageAttributes"},"type":{"description":"This should always be \"custom_base_image\"","example":"custom_base_image","type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"CustomBaseImageResource":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CustomBaseImageAttributes"},"id":{"example":"2cab3939-d112-4ef0-836d-e09c87cbe69b","format":"uuid","type":"string"},"type":{"example":"custom_base_image","type":"string"}},"required":["id","type","attributes"],"type":"object"},"CustomBaseImageResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/CustomBaseImageResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data","jsonapi"],"type":"object"},"CustomBaseImageSnapshot":{"properties":{"group_id":{"format":"uuid","type":"string"},"include_in_recommendations":{"type":"boolean"},"org_id":{"format":"uuid","type":"string"},"project_id":{"format":"uuid","type":"string"},"repository":{"type":"string"},"tag":{"type":"string"}},"type":"object"},"Cves":{"items":{"pattern":"^(CVE)-\\d+-\\d+(,(CVE)-\\d+-\\d+)*$","type":"string"},"maxItems":50,"minItems":1,"type":"array","uniqueItems":true},"Cwes":{"items":{"pattern":"^CWE-\\d+$","type":"string"},"maxItems":50,"minItems":1,"type":"array","uniqueItems":true},"DateInterval":{"pattern":"^[\\d]{4}-[\\d]{2}-[\\d]{2}/[\\d]{4}-[\\d]{2}-[\\d]{2}$","type":"string"},"DeepcodeBundleSubject":{"description":"**Deprecated**\n\nProvide a BundleResource and include the\nSAST Scan Configuration instead.\n\nTest subject representing source code uploaded to Snyk using DeepCode\nbundle APIs.\n\nDeepcode bundles are accepted through the API, but are not\nguaranteed to return Findings.","properties":{"bundle_id":{"description":"Deepcode Bundle ID. These IDs are sha256 digests (32 bytes or 64 hex digits).","pattern":"^[a-fA-F0-9]{64}$","type":"string"},"locator":{"allOf":[{"$ref":"#/components/schemas/LocalPathLocator"}],"description":"Locate local paths from which the source code bundle was derived."},"type":{"enum":["deepcode_bundle"],"type":"string"}},"required":["type","bundle_id","locator"],"type":"object"},"DeleteAssignmentsRequest":{"properties":{"data":{"items":{"properties":{"id":{"format":"uuid","type":"string"},"type":{"enum":["lesson_assignment"],"type":"string"}},"required":["id","type"],"type":"object"},"type":"array"}},"required":["data"],"type":"object"},"DeleteOrgAssignmentsBulkRequest":{"properties":{"data":{"description":"Array of assignment resource identifiers to delete. Must contain at least one assignment.","items":{"additionalProperties":false,"properties":{"id":{"format":"uuid","type":"string"},"type":{"enum":["lesson_assignment"],"type":"string"}},"required":["id","type"],"type":"object"},"minItems":1,"type":"array"}},"required":["data"],"type":"object"},"DeleteProjectsFromCollectionRequest":{"additionalProperties":false,"properties":{"data":{"description":"IDs of items to remove from a collection","items":{"additionalProperties":false,"properties":{"id":{"format":"uuid","type":"string"},"type":{"description":"Type of the item id","enum":["project"],"type":"string"}},"required":["id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["data"],"type":"object"},"DepGraphContent":{"description":"Dep Graph file contents, of the same format as Dep Graphs\nprovided to /v1/test-dep-graph endpoint.","properties":{"dep_graph":{"$ref":"#/components/schemas/io.snyk.api.v1testdepgraph.request.DepGraph"},"type":{"enum":["dep_graph"],"type":"string"}},"required":["type","dep_graph"],"type":"object"},"DepGraphSubject":{"description":"**Deprecated**\n\nProvide an InlineResource with the DepGraph contents\nand the SCA Scan Configuration instead.\n\nTest subject representing a Snyk dependency graph (a legacy SBOM format).","properties":{"locator":{"allOf":[{"$ref":"#/components/schemas/LocalPathLocator"}],"description":"Source file(s) from which the dependency graph was derived.\n\nFor some managed package ecosystems (examples: Maven, Yarn workspaces),\nSnyk might derive a dependency graph from several files."},"type":{"enum":["dep_graph"],"type":"string"}},"required":["type","locator"],"type":"object"},"DepGraphSubjectCreate":{"description":"**Deprecated**\n\nProvide an InlineResource with the DepGraph contents\nand the SCA Scan Configuration instead.\n\nTest subject representing a Snyk dependency graph (a legacy SBOM format).","properties":{"dep_graph":{"allOf":[{"$ref":"#/components/schemas/io.snyk.api.v1testdepgraph.request.DepGraph"}],"description":"When creating a test, provide the dep-graph contents inline to the request.\n\nThis attribute is only available when creating a new Test."},"locator":{"allOf":[{"$ref":"#/components/schemas/LocalPathLocator"}],"description":"Source file(s) from which the dependency graph was derived.\n\nFor some managed package ecosystems (examples: Maven, Yarn workspaces),\nSnyk might derive a dependency graph from several files."},"type":{"enum":["dep_graph"],"type":"string"}},"required":["type","dep_graph","locator"],"type":"object"},"DependencyCountFact":{"description":"DependencyCountFact represents a dependency count fact.","properties":{"total_dependency_count":{"format":"int64","type":"integer"},"type":{"enum":["dependency_count_fact"],"type":"string"}},"required":["type","total_dependency_count"],"type":"object"},"DependencyPathEvidence":{"description":"Dependency path to a software component within an SBOM dependency graph.\n\nFinding types: SCA","properties":{"path":{"description":"Series of component identifiers starting from the top-level component tested,\nand ending in the vulnerable software component.\n\nThe identifiers are domain-specific and determined by the test subject.","items":{"$ref":"#/components/schemas/Package"},"type":"array"},"source":{"enum":["dependency_path"],"type":"string"}},"required":["source","path"],"type":"object"},"DeployedRiskFactor":{"properties":{"included_in_score":{"default":false,"type":"boolean"},"links":{"$ref":"#/components/schemas/RiskFactorLinks"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"type":"boolean"}},"required":["name","updated_at","value"],"type":"object"},"DeploymentCredentialAttributes":{"additionalProperties":false,"properties":{"comment":{"description":"Optional comment information","type":"string"},"deployment_id":{"description":"Associated Deployment ID","format":"uuid","readOnly":true,"type":"string"},"environment_variable_name":{"type":"string"},"type":{"description":"Associated connection type","type":"string"}},"required":["deployment_id","environment_variable_name","type"],"type":"object"},"DeploymentCredentialResource":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/DeploymentCredentialAttributes"},"id":{"format":"uuid","readOnly":true,"type":"string"},"relationships":{"$ref":"#/components/schemas/ConnectionRelationships"},"type":{"enum":["deployment_credential"],"type":"string"}},"required":["attributes","id","type"],"type":"object"},"DeploymentCredentialsAttributes":{"items":{"$ref":"#/components/schemas/DeploymentCredentialAttributes"},"maxItems":10,"type":"array"},"DeveloperAttributes":{"example":{"discovered_by":"github","email":"john.doe@example.com","url":"https://github.com/johndoe","username":"johndoe"},"properties":{"discovered_by":{"description":"The SCM integration that was discovered by the developer","nullable":true,"type":"string"},"email":{"description":"Email address of the developer","format":"email","nullable":true,"type":"string"},"url":{"description":"URL of the developer's profile","format":"uri","nullable":true,"type":"string"},"username":{"description":"Username of the developer","nullable":true,"type":"string"}},"type":"object"},"Diff":{"description":"Fix suggestions in the unified diff format that introduce code changes\nto remediate the vulnerability.","example":{"format":"diff","suggestions":[{"diff":"--- a/auth.ts\n+++ b/auth.ts\n@@ -1,1 +1,1 @@\n-eval(userInput)\n+safeEval(userInput)\n","external_id":"550e8400-e29b-41d4-a716-446655440000","rank":1},{"diff":"--- a/auth.ts\n+++ b/auth.ts\n@@ -1,1 +1,1 @@\n-password === input\n+bcrypt.compare(input, password)\n","external_id":"550e8400-e29b-41d4-a716-446655440001","rank":2}]},"properties":{"format":{"enum":["diff"],"type":"string"},"suggestions":{"description":"Alternative suggestions - choose one to fix the vulnerability.\nThe 'rank' field signals the relative confidence in each one.","items":{"$ref":"#/components/schemas/DiffSuggestion"},"type":"array"}},"required":["format","suggestions"],"type":"object"},"DiffResource":{"description":"DiffResources contain two versions of the same content\nto compare against each other.\n\nThe Base and Compare fields contain Resources representing\nan \"existing\" (base) version as well as a \"new\" (compare)\nversion. Most commonly these Resources will be of the same type,\ne.g. an ScmResource containing a reference the `main` branch being\ncompared to an ScmResource containing a reference to a new\nfeature branch.\n\nCurrently no scans are supported through the Test API\nfor DiffResources.","example":{"base":{"file_patterns":[],"integration_id":"00000000-0000-0000-0000-000000000000","ref":"main","repo_url":"https://github.com/example/repo","type":"scm"},"compare":{"file_patterns":[],"integration_id":"00000000-0000-0000-0000-000000000000","ref":"feat/homepage","repo_url":"https://github.com/example/repo","type":"scm"},"type":"diff"},"properties":{"base":{"$ref":"#/components/schemas/BaseResourceVariant"},"compare":{"$ref":"#/components/schemas/BaseResourceVariant"},"type":{"enum":["diff"],"type":"string"}},"required":["type","base","compare"],"type":"object"},"DiffResourceCreateItem":{"description":"DiffResources contain two versions of the same content\nto compare against each other.\n\nThe Base and Compare fields contain Resources representing\nan \"existing\" (base) version as well as a \"new\" (compare)\nversion. Most commonly these Resources will be of the same type,\ne.g. an ScmResource containing a reference the `main` branch being\ncompared to an ScmResource containing a reference to a new\nfeature branch.\n\nCurrently no scans are supported through the Test API\nfor DiffResources.","example":{"base":{"file_patterns":[],"integration_id":"00000000-0000-0000-0000-000000000000","ref":"main","repo_url":"https://github.com/example/repo","type":"scm"},"compare":{"file_patterns":[],"integration_id":"00000000-0000-0000-0000-000000000000","ref":"feat/homepage","repo_url":"https://github.com/example/repo","type":"scm"},"type":"diff"},"properties":{"base":{"$ref":"#/components/schemas/BaseResourceVariantCreateItem"},"compare":{"$ref":"#/components/schemas/BaseResourceVariantCreateItem"},"type":{"enum":["diff"],"type":"string"}},"required":["type","base","compare"],"type":"object"},"DiffSuggestion":{"description":"A suggestion in unified diff format representing the code changes to fix the vulnerability.","properties":{"diff":{"description":"Unified diff that contains changes for one or multiple files.\nIt already contains file path, but this can be extracted as a separate field if needed.","maxLength":10485760,"type":"string"},"external_id":{"description":"The fix suggestion identifier from an external source.","format":"uuid","type":"string"},"rank":{"format":"uint8","type":"integer"}},"required":["diff"],"type":"object"},"DigitalOceanCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_token":{"format":"uuid","type":"string"}},"required":["broker_client_url","cr_agent_url","cr_base","cr_token"],"type":"object"},"type":{"enum":["digitalocean-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"DirectVulnerabilitiesCounts":{"additionalProperties":false,"description":"Breakdown of direct vulnerabilities by Snyk severity level","properties":{"critical":{"description":"Number of critical severity vulnerabilities (\u003e= 0)","minimum":0,"type":"integer"},"high":{"description":"Number of high severity vulnerabilities (\u003e= 0)","minimum":0,"type":"integer"},"low":{"description":"Number of low severity vulnerabilities (\u003e= 0)","minimum":0,"type":"integer"},"medium":{"description":"Number of medium severity vulnerabilities (\u003e= 0)","minimum":0,"type":"integer"}},"required":["critical","high","medium","low"],"type":"object"},"DistributionDigest":{"description":"Distribution digest information for a container image","properties":{"index_digest":{"description":"Index digest","maxLength":256,"type":"string"},"manifest_digest":{"description":"Manifest digest","maxLength":256,"type":"string"}},"type":"object"},"DockerHubAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["docker-hub"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"EcrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_external_id":{"type":"string"},"cr_region":{"type":"string"},"cr_role_arn":{"type":"string"}},"required":["broker_client_url","cr_agent_url","cr_base","cr_role_arn","cr_region","cr_external_id"],"type":"object"},"type":{"enum":["ecr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"EducationResourceExtended":{"properties":{"attributes":{"properties":{"author":{"type":"string"},"date_published":{"format":"date","type":"string"},"description":{"type":"string"},"education_content_category":{"enum":["security education","product training"],"type":"string"},"estimated_duration":{"nullable":true,"type":"number"},"image":{"type":"string"},"lesson_ids":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"},"seo_title":{"type":"string"},"slug":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"url":{"type":"string"}},"required":["name","description","url","slug","image","education_content_category","tags"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"enum":["lesson","learning_path"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"Emails":{"example":["john.doe@example.com","jane.smith@example.com"],"items":{"format":"email","type":"string"},"maxItems":50,"minItems":1,"type":"array"},"EnvironmentAttributes":{"description":"Environment attributes","example":{"created_at":"2022-05-06T12:25:15-04:00","kind":"aws","name":"Demo AWS Environment","native_id":"12345678910","options":{"role_arn":"arn:aws:iam::123456789012:role/SnykCloud1234"},"properties":{"account_id":"123456789012"},"revision":1,"status":"success","updated_at":"2022-05-06T12:25:15-04:00"},"properties":{"created_at":{"description":"When the environment was created","example":"2022-05-06T12:25:15-04:00","format":"date-time","type":"string"},"deleted_at":{"format":"date-time","nullable":true,"type":"string"},"kind":{"$ref":"#/components/schemas/EnvironmentKind"},"name":{"$ref":"#/components/schemas/EnvironmentName"},"options":{"type":"object"},"properties":{"type":"object"},"revision":{"description":"Increment for each change to an environment","example":1,"type":"integer"},"updated_at":{"description":"When the environment was last updated","example":"2022-05-07T12:25:15-04:00","format":"date-time","nullable":true,"type":"string"}},"required":["kind","name","created_at"],"type":"object"},"EnvironmentCreateAttributes":{"example":{"kind":"aws","options":{"role_arn":"arn:aws:iam::336447867772:role/SnykCloud1234"}},"properties":{"kind":{"$ref":"#/components/schemas/EnvironmentKind"},"name":{"$ref":"#/components/schemas/EnvironmentName"},"options":{"$ref":"#/components/schemas/EnvironmentOptions"}},"required":["kind","options"],"type":"object"},"EnvironmentKind":{"description":"Environment kind: aws","enum":["aws","google","azure","scm","tfc","cli"],"type":"string"},"EnvironmentName":{"description":"Environment name","example":"Demo AWS Environment","type":"string"},"EnvironmentOptions":{"oneOf":[{"$ref":"#/components/schemas/AwsOptions"},{"$ref":"#/components/schemas/GoogleOptions"},{"$ref":"#/components/schemas/AzureOptions__0"}]},"EnvironmentRelationships":{"additionalProperties":true,"description":"Environment relationships","example":{"organization":{"data":{"id":"00000000-0000-0000-0000-000000000000","type":"organization"},"links":{"related":"/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..."}},"project":{"data":{"id":"11111111-1111-11111-1111-111111111111","type":"project"}}},"type":"object"},"EnvironmentType":{"example":"environment","type":"string"},"EnvironmentUpdateAttributes":{"description":"Environment update attributes. Only the AWS role ARN can be updated; new ARN must have the same account ID as the old ARN.","example":{"options":{"role_arn":"arn:aws:iam::123456789012:role/SnykCloud1234"}},"properties":{"name":{"$ref":"#/components/schemas/EnvironmentName"},"options":{"$ref":"#/components/schemas/EnvironmentOptions"}},"required":["options"],"type":"object"},"Error":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"$ref":"#/components/schemas/ErrorLink"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"ErrorDocument":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"$ref":"#/components/schemas/Error"},"minItems":1,"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"}},"required":["jsonapi","errors"],"type":"object"},"ErrorDocument__0":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"$ref":"#/components/schemas/Error__0"},"minItems":1,"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"}},"required":["jsonapi","errors"],"type":"object"},"ErrorLink":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"Error__0":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"$ref":"#/components/schemas/ErrorLink"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"Evidence":{"description":"Supporting evidence for (rather than representative of) the finding in other\nsecurity domains and systems, lacking a well-known identifier.\n\nMore detailed attributes may also be included inline, especially when this\ninformation is not yet generally available in a well-known public APIs.\n\nExamples include:\n- Detailed enumeration of dependency paths\n- Execution flows leading to a code rule violation","discriminator":{"mapping":{"dependency_path":"#/components/schemas/DependencyPathEvidence","execution_flow":"#/components/schemas/ExecutionFlowEvidence","other":"#/components/schemas/OtherEvidence","reachability":"#/components/schemas/ReachabilityEvidence"},"propertyName":"source"},"oneOf":[{"$ref":"#/components/schemas/DependencyPathEvidence"},{"$ref":"#/components/schemas/ExecutionFlowEvidence"},{"$ref":"#/components/schemas/ReachabilityEvidence"},{"$ref":"#/components/schemas/OtherEvidence"}]},"ExecutionFlowEvidence":{"description":"Indicate a program flow of execution as additional evidence for the finding.","properties":{"flow":{"description":"Sequence of locations within this flow of execution.\n\nFor example, a sequence of locations connecting the \"source\" location\nwhere input data is obtained, to a \"sink\" location where it is used.","items":{"$ref":"#/components/schemas/FileRegion"},"minItems":1,"type":"array"},"source":{"enum":["execution_flow"],"type":"string"}},"required":["source","flow"],"type":"object"},"ExploitDetails":{"description":"Details about the exploits","properties":{"maturity_levels":{"description":"List of maturity levels","items":{"$ref":"#/components/schemas/MaturityLevel"},"type":"array"},"sources":{"description":"Sources for determining exploit maturity level, e.g., CISA, ExploitDB, Snyk.","items":{"type":"string"},"type":"array"}},"type":"object"},"ExportGroupAttributes":{"example":{"columns":["ISSUE_SEVERITY_RANK","ISSUE_SEVERITY","SCORE","PROBLEM_TITLE","CVE","CWE","PROJECT_NAME","PROJECT_URL","EXPLOIT_MATURITY","AUTOFIXABLE","FIRST_INTRODUCED","PRODUCT_NAME","ISSUE_URL","ISSUE_STATUS","ISSUE_TYPE"],"dataset":"issues","filters":{"empty_project_tags":"include","environment":["BACKEND","EXTERNAL"],"introduced":{"from":"2024-01-01T00:00:00Z","to":"2024-01-31T00:00:00Z"},"lifecycle":["PRODUCTION"],"orgs":["985cdc6d-a88f-4af8-aa8b-37b22e2425aa","4aa34312-7ded-4fd7-bca8-93eaab3e08d5"],"product_name":["Snyk Code","Snyk Open Source","Snyk IaC","Snyk Container"],"project_tags":["scanType: CSS","user: CLI-user"],"project_type":["npm","pip","golang"]},"formats":["csv"],"url_expiration_seconds":3600},"properties":{"columns":{"items":{"type":"string"},"type":"array"},"dataset":{"type":"string"},"filters":{"$ref":"#/components/schemas/GroupFilters"},"formats":{"items":{"enum":["csv"],"type":"string"},"type":"array"},"url_expiration_seconds":{"default":3600,"format":"int32","maximum":3600,"minimum":0,"type":"integer"}},"required":["formats","dataset"],"type":"object"},"ExportOrgAttributes":{"example":{"columns":["ISSUE_SEVERITY_RANK","ISSUE_SEVERITY","SCORE","PROBLEM_TITLE","CVE","CWE","PROJECT_NAME","PROJECT_URL","EXPLOIT_MATURITY","AUTOFIXABLE","FIRST_INTRODUCED","PRODUCT_NAME","ISSUE_URL","ISSUE_STATUS","ISSUE_TYPE"],"dataset":"issues","filters":{"empty_project_tags":"include","environment":["BACKEND","EXTERNAL"],"introduced":{"from":"2024-01-01T00:00:00Z","to":"2024-01-31T00:00:00Z"},"lifecycle":["PRODUCTION"],"product_name":["Snyk Code","Snyk Open Source","Snyk IaC","Snyk Container"],"project_tags":["scanType: CSS","user: CLI-user"],"project_type":["npm","pip","golang"]},"formats":["csv"],"url_expiration_seconds":3600},"properties":{"columns":{"items":{"type":"string"},"type":"array"},"dataset":{"type":"string"},"filters":{"$ref":"#/components/schemas/OrgFilters"},"formats":{"items":{"enum":["csv"],"type":"string"},"type":"array"},"url_expiration_seconds":{"default":3600,"format":"int32","maximum":3600,"minimum":0,"type":"integer"}},"required":["formats","dataset"],"type":"object"},"FileBundleStoreAttributes":{"properties":{"bundle_id":{"description":"The id of the bundle that has been uploaded by the user, sha256 hash","pattern":"^[0-9a-fA-F]{64}$","type":"string"}},"required":["bundle_id"],"type":"object"},"FileBundleStoreData":{"properties":{"attributes":{"$ref":"#/components/schemas/FileBundleStoreAttributes"},"type":{"enum":["ai_bom_file_bundle"],"type":"string"}},"required":["type","attributes"],"type":"object"},"FileRegion":{"description":"FileRegion models a location where vulnerable code is found.","properties":{"file_path":{"description":"File path for the code snippet.","type":"string"},"from_column":{"description":"Column on which the snippet starts.","type":"integer"},"from_line":{"description":"Line in the file where the code snippet starts.","type":"integer"},"to_column":{"description":"Column at which the code snippet ends.","type":"integer"},"to_line":{"description":"Line on which the code snippet ends.","type":"integer"}},"required":["file_path","from_line"],"type":"object"},"FileUploadApiAttributes":{"properties":{"upload_revision_id":{"description":"The id of the upload revision the has been created by the user","format":"uuid","type":"string"}},"required":["upload_revision_id"],"type":"object"},"FileUploadApiData":{"properties":{"attributes":{"$ref":"#/components/schemas/FileUploadApiAttributes"},"type":{"enum":["ai_bom_file_upload"],"type":"string"}},"required":["type","attributes"],"type":"object"},"FilterFieldAttributes":{"additionalProperties":false,"properties":{"asset_types":{"description":"List of asset types this field applies to","items":{"enum":["container_images"],"type":"string"},"type":"array"},"name":{"description":"The field name used in RSQL filters (e.g., \"class\", \"registry\")","type":"string"},"type":{"description":"Data type of the field (string, boolean, datetime, array, object)","enum":["string","boolean","datetime","array","object"],"type":"string"}},"required":["name","type","asset_types"],"type":"object"},"FilterFieldData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/FilterFieldAttributes"},"id":{"description":"UUID identifier for the filter field","format":"uuid","type":"string"},"relationships":{"description":"Relationships for this filter field (only present for fields supporting autocomplete)","properties":{"values":{"properties":{"links":{"properties":{"related":{"description":"Relative path to get autocomplete values for this filter field","format":"uri-reference","type":"string"}},"required":["related"],"type":"object"}},"type":"object"}},"type":"object"},"type":{"description":"The JSON:API resource type","enum":["filter_fields"],"type":"string"}},"required":["type","id"],"type":"object"},"FilterFieldsResponse":{"additionalProperties":false,"properties":{"data":{"description":"List of available filter fields","items":{"$ref":"#/components/schemas/FilterFieldData"},"type":"array"},"links":{"description":"Self-referencing link","properties":{"self":{"description":"Link to the current resource","format":"uri","type":"string"}},"required":["self"],"type":"object"}},"required":["data","links"],"type":"object"},"FilterValueAttributes":{"additionalProperties":false,"properties":{"key":{"description":"For object-type filters (e.g., tags), the key name. Only present for object-type filter values.","type":"string"},"value":{"description":"The filter value. For simple filters, this is the value itself. For object-type filters (e.g., tags), this is the value associated with the key.","type":"string"}},"type":"object"},"FilterValueData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/FilterValueAttributes"},"id":{"description":"UUID identifier for the filter value","format":"uuid","type":"string"},"type":{"description":"The JSON:API resource type","enum":["filter_values"],"type":"string"}},"required":["type","id"],"type":"object"},"FilterValuesResponse":{"additionalProperties":false,"properties":{"data":{"description":"List of filter values","items":{"$ref":"#/components/schemas/FilterValueData"},"type":"array"},"links":{"description":"Self-referencing link","properties":{"self":{"description":"Link to the current resource","format":"uri","type":"string"}},"required":["self"],"type":"object"}},"required":["data","links"],"type":"object"},"FindingAttributes":{"description":"FindingAttributes represent the attributes of a Finding resource.","properties":{"cause_of_failure":{"default":false,"description":"Did this finding cause the test outcome to fail?","type":"boolean"},"description":{"description":"A longer human-readable text description for this finding.","type":"string"},"evidence":{"description":"Supporting evidence for (rather than representative of) the finding in\nother security domains and systems, lacking a well-known identifier.","example":[{"path":[{"name":"my-app:1.0.0","version":"log4j:2.4.1"}],"source":"dependency_path"}],"items":{"$ref":"#/components/schemas/Evidence"},"type":"array"},"finding_type":{"allOf":[{"$ref":"#/components/schemas/FindingType"}],"description":"Type of finding."},"key":{"description":"An opaque key used for aggregating the finding across multiple test\nexecutions operating on the same or originating Asset.\n\nFindings within a Test execution are aggregated by this key.","type":"string"},"locations":{"description":"Locations in the tested component's contents where the finding may be found.","items":{"$ref":"#/components/schemas/FindingLocation"},"type":"array"},"policy_modifications":{"description":"Attributes which have been modified by policy decisions.","items":{"$ref":"#/components/schemas/PolicyModification"},"type":"array"},"problems":{"description":"Problems are representative of the finding in other security domains and\nsystems with a well-known identifier.","example":[{"id":"CWE-943","source":"cwe"},{"default_configuration":{"severity":"high"},"help":{"markdown":"help text goes here"},"id":"javascript/NoSqli","name":"NoSqli","properties":{"categories":["Security"],"cwe":["CWE-943"],"example_commit_descriptions":[],"example_commit_fixes":[],"precision":"very-high","repo_dataset_size":30,"tags":["javascript","NoSqli"]},"short_description":{"text":"NoSQL Injection"},"source":"snyk_code_rule"}],"items":{"description":"Problems are representative of the finding in other security domains and\nsystems with a well-known identifier.\n\nMore detailed attributes for the problem may be included, especially when\nthis information is not yet readily available in a relatable public API.\n\nProblems are defined in industry standard taxonomies such as:\n- MITRE's Common Weakness Enumeration (CWE)\n- Common Vulnerability Exposures (CVE)\n\nSnyk systems also define problems, such as:\n- Code SAST rules\n- VulnDB vulnerabilities\n- Software licenses\n- Secret leaks","discriminator":{"propertyName":"source"},"oneOf":[{"description":"CWE classification according to MITRE's Common Weakness Enumeration (CWE)\ndatabase.","properties":{"id":{"example":"CWE-190","pattern":"^CWE-[0-9]+$","type":"string"},"source":{"enum":["cwe"],"type":"string"}},"required":["source","id"],"type":"object"},{"description":"Static code analysis rule, from the standard Snyk Code rule set.","properties":{"default_configuration":{"description":"Snyk Code rule configuration options.","properties":{"severity":{"allOf":[{"description":"Indicate the severity of a finding discovered by a Test.","enum":["critical","high","medium","low","none","other"],"type":"string"}],"description":"Severity to apply when the rule matches."}},"required":["severity"],"type":"object"},"help":{"description":"Represent a message string in multiple formats: plain text or markdown.","properties":{"markdown":{"type":"string"},"text":{"type":"string"}},"type":"object"},"id":{"example":"javascript/NoSqli","type":"string"},"name":{"type":"string"},"properties":{"description":"Additional properties of a Snyk Code rule. Represented in SARIF as free-form\nmetadata, but Snyk Code scanner outputs prescribe a specific structure for\nthis content.","properties":{"categories":{"description":"Categories applied to the rule.","items":{"type":"string"},"type":"array"},"cwe":{"description":"List of CWE (Common Weakness Enumeration) identifiers corresponding to this rule.","items":{"type":"string"},"type":"array"},"example_commit_descriptions":{"description":"Descriptions of the fix examples.","items":{"type":"string"},"type":"array"},"example_commit_fixes":{"description":"Examples of fixing this rule in public open-source code.","items":{"description":"An example of fixing this rule in a public open-source code.","properties":{"commit_url":{"description":"Commit URL identifying a specific commit within a public open-source SCM repo.","type":"string"},"lines":{"description":"Lines containing an example of the Snyk Code rule with an example fix.","items":{"description":"Source line content, line number, and unified diff indicating the changes in\nthe fix.","properties":{"line":{"type":"string"},"line_change":{"type":"string"},"line_number":{"format":"uint32","type":"integer"}},"required":["line","line_number","line_change"],"type":"object"},"type":"array"}},"required":["commit_url","lines"],"type":"object"},"type":"array"},"precision":{"description":"A qualitative description of the rule's precision.","example":"very-high","type":"string"},"repo_dataset_size":{"format":"uint32","type":"integer"},"tags":{"description":"Tags applied to the rule.","items":{"type":"string"},"type":"array"}},"required":["tags","categories","example_commit_fixes","example_commit_descriptions","precision","repo_dataset_size","cwe"],"type":"object"},"short_description":{"description":"Represent a message string in multiple formats: plain text or markdown.","properties":{"markdown":{"type":"string"},"text":{"type":"string"}},"type":"object"},"source":{"enum":["snyk_code_rule"],"type":"string"}},"required":["source","id","name","short_description","default_configuration","help","properties"],"type":"object"},{"description":"CVE designation according to the public Common Vulnerability Exposure\ndatabase.","properties":{"id":{"example":"CVE-2006-7135","pattern":"^CVE-[0-9]+-[0-9]+$","type":"string"},"source":{"enum":["cve"],"type":"string"}},"required":["source","id"],"type":"object"},{"description":"Vulnerability from Snyk's Vulnerability Database.","properties":{"affected_hash_ranges":{"description":"Range of commit hashes known to be affected by this problem.\n\nGenerally used with package ecosystems which use Git SCM repositories for\ndistribution.","items":{"type":"string"},"type":"array"},"affected_hashes":{"description":"List of specific commit hashes known to be affected by this problem.","items":{"type":"string"},"type":"array"},"affected_versions":{"description":"All the package versions which are affected by this problem. Expect this to\nbe smaller than 0 ([,0] or \u003c0.0.0 ) for vulnerabilities that have been\nrevoked. Per ecosystem, the official package version guidelines are\nbeing used.","items":{"type":"string"},"type":"array"},"alternative_ids":{"description":"This is the list of alternative IDs Snyk gives for a certain vulnerability.\nIt's usually present in older vulnerabilities, in which Snyk used to use a different identifier format.\ne.g a vuln with the ID \"npm:foo:bar\", will likely have an alternative ID of \"SNYK-JS-FOO-BAR\".","items":{"type":"string"},"maxItems":50,"type":"array"},"created_at":{"description":"Timestamp indicating when the problem was orginally created.","example":"2022-05-17T14:23:25Z","format":"date-time","type":"string"},"credits":{"description":"Discoverer / Reporter of the vulnerability.","example":["Snyk Research Team"],"items":{"type":"string"},"type":"array"},"cvss_base_score":{"allOf":[{"maximum":10,"minimum":0,"type":"number"}],"description":"The Snyk curated or recommended CVSS score, in the highest CVSS version\nsupported and available for the issue, computed based on the Base Score\nof the cvss_vector field.","example":9.8},"cvss_sources":{"description":"All CVSS vector information (Base), with corresponding sources, scores\nand severities applying to the same vulnerability. The data is sourced\nfrom external security vendors (e.g. NVD), as well as assigned by Snyk.\n\nThe “type” key indicates whether this is the “primary” (recommended) CVSS\nto use, or “secondary” (provided as additional information).\n\nInformation might be partial and will be updated upon evaluation by\nexternal sources.","items":{"description":"CVSS vector information with provenance indicating the source of the scoring.","properties":{"assigner":{"description":"Entity providing the CVSS information.","type":"string"},"base_score":{"allOf":[{"maximum":10,"minimum":0,"type":"number"}],"description":"Base CVSS score."},"cvss_version":{"description":"CVSS version.","type":"string"},"modified_at":{"description":"When the CVSS scoring was last modified.","format":"date-time","type":"string"},"severity":{"allOf":[{"description":"Indicate the severity of a finding discovered by a Test.","enum":["critical","high","medium","low","none","other"],"type":"string"}],"description":"Severity based on the CVSS rating scale (see SnykVulnAttributes.severity)."},"type":{"allOf":[{"description":"Indicate whether the CVSS source is primary (recommended) or secondary\n(provided as supplemental information).","enum":["primary","secondary","other"],"type":"string"}],"description":"Designation of whether the CVSS score is primary (recommended assessment)\nor secondary (supplemental information)."},"vector":{"description":"The CVSS vector string.","type":"string"}},"required":["assigner","modified_at","severity","vector","base_score","cvss_version","type"],"type":"object"},"type":"array"},"cvss_vector":{"description":"The primary CVSS Base vector, either Snyk curated or from the recommended\nsource, in v3.0, v3.1 or v4.0 CVSS versions. Might include exploit\nvalues where applicable.","example":"CVSS:4.0/AV:N/AC:H/AT:N/PR:N/UI:N/VC:H/VI:H/VA:L/SC:N/SI:N/SA:N","type":"string"},"disclosed_at":{"description":"Timestamp of when the vulnerability was first made publicly available\n(either known to us or as appears in the vulnerability source)","example":"2022-10-09T23:55:03Z","format":"date-time","type":"string"},"ecosystem":{"allOf":[{"description":"Describe a software package ecosystem.","discriminator":{"propertyName":"type"},"oneOf":[{"description":"Software packages supporting the application build process.\n\nThese are generally development libraries, which may be distributed in source\nor compiled form, used during the application build process by various\nprogramming language toolchains.\n\nExamples include, but are not limited to: Javascript NPM, Java Maven, Python pip, etc.","properties":{"client":{"description":"Ecosystem client is the tool the consumer used to manage the dependencies.\nIn managed ecosystems, this is commonly refered to as the package manager,\nwhile in the case of C++, this would be \"unmanaged\".","type":"string"},"language":{"deprecated":true,"type":"string"},"package_manager":{"deprecated":true,"type":"string"},"type":{"enum":["build"],"type":"string"}},"required":["type","language","package_manager"],"type":"object"},{"description":"Software packages supporting operating system software installation and\nupgrades.\n\nThese are generally software packages containing runtime libraries and\napplications which are installed as part of an operating system software\ndistribution.","properties":{"distribution":{"description":"Distribution name providing the package.","example":"debian","type":"string"},"os_name":{"description":"Name of the operating system.","example":"linux","type":"string"},"release":{"description":"Release version of the operating system distribution.\n\nNote that for Linux distributions this is the release version (typically a\nsemver or date-derived number), rather than the codename for the release.","example":"12.6","type":"string"},"type":{"enum":["os"],"type":"string"}},"required":["type","os_name","distribution","release"],"type":"object"},{"description":"Package ecosystem which this API version is not capable of expressing.\n\nMore information may be available in a newer version of this API.","properties":{"type":{"enum":["other"],"type":"string"}},"required":["type"],"type":"object"}]}],"description":"Package ecosystem in which the package is distributed.\n\nThis applies to private packages distributed with ecosystem tooling as well\nas those publicly distributed."},"epss_details":{"allOf":[{"description":"Exploit Prediction Scoring System (EPSS), which predicts the likelihood (probability) of the vulnerability to be\nexploited, and the percentile of the EPSS of a vulnerability relative to all other vulnerabilities.\nWe are using the latest model.\nhttps://www.first.org/epss/model","properties":{"model_version":{"description":"The version of the EPSS model we use.","example":"v2025.03.14","type":"string"},"percentile":{"description":"The percentile of the EPSS of a vulnerability relative to all other vulnerabilities.\nIn value range 0 - 1 with 5 fixed digits.","example":"0.73768","type":"string"},"probability":{"description":"The probability of the vulnerability to be exploited.\nIn value range 0 - 1 with 5 fixed digits.","example":"0.00859","type":"string"}},"required":["percentile","probability","model_version"],"type":"object"}],"description":"EPSS details - see note on model definition."},"exploit_details":{"allOf":[{"description":"Details about the exploitability of a vulnerability.","properties":{"maturity_levels":{"description":"Exploit maturity representation in CVSS version formats.","items":{"description":"Represents exploit maturity.","properties":{"format":{"description":"Format of the maturity level.","example":"CVSSv4","type":"string"},"level":{"description":"Maturity level in the given format.","type":"string"},"type":{"allOf":[{"description":"Indicate whether the CVSS source is primary (recommended) or secondary\n(provided as supplemental information).","enum":["primary","secondary","other"],"type":"string"}],"description":"Designation of whether the maturity information is primary (recommended\nassessment) or secondary (supplemental information) in nature."}},"required":["format","level","type"],"type":"object"},"type":"array"},"sources":{"description":"Sources of the exploitation maturity assessment.","items":{"type":"string"},"type":"array"}},"required":["sources","maturity_levels"],"type":"object"}],"description":"Details about the maturity of exploits for this vulnerability."},"id":{"example":"npm:jsonwebtoken:20150331","pattern":"(^SNYK(-[^-]+)+[-][0-9]+$)|(^[^:]+(:[^:]+)+$)","type":"string"},"initially_fixed_in_versions":{"description":"This indicates the earliest version that is vulnerability-free. As this\nmight be a backported fix, this does not mean that newer versions aren’t\nvulnerable. vulnerable_versions should also be used to determine whether\na given version is vulnerable.","items":{"type":"string"},"type":"array"},"is_disputed":{"default":false,"description":"Indicates if the vulnerability is formally disputed.\nA vulnerability's claim (e.g., that it's a security flaw, or the scope/impact) is\n**disputed** when one party, often the vendor or a security professional, formally\nchallenges the assertion.\nMost cybersecurity public listings, such as CVE, have a defined process\nallowing vendors or researchers to officially challenge the validity\nof a reported issue, leading to this 'DISPUTED' status being formally annotated.","type":"boolean"},"is_fixable":{"default":false,"description":"Is there a fixed version published to the relevant package manager\nrepository- i.e., a newer version without this specific vulnerability","type":"boolean"},"is_malicious":{"default":false,"description":"Indicate if the vulnerability is known to mark a malicious package.","type":"boolean"},"is_proprietary":{"default":false,"description":"This field indicates if the vulnerability was first published in the Snyk DB.\nThis happens when either of the following is true:\n- Snyk was responsilbe for coordinating the disclosure\n- Snyk researchers discovered the vulnerability/malicious package\n- Snyk gave the first or best indication about the vulnerability based on unofficial sources.\nThe only exceptions are when:\n- The vulnerability is a Linux container\n- The vulnerable package is written in C/C++ and not hosted on conan center\n- The vulnerable package is a `webjar`","type":"boolean"},"is_social_media_trending":{"default":false,"description":"This boolean field is true when increased activity is detected related to\nthis vulnerability. The \"trending\" determination is based on social media\nactivity, using Snyk models which are tuned to detect an increased chance\nof near-future exploitation.","type":"boolean"},"modified_at":{"description":"Timestamp indicating when the vulnerability was last modified (anything\nfrom typo to version change). When the vulnerability is first added, this\nfield and published will be (almost) identical.","format":"date-time","type":"string"},"package_full_name":{"description":"The full name of the vulnerable software package.\nIt's achieved by combining the packageName and packageNamespace\nwith the ecosystem specific delimiter.","type":"string"},"package_name":{"description":"Package name.","type":"string"},"package_namespace":{"description":"Vulnerable software package namespace, if applicable.","type":"string"},"package_popularity_rank":{"description":"Percentile rank indicating the package's prevalence across Snyk-monitored projects.\nA higher rank signifies the package is used in a larger percentage of projects.","maximum":100,"minimum":0,"type":"number"},"package_repository_url":{"description":"Link to the package repository containing the vulnerable package.","example":"https://repo.maven.apache.org/maven2","format":"uri","type":"string"},"package_version":{"description":"Package version.","type":"string"},"published_at":{"description":"Timestamp indicating when the problem was published.","example":"2022-05-17T14:23:25Z","format":"date-time","type":"string"},"references":{"description":"Links to external websites related to the vulnerability. Links also\ninclude a user-facing curated title.","items":{"description":"Represent links to external sources of vulnerability information.","properties":{"title":{"description":"User-facing title of the link.","type":"string"},"url":{"description":"External link where more information about the vulnerability can be found.","format":"uri","type":"string"}},"required":["title","url"],"type":"object"},"type":"array"},"severity":{"allOf":[{"description":"Indicate the severity of a finding discovered by a Test.","enum":["critical","high","medium","low","none","other"],"type":"string"}],"description":"The Snyk curated or recommended vulnerability severity for the problem.","example":"critical"},"severity_based_on":{"description":"Indicates how the vulnerability severity was determined.","type":"string"},"source":{"enum":["snyk_vuln"],"type":"string"},"vendor_severity":{"description":"The assigned severity/impact/urgency rating by the distros teams for the\nspecific vulnerability package and release of the operating system (if available).","type":"string"},"vulnerable_functions":{"additionalProperties":{"description":"Information about a function known to be vulnerable in a software package.","properties":{"function_id":{"allOf":[{"description":"Identify a vulnerable function in a software package.","properties":{"class_name":{"description":"Class containing the function.","type":"string"},"function_name":{"description":"Vulnerable function name.","type":"string"}},"required":["function_name"],"type":"object"}],"description":"Vulnerable function."},"versions":{"description":"Package versions in which the function is vulnerable.","items":{"type":"string"},"type":"array"}},"required":["function_id","versions"],"type":"object"},"description":"Known vulnerable functions in software packages.","type":"object"}},"required":["source","id","ecosystem","created_at","package_name","package_version","published_at","severity","credits","cvss_base_score","cvss_sources","cvss_vector","disclosed_at","exploit_details","initially_fixed_in_versions","is_fixable","is_malicious","is_social_media_trending","modified_at","references"],"type":"object"},{"description":"License from Snyk's Vulnerability Database.\n\nA software license can be considered a problem when policy designates it as\na business risk.","properties":{"affected_hash_ranges":{"description":"Range of commit hashes known to be affected by this problem.\n\nGenerally used with package ecosystems which use Git SCM repositories for\ndistribution.","items":{"type":"string"},"type":"array"},"affected_hashes":{"description":"List of specific commit hashes known to be affected by this problem.","items":{"type":"string"},"type":"array"},"affected_versions":{"description":"All the package versions which are affected by this problem. Expect this to\nbe smaller than 0 ([,0] or \u003c0.0.0 ) for vulnerabilities that have been\nrevoked. Per ecosystem, the official package version guidelines are\nbeing used.","items":{"type":"string"},"type":"array"},"created_at":{"description":"Timestamp indicating when the problem was orginally created.","example":"2022-05-17T14:23:25Z","format":"date-time","type":"string"},"ecosystem":{"allOf":[{"description":"Describe a software package ecosystem.","discriminator":{"propertyName":"type"},"oneOf":[{"description":"Software packages supporting the application build process.\n\nThese are generally development libraries, which may be distributed in source\nor compiled form, used during the application build process by various\nprogramming language toolchains.\n\nExamples include, but are not limited to: Javascript NPM, Java Maven, Python pip, etc.","properties":{"client":{"description":"Ecosystem client is the tool the consumer used to manage the dependencies.\nIn managed ecosystems, this is commonly refered to as the package manager,\nwhile in the case of C++, this would be \"unmanaged\".","type":"string"},"language":{"deprecated":true,"type":"string"},"package_manager":{"deprecated":true,"type":"string"},"type":{"enum":["build"],"type":"string"}},"required":["type","language","package_manager"],"type":"object"},{"description":"Software packages supporting operating system software installation and\nupgrades.\n\nThese are generally software packages containing runtime libraries and\napplications which are installed as part of an operating system software\ndistribution.","properties":{"distribution":{"description":"Distribution name providing the package.","example":"debian","type":"string"},"os_name":{"description":"Name of the operating system.","example":"linux","type":"string"},"release":{"description":"Release version of the operating system distribution.\n\nNote that for Linux distributions this is the release version (typically a\nsemver or date-derived number), rather than the codename for the release.","example":"12.6","type":"string"},"type":{"enum":["os"],"type":"string"}},"required":["type","os_name","distribution","release"],"type":"object"},{"description":"Package ecosystem which this API version is not capable of expressing.\n\nMore information may be available in a newer version of this API.","properties":{"type":{"enum":["other"],"type":"string"}},"required":["type"],"type":"object"}]}],"description":"Package ecosystem in which the package is distributed.\n\nThis applies to private packages distributed with ecosystem tooling as well\nas those publicly distributed."},"id":{"example":"snyk:lic:golang:github.com:hashicorp:terraform-svchost:MPL-2.0","pattern":"^snyk(:[^:]+)+$","type":"string"},"instructions":{"description":"License policy instructions. Legal instructions for the user on what to do\nwhen met with the license policy violation.","items":{"description":"License instructions are free-form, customer defined messages typically provided\nby application security or legal teams. They appear in the CLI alongside detected\nlicense violations to guide developers on how to handle specific licenses in their\ndependencies.","properties":{"content":{"description":"License policy instructions. Legal instructions for the user on what to do\nwhen met with the license policy violation.","example":"You must include the MPL-2.0 license in all copies of the software.","type":"string"},"license":{"description":"Software license identifier.","example":"MPL-2.0","type":"string"}},"required":["license","content"],"type":"object"},"type":"array"},"license":{"description":"Software license identifier.","example":"MPL-2.0","type":"string"},"package_full_name":{"description":"The full name of the vulnerable software package.\nIt's achieved by combining the packageName and packageNamespace\nwith the ecosystem specific delimiter.","type":"string"},"package_name":{"description":"Package name.","type":"string"},"package_namespace":{"description":"Vulnerable software package namespace, if applicable.","type":"string"},"package_version":{"description":"Package version.","type":"string"},"published_at":{"description":"Timestamp indicating when the problem was published.","example":"2022-05-17T14:23:25Z","format":"date-time","type":"string"},"severity":{"allOf":[{"description":"Indicate the severity of a finding discovered by a Test.","enum":["critical","high","medium","low","none","other"],"type":"string"}],"description":"The Snyk curated or recommended vulnerability severity for the problem.","example":"critical"},"source":{"enum":["snyk_license"],"type":"string"}},"required":["source","id","ecosystem","created_at","package_name","package_version","published_at","severity","license","instructions"],"type":"object"},{"description":"Configuration policy violation from Snyk's Cloud Rules Database.","properties":{"id":{"example":"SNYK-CC-TF-14","pattern":"^SNYK-CC-([^-]+)+[-][0-9]+$","type":"string"},"source":{"enum":["snyk_cloud_rule"],"type":"string"}},"required":["source","id"],"type":"object"},{"description":"Github Security Advisory associated with this finding.","properties":{"id":{"example":"GHSA-pxg6-pf52-xh8x","type":"string"},"source":{"enum":["ghsa"],"type":"string"}},"required":["source","id"],"type":"object"},{"description":"Secret rule that produces a Secret finding.","properties":{"categories":{"description":"Categories applied to the rule.","example":["security"],"items":{"type":"string"},"maxItems":10,"type":"array"},"help":{"description":"Assistance on resolving the finding.","type":"string"},"id":{"type":"string"},"name":{"description":"Name for the kind of finding uncovered.","type":"string"},"precision":{"description":"A qualitative description of the rule's precision.","example":"very-high","type":"string"},"severity":{"allOf":[{"description":"Indicate the severity of a finding discovered by a Test.","enum":["critical","high","medium","low","none","other"],"type":"string"}],"description":"Severity level of the finding."},"short_description":{"description":"Short description of the found Secret's type.","type":"string"},"source":{"enum":["secret"],"type":"string"},"tags":{"description":"Tags applied to the rule.","example":["aws"],"items":{"type":"string"},"maxItems":20,"type":"array"}},"required":["source","id","severity","name","short_description","help","tags","precision","categories"],"type":"object"},{"description":"Problem which this API version is not capable of expressing.\n\nThis problem may be available in a newer version of this API.","properties":{"source":{"enum":["other"],"type":"string"}},"required":["source"],"type":"object"}]},"type":"array"},"rating":{"allOf":[{"$ref":"#/components/schemas/Rating"}],"description":"Qualitative ratings on a finding."},"risk":{"allOf":[{"description":"Risk represents Snyk's risk assessment of a finding.","properties":{"risk_score":{"allOf":[{"description":"Risk score assigns a numeric metric based on various attributes of the\nfinding and the risk context in which it was discovered.","properties":{"value":{"format":"uint16","maximum":1000,"type":"integer"}},"required":["value"],"type":"object"}],"description":"Risk score assessment for the finding."}},"type":"object"}],"description":"Qualitative risk analysis on a finding."},"suppression":{"allOf":[{"$ref":"#/components/schemas/Suppression"}],"description":"Indication of whether a finding is suppressed by a policy decision."},"title":{"description":"A human-readable title for this finding.","type":"string"}},"required":["finding_type","title","description","key","cause_of_failure","problems","evidence","locations","rating","risk"],"type":"object"},"FindingData":{"description":"FindingData represents a Finding resource object.","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/FindingAttributes"}],"readOnly":true},"id":{"format":"uuid","readOnly":true,"type":"string"},"links":{"description":"Links to external resources outside this API.\n\nBecause these are not REST API resources, they are expressed here as links,\nrather than as relationships.","properties":{"snyk_advisory":{"allOf":[{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"}],"description":"Link to Snyk's vulnerability advisory for more information on the\nfinding, if applicable.","example":"https://security.snyk.io/vuln/SNYK-JAVA-ORGAPACHELOGGINGLOG4J-2314720"},"snyk_learn":{"allOf":[{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"}],"description":"Link to a Snyk Learn lesson relevant to the finding, if applicable.","example":"https://learn.snyk.io/lesson/csrf-attack/"}},"type":"object"},"relationships":{"properties":{"asset":{"description":"Originating asset in which this finding was discovered.","properties":{"data":{"properties":{"id":{"format":"uuid","type":"string"},"type":{"pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"}},"required":["type","id"],"type":"object"},"links":{"$ref":"#/components/schemas/io.snyk.api.common.RelatedLink"},"meta":{"$ref":"#/components/schemas/io.snyk.api.common.Meta"}},"required":["links"],"type":"object"},"fix":{"description":"Fix for this finding, it comes expanded with all data preloaded","properties":{"data":{"properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/FixAttributes"}],"description":"Inlined attributes included in the relationship, if it is expanded.\n\nExpansion is a Snyk variation on JSON API. See\nhttps://snyk.roadie.so/docs/default/component/sweater-comb/standards/rest/#expansion"},"id":{"format":"uuid","type":"string"},"type":{"pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"}},"required":["type","id"],"type":"object"}},"type":"object"},"org":{"description":"Snyk organization scope in which the finding was discovered.","properties":{"data":{"properties":{"id":{"format":"uuid","type":"string"},"type":{"pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"}},"required":["type","id"],"type":"object"}},"type":"object"},"policy":{"description":"Relate to the policy or policies applied to this finding.","properties":{"data":{"properties":{"attributes":{"allOf":[{"properties":{"policies":{"items":{"properties":{"applied_policy":{"anyOf":[{"properties":{"action_type":{"enum":["severity-change"],"type":"string"},"policy_ref":{"description":"Reference to a policy, serving as a container for a set of policy-rules and can be owned by the group or the org.","properties":{"id":{"format":"uuid","type":"string"},"owner":{"enum":["org","group"],"type":"string"}},"required":["id","owner"],"type":"object"},"rule":{"description":"A policy rule is the central entity of a policy, including an action as well as conditions\nwhen this policy applies.\nOnly a subset of fields are included, for more details see the API documentation\nhttps://apidocs.snyk.io/?version=2024-10-15#get-/orgs/-org_id-/policies/-policy_id-","properties":{"created":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"modified":{"format":"date-time","type":"string"},"name":{"type":"string"},"review":{"enum":["approved","rejected","pending","cancelled","not-required","unknown"],"type":"string"}},"required":["id","name","modified","created","review"],"type":"object"},"severity_change":{"properties":{"new_severity":{"description":"Indicate the severity of a finding discovered by a Test.","enum":["critical","high","medium","low","none","other"],"type":"string"},"original_severity":{"description":"Indicate the severity of a finding discovered by a Test.","enum":["critical","high","medium","low","none","other"],"type":"string"}},"required":["original_severity","new_severity"],"type":"object"}},"required":["action_type","policy_ref","rule","severity_change"],"type":"object"},{"properties":{"action_type":{"enum":["ignore"],"type":"string"},"ignore":{"properties":{"created":{"format":"date-time","type":"string"},"disregard_if_fixable":{"description":"Disregards the policy if set to true and the finding this policy is applied to is fixable","type":"boolean"},"expires":{"format":"date-time","type":"string"},"ignored_by":{"properties":{"email":{"description":"Email of the user who created the ignore","type":"string"},"id":{"description":"User ID of the author of the ignore","format":"uuid","type":"string"},"name":{"description":"Name of the user who created the ignore","type":"string"}},"required":["id","name"],"type":"object"},"path":{"items":{"type":"string"},"maxItems":10,"type":"array"},"reason":{"type":"string"},"reason_type":{"enum":["wont-fix","not-vulnerable","temporary-ignore"],"type":"string"},"source":{"type":"string"}},"required":["reason","source"],"type":"object"},"policy_ref":{"description":"Reference to a policy, serving as a container for a set of policy-rules and can be owned by the group or the org.","properties":{"id":{"format":"uuid","type":"string"},"owner":{"enum":["org","group"],"type":"string"}},"required":["id","owner"],"type":"object"},"rule":{"description":"A policy rule is the central entity of a policy, including an action as well as conditions\nwhen this policy applies.\nOnly a subset of fields are included, for more details see the API documentation\nhttps://apidocs.snyk.io/?version=2024-10-15#get-/orgs/-org_id-/policies/-policy_id-","properties":{"created":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"modified":{"format":"date-time","type":"string"},"name":{"type":"string"},"review":{"enum":["approved","rejected","pending","cancelled","not-required","unknown"],"type":"string"}},"required":["id","name","modified","created","review"],"type":"object"}},"required":["action_type","ignore"],"type":"object"}],"discriminator":{"propertyName":"action_type"}},"id":{"format":"uuid","type":"string"},"type":{"enum":["legacy_policy_snapshot"],"type":"string"}},"required":["type","id","applied_policy"],"type":"object"},"type":"array"}},"required":["policies"],"type":"object"}],"description":"Inlined attributes included in the relationship, if it is expanded.\n\nExpansion is a Snyk variation on JSON API. See\nhttps://snyk.roadie.so/docs/default/component/sweater-comb/standards/rest/#expansion"},"id":{"format":"uuid","type":"string"},"type":{"pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"}},"required":["type","id"],"type":"object"},"links":{"$ref":"#/components/schemas/io.snyk.api.common.RelatedLink"},"meta":{"$ref":"#/components/schemas/io.snyk.api.common.Meta"}},"required":["links"],"type":"object"},"project":{"description":"Snyk Project in which the Finding was discovered","properties":{"data":{"properties":{"id":{"format":"uuid","type":"string"},"type":{"pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"}},"required":["type","id"],"type":"object"}},"type":"object"},"test":{"description":"Test in which this finding was discovered.","properties":{"data":{"properties":{"id":{"format":"uuid","type":"string"},"type":{"pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"}},"required":["type","id"],"type":"object"},"links":{"$ref":"#/components/schemas/io.snyk.api.common.RelatedLink"},"meta":{"$ref":"#/components/schemas/io.snyk.api.common.Meta"}},"required":["links"],"type":"object"}},"readOnly":true,"type":"object"},"type":{"enum":["findings"],"readOnly":true,"type":"string"}},"required":["id","type","attributes"],"type":"object"},"FindingLocation":{"description":"Location within an Subject's contents where the finding was discovered.","discriminator":{"mapping":{"other":"#/components/schemas/OtherLocation","package":"#/components/schemas/PackageLocation"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PackageLocation"},{"description":"Source file location.\n\nFinding types: SCA, SAST","example":{"file_path":"package.json","from_column":12,"from_line":24,"to_column":36,"to_line":24,"type":"source"},"properties":{"file_path":{"description":"File path for the code snippet.","type":"string"},"from_column":{"description":"Column on which the snippet starts.","type":"integer"},"from_line":{"description":"Line in the file where the code snippet starts.","type":"integer"},"to_column":{"description":"Column at which the code snippet ends.","type":"integer"},"to_line":{"description":"Line on which the code snippet ends.","type":"integer"},"type":{"enum":["source"],"type":"string"}},"required":["type","file_path","from_line"],"type":"object"},{"$ref":"#/components/schemas/OtherLocation"}]},"FindingSummary":{"description":"Summary of findings found by the Test.","properties":{"count":{"description":"Total count of findings.","example":30,"format":"uint32","type":"integer"},"count_by":{"additionalProperties":{"additionalProperties":{"format":"uint32","type":"integer"},"type":"object"},"description":"Counts of findings grouped by various finding attributes.\n\nThe outer record is keyed by finding attribute name. The value is a record\nkeyed by distinct values of this attribute, whose value is the number of\nfindings with a distinct value.","example":{"result_type":{"sast":12,"sca":18},"severity":{"critical":2,"high":3,"low":15,"medium":10}},"type":"object"}},"required":["count"],"type":"object"},"FindingType":{"description":"Type of Finding which was discovered.","enum":["sca","sast","dast","other","config","secret"],"type":"string"},"FixAction":{"description":"Different fix formats in which the fix action is represented. We distinguish between advice and diff formats.\n\nAdvice - Fix advice in a display only / informational format. These are highly product line specific, so they have their own model.\n- upgradePackageAdvice: Upgrade a direct package from one version to a newer one that resolves the vulnerability.\n- pinPackageAdvice: Pin a package at a specific version.\n\nDiff - Fix suggestions in the unified diff format that introduce code changes\nto remediate the vulnerability. Can be used to represent fix actions for any product line.","discriminator":{"mapping":{"diff":"#/components/schemas/Diff","pin_package_advice":"#/components/schemas/PinPackageAdvice","upgrade_package_advice":"#/components/schemas/UpgradePackageAdvice"},"propertyName":"format"},"oneOf":[{"$ref":"#/components/schemas/UpgradePackageAdvice"},{"$ref":"#/components/schemas/PinPackageAdvice"},{"$ref":"#/components/schemas/Diff"}]},"FixAppliedOutcome":{"description":"Indicates the outcome of a fix in terms of resolving the finding at hand","enum":["fully_resolved","partially_resolved","unresolved"],"type":"string"},"FixAttributes":{"description":"FixAttributes is the main payload modelling a fix","properties":{"action":{"allOf":[{"$ref":"#/components/schemas/FixAction"}],"description":"Applying the steps specified by the action within the fix leads to resolving either completely or partially this finding.\nAn action may be a simple upgrade, a code swap, or may model sets of boolean operations.\n\nFor now only simple actions are modelled but could be extended to include more complex actions in the future.\nSee doc for more info: https://docs.google.com/document/d/151vAXurvX4k8fNOWspSI2Ou9OF1G5fj8LHa-NuKOfgw"},"outcome":{"allOf":[{"$ref":"#/components/schemas/FixAppliedOutcome"}],"description":"Indicates whether applying these actions will address the finding or not"}},"required":["outcome"],"type":"object"},"ForceUpdate":{"example":false,"type":"boolean"},"GcrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["gcr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GenericConfigurationAttributes":{"properties":{"configuration":{"properties":{"required":{"additionalProperties":{"type":"string"},"type":"object"},"type":{"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"}},"required":["configuration"],"type":"object"},"GetAiBomResponseBody":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/GetAiBomResponseData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"},"GetAiBomResponseData":{"properties":{"attributes":{"$ref":"#/components/schemas/AiBomAttributes"},"id":{"format":"uuid","type":"string"},"type":{"enum":["ai_bom"],"type":"string"}},"required":["id","attributes","type"],"type":"object"},"GetAiBomResponseJobBody":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/JobData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"},"GetBrokerConnectionIntegrationResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/OrgIntegrationResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"GetBrokerConnectionIntegrationsResponse":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/OrgIntegrationResource"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"GetBrokerConnectionResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/BrokerConnectionResponseResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"GetBrokerContextResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/BrokerContextResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"GetBrokerDeploymentResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/BrokerDeploymentResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"GetBrokerOrganizationsForBulkMigrationResponse":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/OrganizationResource"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"GetDeploymentCredentialResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/DeploymentCredentialResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"GetProjectSettingsCollection":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/ProjectSettingsData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"},"GetProjectsOfCollectionResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ProjectOfCollection"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"},"GitHubAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"github_token":{"format":"uuid","type":"string"}},"required":["broker_client_url","github_token"],"type":"object"},"type":{"enum":["github"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GitHubCloudAppAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"github":{"example":"ghe.yourdomain.com","type":"string"},"github_api":{"example":"api.ghe.yourdomain.com","type":"string"},"github_app_client_id":{"example":"\u003capp-client-id\u003e","type":"string"},"github_app_id":{"example":"\u003capp-id\u003e","type":"string"},"github_app_installation_id":{"example":"\u003capp-installation-id\u003e","type":"string"},"github_app_private_pem_path":{"example":"\u003cpath-to-private-pem-file\u003e","type":"string"}},"required":["broker_client_url","github","github_api","github_app_client_id","github_app_id","github_app_installation_id","github_app_private_pem_path"],"type":"object"},"type":{"enum":["github-cloud-app"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GitHubEnterpriseAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"github":{"example":"ghe.yourdomain.com","type":"string"},"github_token":{"format":"uuid","type":"string"}},"required":["broker_client_url","github","github_token"],"type":"object"},"type":{"enum":["github-enterprise"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GitHubServerAppAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"github":{"example":"ghe.yourdomain.com","type":"string"},"github_api":{"example":"api.ghe.yourdomain.com","type":"string"},"github_app_client_id":{"example":"\u003capp-client-id\u003e","type":"string"},"github_app_id":{"example":"\u003capp-id\u003e","type":"string"},"github_app_installation_id":{"example":"\u003capp-installation-id\u003e","type":"string"},"github_app_private_pem_path":{"example":"\u003cpath-to-private-pem-file\u003e","type":"string"}},"required":["broker_client_url","github","github_api","github_app_client_id","github_app_id","github_app_installation_id","github_app_private_pem_path"],"type":"object"},"type":{"enum":["github-server-app"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GitLabAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"gitlab":{"example":"gitlab.yourdomain.com","type":"string"},"gitlab_token":{"format":"uuid","type":"string"}},"required":["broker_client_url","gitlab","gitlab_token"],"type":"object"},"type":{"enum":["gitlab"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GitUrlCoordinatesSubject":{"description":"**Deprecated**\n\nProvide an ScmResource and include the\nSAST Scan Configuration instead.\n\nTest subject representing a source tree located in a Git repository that\nhas a Snyk SCM integration.\n\nGit URL coordinates are accepted through the API, but are not\nguaranteed to return Findings.","properties":{"commit_id":{"description":"Commit ID of the Git commit from which content will be retrieved for the\ntest.","pattern":"^[a-f0-9]{40,}$","type":"string"},"integration_id":{"description":"Integration used to access the Git SCM repository in order to retrieve its source contents.","format":"uuid","type":"string"},"locator":{"allOf":[{"$ref":"#/components/schemas/ScmRepoLocator"}],"description":"Locate the SCM repository from which content will be retrieved for the\ntest."},"type":{"enum":["git_url_coordinates"],"type":"string"}},"required":["type","integration_id","commit_id","locator"],"type":"object"},"GithubCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["github-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GitlabCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["gitlab-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GoogleArtifactCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["google-artifact-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"GoogleOptions":{"additionalProperties":false,"description":"Options for creating a Google environment","example":{"identity_provider":"https://iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/snyk-workload-identity-123/providers/snyk-identity-provider-123","project_id":"demo-project","service_account_email":"snyk-demo@demo-project.iam.gserviceaccount.com"},"properties":{"identity_provider":{"description":"The full resource name of the workload identity provider","example":"https://iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/snyk-workload-identity-123/providers/snyk-identity-provider-123","format":"uri","type":"string"},"project_id":{"description":"Google project ID","example":"demo-project","type":"string"},"service_account_email":{"description":"Google service account email","example":"snyk-demo@demo-project.iam.gserviceaccount.com","format":"email","type":"string"}},"required":["service_account_email","identity_provider"],"type":"object"},"GrantType":{"description":"An authorization grant is a credential representing the resource owner's authorization (to access its protected resources) used by the client to obtain an access token. The grant type represents the way your app will get the access token.","enum":["authorization_code","client_credentials"],"type":"string"},"GrantType20220311":{"description":"An authorization grant is a credential representing the resource owner's authorization (to access its protected resources) used by the client to obtain an access token.","enum":["authorization_code","client_credentials"],"type":"string"},"Group":{"additionalProperties":true,"properties":{"attributes":{"additionalProperties":true,"properties":{"name":{"description":"The name of the group.","example":"My Group","type":"string"}},"required":["name"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"description":"Content type.","example":"group","type":"string"}},"required":["type","id","attributes"],"type":"object"},"GroupAttributes":{"example":{"created_at":"2022-03-16T00:00:00Z","name":"My Group","updated_at":"2022-03-16T00:00:00Z"},"properties":{"avatar_url":{"description":"The URL of an image to use as the group's avatar.","format":"uri","type":"string"},"created_at":{"description":"The time the group was created.","format":"date-time","type":"string"},"logo_url":{"description":"The URL of an image to use as the group's logo.","format":"uri","type":"string"},"name":{"description":"The name of the group.","type":"string"},"slug":{"description":"A slug uniquely identifying the group","type":"string"},"updated_at":{"description":"The time the group was created.","format":"date-time","type":"string"}},"required":["name","created_at","updated_at"],"type":"object"},"GroupFieldAttributes":{"additionalProperties":false,"properties":{"asset_types":{"description":"List of asset types this field applies to","items":{"type":"string"},"type":"array"},"name":{"description":"The field name used for grouping (e.g., \"class\", \"registry\")","type":"string"}},"required":["name","asset_types"],"type":"object"},"GroupFieldData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/GroupFieldAttributes"},"id":{"description":"UUID identifier for the group field","format":"uuid","type":"string"},"relationships":{"description":"Relationships for this group field","properties":{"values":{"properties":{"links":{"properties":{"related":{"description":"Relative path to get aggregated values for this group field","format":"uri-reference","type":"string"}},"required":["related"],"type":"object"}},"type":"object"}},"type":"object"},"type":{"description":"The JSON:API resource type","enum":["group_fields"],"type":"string"}},"required":["type","id"],"type":"object"},"GroupFieldsResponse":{"additionalProperties":false,"properties":{"data":{"description":"List of available group fields","items":{"$ref":"#/components/schemas/GroupFieldData"},"type":"array"},"links":{"description":"Self-referencing link","properties":{"self":{"description":"Link to the current resource","format":"uri","type":"string"}},"required":["self"],"type":"object"}},"required":["data","links"],"type":"object"},"GroupFilters":{"allOf":[{"$ref":"#/components/schemas/BaseFilters"},{"properties":{"orgs":{"items":{"format":"uuid","type":"string"},"type":"array"}},"type":"object"}]},"GroupIacSettingsRequest":{"description":"The Infrastructure as Code settings for a group.","properties":{"attributes":{"properties":{"custom_rules":{"additionalProperties":false,"description":"The Infrastructure as Code custom rules settings for a group.","minProperties":1,"properties":{"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"}},"type":"object"}},"type":"object"},"type":{"description":"Content type","example":"iac_settings","type":"string"}},"required":["type","attributes"],"type":"object"},"GroupIacSettingsResponse":{"description":"The Infrastructure as Code settings for a group.","properties":{"attributes":{"properties":{"custom_rules":{"description":"The Infrastructure as Code custom rules settings for a group.","properties":{"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"}},"type":"object"},"updated":{"$ref":"#/components/schemas/Updated"}},"type":"object"},"id":{"description":"ID","example":"ea536a06-0566-40ca-b96b-155568aa2027","format":"uuid","type":"string"},"type":{"description":"Content type","example":"iac_settings","type":"string"}},"type":"object"},"GroupId":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"GroupMembership":{"additionalProperties":false,"properties":{"attributes":{"properties":{"created_at":{"description":"The date that the group membership was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time"}},"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/GroupMembershipRelationships"},"type":{"description":"Content type.","example":"group_membership","type":"string"}},"required":["type","id","attributes","relationships"],"type":"object"},"GroupMembershipAttributes":{"additionalProperties":false,"properties":{"created_at":{"description":"The time when this group membership was created","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["created_at"],"type":"object"},"GroupMembershipGroupData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"name":{"description":"The name of the group","example":"Example group","type":"string"}},"required":["name"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"group","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"GroupMembershipMeta":{"additionalProperties":false,"properties":{"group_membership_count":{"type":"number"}},"type":"object"},"GroupMembershipOrgMembership":{"additionalProperties":false,"properties":{"attributes":{"properties":{"created_at":{"description":"The date that the org membership was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time"}},"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"org_membership_count":{"description":"Org memberships for this user within this group.","type":"number"},"relationships":{"$ref":"#/components/schemas/GroupMembershipOrgMembershipRelationships"},"type":{"description":"Content type.","example":"org_membership","type":"string"}},"required":["type","id","attributes","relationships"],"type":"object"},"GroupMembershipOrgMembershipOrgData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"name":{"description":"The name of the prg","example":"Example org","type":"string"}},"required":["name"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"org","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"GroupMembershipOrgMembershipRelationships":{"additionalProperties":false,"properties":{"org":{"$ref":"#/components/schemas/GroupMembershipOrgMembershipOrgData"},"role":{"$ref":"#/components/schemas/GroupMembershipOrgMembershipRoleData"},"user":{"$ref":"#/components/schemas/GroupMembershipOrgMembershipUserData"}},"required":["role","org","user"],"type":"object"},"GroupMembershipOrgMembershipRoleData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"name":{"description":"The name of the role","example":"Admin role","type":"string"}},"required":["name"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"org_role","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"GroupMembershipOrgMembershipUserData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"email":{"description":"The eamil of the user","example":"user@test.com","type":"string"},"name":{"description":"The name of the user","example":"User2","type":"string"},"username":{"description":"The username of the user","example":"User name 2","type":"string"}},"required":["name","username","email"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"user","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"GroupMembershipRelationships":{"additionalProperties":false,"properties":{"group":{"$ref":"#/components/schemas/GroupMembershipGroupData"},"role":{"$ref":"#/components/schemas/GroupMembershipRoleData"},"user":{"$ref":"#/components/schemas/GroupMembershipUserData"}},"required":["role","group","user"],"type":"object"},"GroupMembershipResponseData":{"additionalProperties":false,"items":{"properties":{"attributes":{"$ref":"#/components/schemas/GroupMembershipAttributes"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"meta":{"$ref":"#/components/schemas/GroupMembershipMeta"},"relationships":{"$ref":"#/components/schemas/GroupMembershipRelationships"},"type":{"description":"Content type","example":"group_membership","type":"string"}},"type":"object"},"type":"array"},"GroupMembershipRoleData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"name":{"description":"The name of the role","example":"Admin role","type":"string"}},"required":["name"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"group_role","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"GroupMembershipUserData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"email":{"description":"The email of the user","example":"user@test.com","type":"string"},"login_method":{"description":"The login method of the user","type":"string"},"name":{"description":"The name of the user","example":"User2","type":"string"},"username":{"description":"The username of the user","example":"User name 2","type":"string"}},"required":["name","username","email"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"user","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"GroupPolicyAction":{"oneOf":[{"$ref":"#/components/schemas/GroupPolicyActionIgnore"},{"$ref":"#/components/schemas/GroupPolicyActionAnnotation"},{"$ref":"#/components/schemas/GroupPolicyActionSeverityOverride"}]},"GroupPolicyActionAnnotation":{"additionalProperties":false,"description":"Annotation action","properties":{"data":{"$ref":"#/components/schemas/GroupPolicyActionAnnotationData"}},"required":["data"],"type":"object"},"GroupPolicyActionAnnotationData":{"additionalProperties":false,"properties":{"reason":{"type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"GroupPolicyActionIgnore":{"additionalProperties":false,"description":"Ignore action","properties":{"data":{"$ref":"#/components/schemas/GroupPolicyActionIgnoreData"}},"required":["data"],"type":"object"},"GroupPolicyActionIgnoreData":{"additionalProperties":false,"properties":{"ignore_type":{"enum":["wont-fix","not-vulnerable","temporary-ignore"],"type":"string","x-enum-varnames":["GroupPolicyWontFix","GroupPolicyNotVulnerable","GroupPolicyTemporaryIgnore"]},"reason":{"maxLength":10000,"type":"string"}},"required":["ignore_type"],"type":"object"},"GroupPolicyActionSeverityOverride":{"additionalProperties":false,"description":"Severity override action","properties":{"data":{"$ref":"#/components/schemas/GroupPolicyActionSeverityOverrideData"}},"required":["data"],"type":"object"},"GroupPolicyActionSeverityOverrideData":{"additionalProperties":false,"properties":{"reason":{"type":"string"},"severity":{"$ref":"#/components/schemas/SeverityLevel"}},"required":["severity"],"type":"object"},"GroupPolicyActionType":{"enum":["ignore","annotation","severity-override"],"type":"string"},"GroupPolicyConditionBusinessCriticality":{"additionalProperties":false,"description":"Matches on the project business criticality - if business criticality is provided, the policy will only apply to projects with the specified business criticality.","properties":{"field":{"enum":["business-criticality"],"type":"string","x-enum-varnames":["GroupPolicyBusinessCriticality"]},"operator":{"$ref":"#/components/schemas/GroupPolicyConditionOperator"},"value":{"items":{"enum":["low","medium","high","critical"],"type":"string"},"minItems":1,"type":"array"}},"required":["field","operator","value"],"type":"object"},"GroupPolicyConditionCVE":{"additionalProperties":false,"description":"Matches on the CVE.","properties":{"field":{"enum":["cve"],"type":"string","x-enum-varnames":["GroupPolicyCVE"]},"operator":{"$ref":"#/components/schemas/GroupPolicyConditionOperator"},"value":{"items":{"type":"string"},"minItems":1,"type":"array"}},"required":["field","operator","value"],"type":"object"},"GroupPolicyConditionCWE":{"additionalProperties":false,"description":"Matches on the CWE.","properties":{"field":{"enum":["cwe"],"type":"string","x-enum-varnames":["GroupPolicyCWE"]},"operator":{"$ref":"#/components/schemas/GroupPolicyConditionOperator"},"value":{"items":{"type":"string"},"minItems":1,"type":"array"}},"required":["field","operator","value"],"type":"object"},"GroupPolicyConditionEnvironment":{"additionalProperties":false,"description":"Matches on the project environment - if environment is provided, the policy will only apply to projects with the specified environment.","properties":{"field":{"enum":["environment"],"type":"string","x-enum-varnames":["GroupPolicyEnvironment"]},"operator":{"$ref":"#/components/schemas/GroupPolicyConditionOperator"},"value":{"items":{"enum":["frontend","backend","mobile","internal","external","saas","on-prem","hosted","distributed"],"type":"string"},"minItems":1,"type":"array"}},"required":["field","operator","value"],"type":"object"},"GroupPolicyConditionExploitMaturity":{"additionalProperties":false,"description":"Matches on the exploit maturity.","properties":{"field":{"enum":["exploit-maturity"],"type":"string","x-enum-varnames":["GroupPolicyExploitMaturity"]},"operator":{"$ref":"#/components/schemas/GroupPolicyConditionOperator"},"value":{"items":{"enum":["mature","proof-of-concept","no-known-exploit","no-data"],"type":"string"},"minItems":1,"type":"array"}},"required":["field","operator","value"],"type":"object"},"GroupPolicyConditionLifecycle":{"additionalProperties":false,"description":"Matches on the project lifecycle - if lifecycle is provided, the policy will only apply to projects with the specified lifecycle.","properties":{"field":{"enum":["lifecycle"],"type":"string","x-enum-varnames":["GroupPolicyLifecycle"]},"operator":{"$ref":"#/components/schemas/GroupPolicyConditionOperator"},"value":{"items":{"enum":["development","production","sandbox"],"type":"string"},"minItems":1,"type":"array"}},"required":["field","operator","value"],"type":"object"},"GroupPolicyConditionOperator":{"enum":["includes","not-includes"],"type":"string","x-enum-varnames":["GroupPolicyIncludes","GroupPolicyNotIncludes"]},"GroupPolicyConditionOrgID":{"additionalProperties":false,"description":"Matches on the organization ID - if org ID is provided, the policy will only apply to the specified organization. If no org ID is provided, the policy will apply to all organizations.","properties":{"field":{"enum":["org-id"],"type":"string","x-enum-varnames":["GroupPolicyOrgID"]},"operator":{"$ref":"#/components/schemas/GroupPolicyConditionOperator"},"value":{"items":{"format":"uuid","type":"string"},"minItems":1,"type":"array"}},"required":["field","operator","value"],"type":"object"},"GroupPolicyConditionProjectTags":{"additionalProperties":false,"description":"Matches on the project tags - if project tags are provided, the policy will only apply to projects with the specified tags.\nThe value is a list of key:value pairs.\nThe key and value must be Alphanumeric including - and _ with a limit of 30 characters for each key and value.\n","properties":{"field":{"enum":["project-tags"],"type":"string","x-enum-varnames":["GroupPolicyProjectTags"]},"operator":{"$ref":"#/components/schemas/GroupPolicyConditionOperator"},"value":{"items":{"example":"key:value","pattern":"^[A-Za-z0-9_-]{1,30}:[A-Za-z0-9_-]{1,30}$","type":"string"},"minItems":1,"type":"array"}},"required":["field","operator","value"],"type":"object"},"GroupPolicyConditionRuleId":{"additionalProperties":false,"description":"Matches on the rule ID.","properties":{"field":{"enum":["rule-id"],"type":"string","x-enum-varnames":["GroupPolicyRuleId"]},"operator":{"$ref":"#/components/schemas/GroupPolicyConditionOperator"},"value":{"items":{"type":"string"},"minItems":1,"type":"array"}},"required":["field","operator","value"],"type":"object"},"GroupPolicyConditionSeverity":{"additionalProperties":false,"description":"Matches on the severity.","properties":{"field":{"enum":["severity"],"type":"string","x-enum-varnames":["GroupPolicySeverity"]},"operator":{"$ref":"#/components/schemas/GroupPolicyConditionOperator"},"value":{"items":{"enum":["low","medium","high","critical"],"type":"string"},"minItems":1,"type":"array"}},"required":["field","operator","value"],"type":"object"},"GroupPolicyConditionSnykAssetFindingV1":{"additionalProperties":false,"description":"Matches on the Snyk Asset Finding V1 identifier.","properties":{"field":{"enum":["snyk/asset/finding/v1"],"type":"string","x-enum-varnames":["GroupPolicySnykAssetFindingV1"]},"operator":{"$ref":"#/components/schemas/GroupPolicyConditionOperator"},"value":{"items":{"format":"uuid","type":"string"},"minItems":1,"type":"array"}},"required":["field","operator","value"],"type":"object"},"GroupPolicyConditionSnykId":{"additionalProperties":false,"description":"Matches on the Snyk ID.","properties":{"field":{"enum":["snyk-id"],"type":"string","x-enum-varnames":["GroupPolicySnykId"]},"operator":{"$ref":"#/components/schemas/GroupPolicyConditionOperator"},"value":{"items":{"type":"string"},"minItems":1,"type":"array"}},"required":["field","operator","value"],"type":"object"},"GroupPolicyConditionsGroup":{"additionalProperties":false,"properties":{"conditions":{"items":{"anyOf":[{"$ref":"#/components/schemas/GroupPolicyConditionExploitMaturity"},{"$ref":"#/components/schemas/GroupPolicyConditionSnykAssetFindingV1"},{"$ref":"#/components/schemas/GroupPolicyConditionRuleId"},{"$ref":"#/components/schemas/GroupPolicyConditionSeverity"},{"$ref":"#/components/schemas/GroupPolicyConditionCWE"},{"$ref":"#/components/schemas/GroupPolicyConditionCVE"},{"$ref":"#/components/schemas/GroupPolicyConditionSnykId"},{"$ref":"#/components/schemas/GroupPolicyConditionOrgID"},{"$ref":"#/components/schemas/GroupPolicyConditionProjectTags"},{"$ref":"#/components/schemas/GroupPolicyConditionBusinessCriticality"},{"$ref":"#/components/schemas/GroupPolicyConditionEnvironment"},{"$ref":"#/components/schemas/GroupPolicyConditionLifecycle"}]},"minItems":1,"type":"array"},"logical_operator":{"$ref":"#/components/schemas/GroupPolicyOperator"}},"required":["logical_operator","conditions"],"type":"object"},"GroupPolicyOperator":{"enum":["and"],"type":"string","x-enum-varnames":["GroupPolicyAnd"]},"GroupPolicyPrincipal":{"additionalProperties":false,"properties":{"email":{"nullable":true,"type":"string"},"id":{"description":"The Snyk ID corresponding to this user or service account that created the policy","format":"uuid","type":"string"},"name":{"description":"Name of the user or service account that created the policy","type":"string"}},"required":["name","id"],"type":"object"},"GroupPolicyRequestAttributes":{"additionalProperties":false,"properties":{"action":{"$ref":"#/components/schemas/GroupPolicyAction"},"action_type":{"$ref":"#/components/schemas/GroupPolicyActionType"},"conditions_group":{"$ref":"#/components/schemas/GroupPolicyConditionsGroup"},"name":{"type":"string"}},"required":["name","conditions_group","action_type","action"],"type":"object"},"GroupPolicyResponse":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/GroupPolicyResponseAttributes"},"id":{"description":"A unique identifier for this particular occurrence of the group level policy.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"type":{"enum":["policy"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"GroupPolicyResponseAttributes":{"additionalProperties":false,"properties":{"action":{"$ref":"#/components/schemas/GroupPolicyAction"},"action_type":{"$ref":"#/components/schemas/GroupPolicyActionType"},"conditions_group":{"$ref":"#/components/schemas/GroupPolicyConditionsGroup"},"created_at":{"example":"2024-03-16T00:00:00Z","format":"date-time","type":"string"},"created_by":{"$ref":"#/components/schemas/GroupPolicyPrincipal"},"name":{"type":"string"},"updated_at":{"example":"2024-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["name","conditions_group","action_type","action","created_by","created_at","updated_at"],"type":"object"},"GroupRelationships":{"properties":{"tenant":{"properties":{"data":{"properties":{"id":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"GroupResponse":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/GroupAttributes"},"id":{"$ref":"#/components/schemas/GroupId"},"relationships":{"$ref":"#/components/schemas/GroupRelationships"},"type":{"$ref":"#/components/schemas/GroupType"}},"required":["id","type","attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data","jsonapi","links"],"type":"object"},"GroupType":{"description":"The type of the resource for group operations","enum":["group"],"type":"string"},"GroupValueAttributes":{"additionalProperties":false,"properties":{"value":{"description":"The grouped value","type":"string"}},"required":["value"],"type":"object"},"GroupValueData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/GroupValueAttributes"},"id":{"description":"UUID identifier for the group value","format":"uuid","type":"string"},"meta":{"$ref":"#/components/schemas/GroupValueMeta"},"type":{"description":"The JSON:API resource type","enum":["group_values"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"GroupValueIssuesAggregation":{"additionalProperties":false,"description":"Aggregated issue counts from discovery sources across all assets in this group.\nCounts are summed from all project-type discovery sources.\n","properties":{"critical":{"description":"Total count of critical severity issues","minimum":0,"type":"integer"},"high":{"description":"Total count of high severity issues","minimum":0,"type":"integer"},"low":{"description":"Total count of low severity issues","minimum":0,"type":"integer"},"medium":{"description":"Total count of medium severity issues","minimum":0,"type":"integer"},"total":{"description":"Sum of all issue counts (critical + high + medium + low)","minimum":0,"type":"integer"}},"type":"object"},"GroupValueMeta":{"additionalProperties":false,"description":"Computed aggregations across all assets within this group value.\nFields are only present when explicitly requested via the `meta_fields` query parameter.\nIf `meta_fields` is not specified, the meta object is omitted from the response.\n","properties":{"count":{"description":"Number of assets with this value.","minimum":0,"type":"integer"},"issues":{"$ref":"#/components/schemas/GroupValueIssuesAggregation"},"labels":{"description":"Unique labels across all assets in this group.\nLimited to the first 1000 unique labels (alphabetically sorted).\nEmpty array if no assets have labels.\n","items":{"type":"string"},"maxItems":1000,"type":"array"},"last_seen_at":{"description":"Aggregated last_seen_at timestamp across all assets in this group.\nThe aggregation function is controlled by the `aggregate[last_seen_at]` parameter (default: last).\nNull if no assets have a last_seen_at value.\n","format":"date-time","type":"string"},"risk_score":{"description":"Aggregated risk_score from discovery sources across all assets in this group.\nThe aggregation function is controlled by the `aggregate[risk_score]` parameter (default: last).\nDerived from project-type discovery sources. Null if no assets have\ndiscovery sources with risk scores.\n","minimum":0,"type":"integer"},"tags":{"description":"Unique tags across all assets in this group.\nLimited to the first 1000 unique tags (alphabetically sorted).\nEmpty array if no assets have tags.\n","items":{"properties":{"key":{"description":"The tag key","type":"string"},"value":{"description":"The tag value","type":"string"}},"type":"object"},"maxItems":1000,"type":"array"},"updated_at":{"description":"Aggregated updated_at timestamp across all assets in this group.\nThe aggregation function is controlled by the `aggregate[updated_at]` parameter (default: last).\n","format":"date-time","type":"string"}},"type":"object"},"GroupValuesResponse":{"additionalProperties":false,"properties":{"data":{"description":"List of group values with their aggregated metadata","items":{"$ref":"#/components/schemas/GroupValueData"},"type":"array"},"links":{"description":"Self-referencing link","properties":{"self":{"description":"Link to the current resource","format":"uri","type":"string"}},"required":["self"],"type":"object"}},"required":["data","links"],"type":"object"},"HarborCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["harbor-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"History":{"description":"A single entry in the container image build history","properties":{"author":{"description":"Author of the layer","maxLength":128,"nullable":true,"type":"string"},"comment":{"description":"Comment for the layer","maxLength":4096,"nullable":true,"type":"string"},"created_at":{"description":"When the layer was created","format":"date-time","nullable":true,"type":"string"},"created_by":{"description":"Command that created the layer","maxLength":4096,"nullable":true,"type":"string"},"empty_layer":{"description":"Whether this is an empty layer (metadata-only)","nullable":true,"type":"boolean"}},"type":"object"},"IacScanConfiguration":{"description":"Scan configuration parameters for the IAC scanner.","type":"object"},"Id":{"format":"uuid","type":"string"},"IgnoreType":{"enum":["ignore"],"example":"ignore","type":"string"},"Image":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ImageAttributes"},"id":{"$ref":"#/components/schemas/ImageDigest"},"relationships":{"properties":{"image_target_refs":{"properties":{"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}},"type":"object"},"type":{"enum":["container_image"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"ImageAttributes":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/ImageDigest"},"minItems":1,"type":"array"},"names":{"items":{"$ref":"#/components/schemas/ImageName"},"type":"array"},"platform":{"$ref":"#/components/schemas/Platform"}},"required":["platform","layers"],"type":"object"},"ImageConfig":{"description":"Runtime configuration for the container (OCI image config).\nContains entrypoint, environment, exposed ports, volumes, labels, etc.\n","properties":{"args_escaped":{"description":"Whether args are escaped (Windows)","nullable":true,"type":"boolean"},"cmd":{"description":"Command to run","items":{"maxLength":1024,"type":"string"},"maxItems":500,"nullable":true,"type":"array"},"entry_point":{"description":"Entry point command","items":{"maxLength":1024,"type":"string"},"maxItems":500,"nullable":true,"type":"array"},"env":{"description":"Environment variables","items":{"maxLength":1024,"type":"string"},"maxItems":500,"nullable":true,"type":"array"},"exposed_ports":{"description":"Exposed ports in format \"port/protocol\" (e.g., \"8080/tcp\", \"53/udp\").\nPort is 0-65535, protocol is tcp or udp.\n","items":{"maxLength":64,"pattern":"^\\d{1,5}/(tcp|udp)$","type":"string"},"maxItems":500,"nullable":true,"type":"array"},"labels":{"additionalProperties":{"maxLength":1024,"type":"string"},"description":"Key-value labels from the image configuration","type":"object"},"stop_signal":{"description":"Signal to stop the container","maxLength":128,"nullable":true,"type":"string"},"user":{"description":"User that runs the container","maxLength":1024,"nullable":true,"type":"string"},"volumes":{"description":"Volume mount points","items":{"maxLength":1024,"type":"string"},"maxItems":500,"nullable":true,"type":"array"},"working_dir":{"description":"Working directory","maxLength":1024,"nullable":true,"type":"string"}},"type":"object"},"ImageDigest":{"example":"sha256:2bd864580926b790a22c8b96fd74496fe87b3c59c0774fe144bab2788e78e676","format":"uri","pattern":"^sha256(:|%3A)[a-f0-9]{64}$","type":"string"},"ImageInfo":{"description":"Container image with vulnerability summary","properties":{"issues_by_severity":{"description":"Issue counts by severity","properties":{"critical":{"type":"integer"},"high":{"type":"integer"},"low":{"type":"integer"},"medium":{"type":"integer"}},"type":"object"},"name":{"description":"Full image name","type":"string"},"repo":{"description":"Image repository","type":"string"},"tag":{"description":"Image tag","type":"string"},"total_issues":{"description":"Total number of issues across all severities","type":"integer"}},"required":["name","repo","tag","total_issues"],"type":"object"},"ImageName":{"example":"gcr.io/snyk/redis:5","pattern":"^((?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:(?:\\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(?::[0-9]+)?\\/)?[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?(?:(?:\\/[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?)+)?)(?::([\\w][\\w.-]{0,127}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][A-Fa-f0-9]{32,}))?$","type":"string"},"ImageTag":{"description":"A tag within a repository","properties":{"observed_at":{"description":"When the image was first observed","format":"date-time","type":"string"},"tag":{"description":"The tag name","type":"string"}},"required":["tag"],"type":"object"},"ImageTargetRef":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ImageTargetRefAttributes"},"id":{"example":"3cd4af4c-fb15-45c4-9acd-8e8fcc6690af","format":"uuid","type":"string"},"type":{"enum":["image_target_reference"],"type":"string"}},"type":"object"},"ImageTargetRefAttributes":{"properties":{"platform":{"$ref":"#/components/schemas/Platform"},"target_id":{"format":"uuid","type":"string"},"target_reference":{"type":"string"}},"type":"object"},"InheritFromParent":{"description":"Which parent to inherit settings from.","enum":["group"],"type":"string"},"InlineContent":{"allOf":[{"$ref":"#/components/schemas/DepGraphContent"}],"description":"Content formats accepted inline for testing.","type":"object"},"InlineResource":{"description":"Resource comprised of file contents included directly in\na request body.\n\nCurrently supported scans utilizing InlineResources are:\n- SCA (Open Source): (1) InlineResource containing a Dep Graph","example":{"content":{"dep_graph":{"graph":{"nodes":[{"deps":[],"nodeId":"root-node","pkgId":"snyk@1.0.0-monorepo"}],"rootNodeId":"root-node"},"pkgManager":{"name":"npm"},"pkgs":[{"id":"snyk@1.0.0-monorepo","info":{"name":"snyk","version":"1.0.0-monorepo"}}],"schemaVersion":"1.3.0"},"type":"dep_graph"},"name":"dep_graph.json","type":"inline"},"properties":{"name":{"maxLength":256,"type":"string"},"scm_context":{"$ref":"#/components/schemas/ScmContext"},"type":{"enum":["inline"],"type":"string"}},"required":["type","name"],"type":"object"},"InlineResourceCreateItem":{"description":"Resource comprised of file contents included directly in\na request body.\n\nCurrently supported scans utilizing InlineResources are:\n- SCA (Open Source): (1) InlineResource containing a Dep Graph","example":{"content":{"dep_graph":{"graph":{"nodes":[{"deps":[],"nodeId":"root-node","pkgId":"snyk@1.0.0-monorepo"}],"rootNodeId":"root-node"},"pkgManager":{"name":"npm"},"pkgs":[{"id":"snyk@1.0.0-monorepo","info":{"name":"snyk","version":"1.0.0-monorepo"}}],"schemaVersion":"1.3.0"},"type":"dep_graph"},"name":"dep_graph.json","type":"inline"},"properties":{"content":{"allOf":[{"$ref":"#/components/schemas/InlineContent"}],"description":"File contents to be tested."},"name":{"maxLength":256,"type":"string"},"scm_context":{"$ref":"#/components/schemas/ScmContext"},"type":{"enum":["inline"],"type":"string"}},"required":["type","name","content"],"type":"object"},"InstalledAt":{"description":"Timestamp at which this app was first installed at.","example":"2024-04-30T16:07:46.230044Z","format":"date-time","type":"string"},"IntegrationId":{"description":"Container Registry Integration ID","example":"365764ee-8a87-491a-9c9f-ad816f1238df","format":"uuid","type":"string"},"IntegrationRelationship":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"description":"Associated integration id","type":"string"},"integration_type":{"description":"Associated connection type","type":"string"},"org_id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"type":"object"}},"required":["data"],"type":"object"},"IntegrationRelationships":{"additionalProperties":false,"properties":{"integrations_relationships":{"items":{"$ref":"#/components/schemas/IntegrationRelationship"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["integrations_relationships"],"type":"object"},"IntegrationResource":{"additionalProperties":false,"properties":{"integration_id":{"format":"uuid","type":"string"},"type":{"description":"Connection type","example":"github","type":"string"}},"required":["type"],"type":"object"},"IsActive":{"description":"Current status of the project settings.","example":true,"type":"boolean"},"IsConfidential":{"description":"A boolean to indicate if an app is confidential or not as per the OAuth2 RFC. Confidential apps can securely store secrets. Examples of non-confidential apps are full web-based or CLIs.","example":true,"type":"boolean"},"IsConfidential20220311":{"description":"A boolean to indicate if an app is confidential or not as per the OAuth2 RFC.","example":true,"type":"boolean"},"IsEnabled":{"description":"Whether the custom rules feature is enabled or not.","example":true,"type":"boolean"},"IsPublic":{"description":"A boolean to indicate if an app is publicly available or not.","example":false,"type":"boolean"},"Issue":{"additionalProperties":false,"description":"A Snyk Issue.","properties":{"attributes":{"$ref":"#/components/schemas/IssueAttributes"},"id":{"example":"73832c6c-19ff-4a92-850c-2e1ff2800c16","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/IssueRelationships"},"type":{"$ref":"#/components/schemas/IssueType"}},"required":["id","type","attributes","relationships"],"type":"object"},"IssueAttributes":{"additionalProperties":false,"description":"issue attributes","properties":{"classes":{"description":"A list of details for weakness data, policy, etc that are the class of this issue's source.","items":{"$ref":"#/components/schemas/Class"},"maxItems":50,"minItems":1,"type":"array"},"coordinates":{"description":"Where the issue originated, specific to issue type. Details on what\ncode, package, etc introduced the issue. An issue may be caused by\nmore than one coordinate.\n","items":{"properties":{"created_at":{"description":"The time when this coordinate was created.","format":"date-time","type":"string"},"is_fixable_manually":{"description":"Indicates whether a issue can be fixed manually by the user. This typically involves making changes directly to the code or configuration to address the issue.","type":"boolean"},"is_fixable_snyk":{"description":"Indicates whether Snyk can automatically provide a fix for the issue. Snyk might offer solutions like patches or upgrades that can be applied directly through its platform.","type":"boolean"},"is_fixable_upstream":{"description":"Indicates whether a fix is available from the upstream source, such as the original package maintainers. It means that the issue can be resolved by updating to a version where the maintainers have already addressed the vulnerability.","type":"boolean"},"is_patchable":{"description":"Indicates whether the issue can be fixed by applying a patch. Patches are specific code changes that address vulnerabilities without requiring a full upgrade of the package.","type":"boolean"},"is_pinnable":{"description":"Indicates whether the issue can be fixed by pinning the dependency to a specific version. Pinning involves locking the dependency to a version that is known to be secure.","type":"boolean"},"is_upgradeable":{"description":"Indicates whether the issue can be resolved by upgrading the package to a newer version. Upgrading typically involves moving to a version where the vulnerability has been fixed.","type":"boolean"},"last_introduced_at":{"description":"The time when this coordinate was last introduced.","format":"date-time","type":"string"},"last_resolved_at":{"description":"The time when this coordinate was last resolved.","format":"date-time","type":"string"},"last_resolved_details":{"description":"Optional details about the last resolution of this coordinate.","type":"string"},"reachability":{"description":"- function and package are both presented in e.g. reporting as \"Reachable\", meaning that a direct or indirect path was found from the application to the vulnerable code.\n- no-info is presented as \"No path found\", meaning that there was no path found from the application to the vulnerable code.\n- not-applicable is presented as \"Not applicable\" and it means that reachability information isn't applicable to the issue. E.g we do not provide reachability info for Snyk container issues.\n","enum":["function","package","no-info","not-applicable"],"type":"string"},"remedies":{"items":{"additionalProperties":false,"properties":{"correlation_id":{"description":"An optional identifier for correlating remedies between coordinates or across issues. They are scoped\nto a single Project and test run. Remedies with the same correlation_id must have the same contents.\n","maxLength":256,"minLength":1,"type":"string"},"description":{"description":"A markdown-formatted optional description of this remedy. Links are not permitted.","maxLength":4096,"minLength":1,"type":"string"},"meta":{"additionalProperties":false,"properties":{"data":{"additionalProperties":true,"description":"Metadata information related to apply a remedy. Limited in size to 100Kb when JSON serialized.","type":"object"},"schema_version":{"description":"A schema version identifier the metadata object validates against. Note: this information is\nonly relevant in the domain of the API consumer: the issues system always considers metadata\njust as an arbitrary object.\n","maxLength":256,"minLength":1,"type":"string"}},"required":["data","schema_version"],"type":"object"},"type":{"enum":["indeterminate","manual","automated","rule_result_message","terraform","cloudformation","cli","kubernetes","arm"],"type":"string"}},"required":["type"],"type":"object"},"maxItems":5,"minItems":1,"type":"array"},"representations":{"description":"A list of precise locations that surface an issue. A coordinate may have multiple representations.\n","items":{"oneOf":[{"description":"An object that contains an opaque identifying string.","properties":{"resourcePath":{"maxLength":2024,"minLength":1,"type":"string"}},"required":["resourcePath"],"type":"object"},{"description":"An object that contains a list of opaque identifying strings.","properties":{"dependency":{"properties":{"package_name":{"description":"The package name the issue was found in","maxLength":2048,"minLength":1,"type":"string"},"package_version":{"description":"The package version the issue was found in","maxLength":2048,"minLength":1,"type":"string"}},"required":["package_name","package_version"],"type":"object"}},"required":["dependency"],"type":"object"},{"description":"A resource location to some service, like a cloud resource. Only available for issue type 'cloud' and 'iac'.","properties":{"cloud_resource":{"properties":{"environment":{"properties":{"id":{"description":"Internal ID for an environment.","format":"uuid","type":"string"},"name":{"maxLength":256,"minLength":1,"type":"string"},"native_id":{"description":"An optional native identifier for this environment. For example, a cloud account id.","maxLength":2048,"minLength":1,"type":"string"},"type":{"enum":["aws","azure","azure_ad","google","scm","cli","tfc"],"type":"string"}},"required":["id","type","name"],"type":"object"},"resource":{"properties":{"iac_mappings_count":{"description":"Amount of IaC resources this resource maps to.","format":"int64","minimum":0,"type":"integer"},"id":{"description":"Internal ID for a resource.","format":"uuid","type":"string"},"input_type":{"enum":["cloud_scan","arm","k8s","tf","tf_hcl","tf_plan","tf_state","cfn"],"type":"string"},"location":{"maxLength":256,"minLength":1,"type":"string"},"name":{"minLength":1,"type":"string"},"native_id":{"description":"An optional native identifier for this resource. For example, a cloud resource id.","maxLength":2048,"minLength":1,"type":"string"},"platform":{"maxLength":256,"minLength":1,"type":"string"},"resource_type":{"maxLength":256,"minLength":1,"type":"string"},"tags":{"additionalProperties":{"maxLength":256,"type":"string"},"type":"object"},"type":{"enum":["cloud","iac"],"type":"string"}},"required":["input_type"],"type":"object"}},"required":["environment"],"type":"object"}},"required":["cloud_resource"],"type":"object"},{"description":"A location within a file.","properties":{"sourceLocation":{"properties":{"commit_id":{"description":"The git commit ID containing this issue.","type":"string"},"file":{"description":"A path to the file containing this issue, relative to the root of the project target,\nformatted using POSIX separators.\n","maximum":2048,"minimum":1,"type":"string"},"region":{"properties":{"end":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"},"start":{"properties":{"column":{"minimum":0,"type":"integer"},"line":{"minimum":0,"type":"integer"}},"required":["line","column"],"type":"object"}},"required":["start","end"],"type":"object"}},"required":["file"],"type":"object"}},"required":["sourceLocation"],"type":"object"}]},"minItems":1,"type":"array"},"state":{"description":"The state of this coordinate.","enum":["open","resolved"],"type":"string"},"updated_at":{"description":"The time when this coordinate was last updated.","format":"date-time","type":"string"}},"type":"object"},"minItems":1,"type":"array"},"created_at":{"description":"The creation time of this issue.","format":"date-time","type":"string"},"description":{"description":"A markdown-formatted optional description of this issue. Links are not permitted.","example":"Affected versions of this package are vulnerable to Prototype Pollution.\nThe utilities function allow modification of the `Object` prototype.\nIf an attacker can control part of the structure passed to this function,\nthey could add or modify an existing property.\n","maxLength":4096,"minLength":1,"type":"string"},"effective_severity_level":{"description":"The computed effective severity of this issue. This is either the highest level from all included severities,\nor an overridden value set via group level policy.\n","enum":["info","low","medium","high","critical"],"type":"string"},"exploit_details":{"additionalProperties":false,"properties":{"maturity_levels":{"items":{"additionalProperties":false,"properties":{"format":{"example":"CVSS_v4","minLength":1,"type":"string"},"level":{"example":"attacked","minLength":1,"type":"string"}},"required":["format","level"],"type":"object"},"type":"array"},"sources":{"example":["CISA"],"items":{"type":"string"},"type":"array"}},"required":["sources","maturity_levels"],"type":"object"},"ignored":{"description":"A flag indicating if the issue is being ignored. Derived from the issue's ignore, which provides more details.","type":"boolean"},"key":{"description":"An opaque key used for uniquely identifying this issue across test runs, within a project.","example":"24018479-6bb1-4196-a41b-e54c7c5dcc82:1c6ddc45.7f41fd64.a214ef38.72ad650e.f0ecbaa5.18c3080a.b570850e.89112ac5.1a6d2cd5.71413d6f.a924ef28.71cdd50e.d0e1bea5.52c3a80a.1a0c4319.a9127ac5:1","maxLength":2048,"type":"string"},"key_asset":{"description":"SAST identifier that allows the identification of Snyk Code issues with a unique ID per repository.","example":"1662bb2e-4c43-4f2c-83e1-ee5e0e009999","maxLength":37,"type":"string"},"problems":{"description":"A list of details for vulnerability data, policy, etc that are the source of this issue.","items":{"$ref":"#/components/schemas/Problem"},"minItems":1,"type":"array"},"resolution":{"$ref":"#/components/schemas/Resolution"},"risk":{"$ref":"#/components/schemas/Risk"},"severities":{"items":{"$ref":"#/components/schemas/CVSSSource"},"type":"array"},"status":{"description":"The issue's status. Derived from the issue's resolution, which provides more details.","enum":["open","resolved"],"type":"string"},"title":{"description":"A human-readable title for this issue.","example":"Insecure hash function used","maxLength":2048,"minLength":1,"type":"string"},"tool":{"description":"An opaque identifier for corelating across test runs.","example":"snyk://npm-deps","maxLength":1024,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/TypeDef"},"updated_at":{"description":"The time when this issue was last modified.","format":"date-time","type":"string"}},"required":["key","title","type","effective_severity_level","created_at","updated_at","status","ignored"],"type":"object"},"IssueCounts":{"description":"Issue counts by severity","properties":{"critical":{"description":"Count of critical severity issues","format":"int32","minimum":0,"type":"integer"},"high":{"description":"Count of high severity issues","format":"int32","minimum":0,"type":"integer"},"low":{"description":"Count of low severity issues","format":"int32","minimum":0,"type":"integer"},"medium":{"description":"Count of medium severity issues","format":"int32","minimum":0,"type":"integer"}},"required":["critical","high","medium","low"],"type":"object"},"IssueRelationships":{"additionalProperties":false,"description":"issue relationships","example":{"ignore":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5d","type":"ignore"}},"organization":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5b","type":"organization"}},"scan_item":{"data":{"id":"a3952187-0d8e-45d8-9aa2-036642857b5c","type":"project"}},"test_executions":{"data":[{"id":"0086e1bc-7c27-4f2e-9a99-5fe793ba4bef","type":"test-workflow-execution"}]}},"properties":{"ignore":{"description":"An optional reference to an ignore rule that marks this issue as ignored.","properties":{"data":{"properties":{"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","type":"string"},"type":{"$ref":"#/components/schemas/IgnoreType"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"organization":{"properties":{"data":{"properties":{"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/OrganizationType"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"scan_item":{"properties":{"data":{"properties":{"id":{"example":"5a19d42f-31bc-4ad0-b127-b79a3270db08","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/ScanItemType"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"test_executions":{"description":"The \"test execution\" that identified this Issues. This ID represents\na grouping of issues, that were identified by some analysis run, to produce\nIssues.\n","properties":{"data":{"description":"List of metadata associated with the test executions that identified this issue","items":{"properties":{"id":{"example":"3344947d-a5c3-4e20-928b-385a5d8792a3","type":"string"},"type":{"$ref":"#/components/schemas/TestExecutionType"}},"required":["type","id"],"type":"object"},"maxItems":25,"type":"array"}},"required":["data"],"type":"object"}},"required":["organization","scan_item"],"type":"object"},"IssueType":{"enum":["issue"],"example":"issue","type":"string"},"IssuesCountAttributes":{"example":{"critical":5,"high":12,"low":3,"medium":7},"properties":{"critical":{"description":"Number of critical issues","type":"integer"},"high":{"description":"Number of high-severity issues","type":"integer"},"low":{"description":"Number of low-severity issues","type":"integer"},"medium":{"description":"Number of medium-severity issues","type":"integer"}},"type":"object"},"IssuesMeta":{"properties":{"package":{"$ref":"#/components/schemas/PackageMeta__0"}},"type":"object"},"IssuesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CommonIssueModelVThree"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"},"meta":{"$ref":"#/components/schemas/IssuesMeta"}},"type":"object"},"IssuesWithPurlsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CommonIssueModelVThree"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"},"meta":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"type":"array"}},"type":"object"}},"type":"object"},"Jira":{"properties":{"jira_hostname":{"example":"jira.yourdomain.com","type":"string"},"jira_password":{"format":"uuid","type":"string"},"jira_username":{"example":"\u003cjira-username\u003e","type":"string"}},"required":["jira_hostname","jira_password","jira_username"],"type":"object"},"JiraAttributes":{"properties":{"required":{"oneOf":[{"$ref":"#/components/schemas/Jira"},{"$ref":"#/components/schemas/JiraBearerAuth"}]},"type":{"enum":["jira"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"JiraBearerAuth":{"properties":{"jira_hostname":{"example":"jira.yourdomain.com","type":"string"},"jira_pat":{"format":"uuid","type":"string"}},"required":["jira_hostname","jira_pat"],"type":"object"},"JobAttributes":{"description":"JobAttributes represents the attributes of a Job resource","properties":{"status":{"$ref":"#/components/schemas/JobState"}},"required":["status"],"type":"object"},"JobData":{"properties":{"attributes":{"$ref":"#/components/schemas/JobAttributes"},"id":{"format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/JobDataRelationships"},"type":{"enum":["ai_bom_job"],"type":"string"}},"required":["id","attributes","type"],"type":"object"},"JobDataRelationships":{"properties":{"ai_bom":{"$ref":"#/components/schemas/RelationshipObjectToOne"}},"required":["ai_bom"],"type":"object"},"JobState":{"description":"State of the job.","enum":["processing","finished","errored"],"type":"string"},"JsonApi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"},"JsonApiLinks":{"description":"Links for relationship objects within a resource","properties":{"related":{"description":"Link to the related resource(s)","format":"uri","type":"string"},"self":{"description":"Link to the relationship itself","format":"uri","type":"string"}},"type":"object"},"JsonApiVersion":{"properties":{"version":{"description":"JSON:API specification version","example":"1.0","type":"string"}},"required":["version"],"type":"object"},"LabelsReplace":{"description":"Full replacement of all labels on the asset.\nAll existing labels will be removed and replaced with the provided labels.\n","items":{"maxLength":40,"minLength":1,"pattern":"^[a-zA-Z0-9_/:?#@\u0026=+%~-]+$","type":"string"},"maxItems":50,"type":"array"},"LabelsUpdate":{"additionalProperties":false,"description":"Updates the asset's labels by adding or removing label values.\nAt least one of 'add' or 'remove' must be provided.\n","minProperties":1,"properties":{"add":{"description":"Labels to add to the asset.\nLabels must be 1-40 characters and contain only alphanumeric characters and _/:?#@\u0026=+%~- symbols.\n","items":{"maxLength":40,"minLength":1,"pattern":"^[a-zA-Z0-9_/:?#@\u0026=+%~-]+$","type":"string"},"maxItems":50,"type":"array"},"remove":{"description":"Labels to remove from the asset.\nLabels must be 1-40 characters and contain only alphanumeric characters and _/:?#@\u0026=+%~- symbols\n","items":{"maxLength":40,"minLength":1,"pattern":"^[a-zA-Z0-9_/:?#@\u0026=+%~-]+$","type":"string"},"maxItems":50,"type":"array"}},"type":"object"},"LatestDependencyTotal":{"additionalProperties":false,"properties":{"total":{"type":"number"},"updated_at":{"format":"date-time","type":"string"}},"type":"object"},"LatestIssueCounts":{"additionalProperties":false,"properties":{"critical":{"type":"number"},"high":{"type":"number"},"low":{"type":"number"},"medium":{"type":"number"},"updated_at":{"format":"date-time","type":"string"}},"type":"object"},"LessonAssignmentCreationAttributes":{"properties":{"due_date":{"format":"date","type":"string"},"lesson_id":{"type":"string"},"user_id":{"format":"uuid","type":"string"}},"required":["user_id","lesson_id"],"type":"object"},"LessonAssignmentDecoratedAttributes":{"allOf":[{"$ref":"#/components/schemas/LessonAssignmentRecordAttributes"},{"properties":{"assigning_user_email":{"type":"string"},"is_active":{"type":"boolean"},"learning_path_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"learning_program_id":{"format":"uuid","type":"string"},"lesson_created_at":{"format":"date-time","type":"string"},"lesson_slug":{"type":"string"},"lesson_title":{"type":"string"},"lesson_updated_at":{"format":"date-time","type":"string"},"user_email":{"format":"email","type":"string"}},"required":["user_email","lesson_title","lesson_slug","lesson_created_at","lesson_updated_at"],"type":"object"}]},"LessonAssignmentDecoratedResource":{"properties":{"attributes":{"$ref":"#/components/schemas/LessonAssignmentDecoratedAttributes"},"id":{"format":"uuid","type":"string"},"type":{"enum":["lesson_assignment"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"LessonAssignmentRecordAttributes":{"allOf":[{"$ref":"#/components/schemas/LessonAssignmentCreationAttributes"},{"properties":{"assigning_user_id":{"format":"uuid","type":"string"},"completed_date":{"format":"date-time","type":"string"},"created_at":{"format":"date-time","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["created_at","updated_at","assigning_user_id"],"type":"object"}]},"LinkProperty":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["href"],"type":"object"}]},"Links":{"additionalProperties":false,"properties":{"first":{"$ref":"#/components/schemas/LinkProperty"},"last":{"$ref":"#/components/schemas/LinkProperty"},"next":{"$ref":"#/components/schemas/LinkProperty"},"prev":{"$ref":"#/components/schemas/LinkProperty"},"related":{"$ref":"#/components/schemas/LinkProperty"},"self":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"ListBrokerConnectionsResponse":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/BrokerConnectionResponseResource"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"ListBrokerConnectionsSummaryResponse":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/BrokerConnectionSummaryResponseResource"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"ListBrokerContextsResponse":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/BrokerContextResource"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"ListBrokerDeploymentsResponse":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/BrokerDeploymentResource"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"ListDeploymentCredentialsResponse":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/DeploymentCredentialResource"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"ListTenantMembershipResponseData":{"additionalProperties":false,"items":{"$ref":"#/components/schemas/TenantMembershipResponseDataObject"},"type":"array"},"LoadedPackageRiskFactor":{"properties":{"included_in_score":{"default":false,"type":"boolean"},"links":{"$ref":"#/components/schemas/RiskFactorLinks"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"type":"boolean"}},"required":["name","updated_at","value"],"type":"object"},"LocalIgnore":{"properties":{"created_at":{"description":"When the ignore was first created.","format":"date-time","type":"string"},"expires_at":{"description":"When the ignore will expire.","format":"date-time","type":"string"},"path":{"description":"Dependency path to the vulnerable package to be ignored.\n\nIf not provided, the ignore will apply to all packages with the given\nvulnerability ID.","example":["myapp@1.0.0","org.apache.logging.log4j:log4j@2.6.2"],"items":{"type":"string"},"type":"array"},"reason":{"description":"Reason for the ignore.","example":"False positive","type":"string"},"skip_if_fixable":{"description":"Skips the ignore rule if an actual fix is available.","type":"boolean"},"vuln_id":{"description":"The vulnerability ID of the finding to be ignored.\n\nThis typically matches SnykVulnProblem.id for open source vulnerabilities.","example":"SNYK-JAVA-ORGAPACHELOGGINGLOG4J-31456","type":"string"}},"required":["vuln_id"],"type":"object"},"LocalPathLocator":{"description":"LocalPathLocator locates a test subject by local file paths, relative to the\nworking copy top-level directory of the source code.","properties":{"paths":{"description":"Local file paths. Limited to 256 characters.","items":{"$ref":"#/components/schemas/String256"},"minItems":1,"type":"array"},"type":{"enum":["local_path"],"type":"string"}},"required":["type","paths"],"type":"object"},"LocalPolicy":{"description":"Locally configured policy options for determining outcome of this specific test.","properties":{"fail_on_upgradable":{"default":false,"description":"Use to fail a test when there is at least one vulnerable finding that can be fixed by upgrading the version of the related\n dependency. E.g. bumping lodash from 1.1.1 to 1.1.2.","type":"boolean"},"ignores":{"description":"Defines ignore rules for known issues.","items":{"$ref":"#/components/schemas/LocalIgnore"},"type":"array"},"reachability_filter":{"$ref":"#/components/schemas/ReachabilityFilter"},"risk_score_threshold":{"description":"Findings of equal or greater risk score will fail the test.","format":"uint16","maximum":1000,"minimum":0,"type":"integer"},"severity_threshold":{"allOf":[{"$ref":"#/components/schemas/Severity"}],"description":"Findings of equal or greater severity will fail the test."},"suppress_pending_ignores":{"default":false,"description":"Suppress ignores pending approval, so that they do not fail the test. If\nallowed by administrators, this might be set in developer workflows in\norder to unblock local development while an ignore is pending approval.","type":"boolean"}},"required":["suppress_pending_ignores"],"type":"object"},"MaintenanceDetails":{"additionalProperties":false,"description":"Maintenance health signals for the package as a whole, based on repository-level activity. These signals reflect the overall project status. They do not represent the maintenance state of specific versions or version lines.","properties":{"description":{"description":"Human-readable explanation of the maintenance rating","type":"string"},"first_release_published_at":{"description":"Timestamp of the first release","format":"date-time","type":"string"},"forks_count":{"description":"Number of repository forks (\u003e= 0)","minimum":0,"type":"integer"},"is_archived":{"description":"Whether the source repository is archived. This is a repository-level signal. It does not represent the maintenance state of specific versions or version lines.","type":"boolean"},"is_forked":{"description":"Whether the repository is a fork","type":"boolean"},"latest_release_number":{"description":"Latest release version string","type":"string"},"latest_release_published_at":{"description":"Timestamp of the latest release","format":"date-time","type":"string"},"lifecycle":{"description":"Package-level lifecycle status as reported by the registry. Reflects the overall package state. It does not represent the maintenance state of specific versions or version lines.","enum":["active","archived","deprecated","removed","unpublished"],"type":"string"},"rating":{"description":"Package-level maintenance health, reflecting how actively the package repository is being developed and updated. This applies to the project as a whole. It does not represent the maintenance state of specific versions or version lines.","enum":["Healthy","Sustainable","Inactive"],"type":"string"},"total_versions_count":{"description":"Total number of versions published (\u003e= 0)","minimum":0,"type":"integer"}},"required":["is_archived","is_forked","total_versions_count","forks_count"],"type":"object"},"ManagedPolicyRef":{"description":"Reference to a managed policy.","properties":{"id":{"$ref":"#/components/schemas/Uuid"}},"required":["id"],"type":"object"},"ManualRemediationPRsSettings20240531":{"additionalProperties":false,"description":"Manually raise pull requests to fix new and existing vulnerabilities. If not specified, settings will be inherited from the Organization's integration.","properties":{"is_patch_remediation_enabled":{"description":"Include vulnerability patches in manual pull requests.","example":true,"type":"boolean"}},"type":"object"},"MaturityLevel":{"description":"Details about the maturity level","properties":{"format":{"description":"The standard by which the “maturity” value is shown.","example":"CVSSv4","type":"string"},"level":{"description":"Exploit maturity of the vulnerability. For CVSSv3: Proof of Concept, Functional, High. For CVSSv4: Unreported, Proof of Concept, Attacked.","example":"Attacked","type":"string"},"type":{"description":"Indicates if the CVSS item is primary or secondary. Clients should prefer the primary CVSS vector.","example":"primary","type":"string"}},"type":"object"},"MemberRoleRelationship":{"additionalProperties":false,"nullable":true,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgRoleAttributes"},"id":{"description":"The Snyk ID of the organization role.","example":"f60ff965-6889-4db2-8c86-0285d62f35ab","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"},"MembershipPatchRequestBody":{"properties":{"attributes":{"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"relationships":{"additionalProperties":false,"properties":{"role":{"additionalProperties":false,"properties":{"data":{"properties":{"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"description":"Always \"group_role\"","example":"Always \"group_role\"","type":"string"}},"type":"object"}},"type":"object"}},"required":["role"],"type":"object"},"type":{"description":"type of membership according to its entity","example":"group_membership","type":"string"}},"type":"object"},"Meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"},"NexusAttributes":{"properties":{"required":{"properties":{"base_nexus_url":{"format":"uuid","type":"string"}},"required":["base_nexus_url"],"type":"object"},"type":{"enum":["nexus"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"NexusCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["nexus-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"NugetBuildArgs":{"additionalProperties":false,"properties":{"target_framework":{"type":"string"}},"required":["target_framework"],"type":"object"},"OSConditionRiskFactor":{"properties":{"included_in_score":{"default":false,"type":"boolean"},"links":{"$ref":"#/components/schemas/RiskFactorLinks"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"type":"boolean"}},"required":["name","updated_at","value"],"type":"object"},"OciRegistryTag":{"description":"The tag for an OCI artifact inside an OCI registry.","example":"latest","type":"string"},"OciRegistryUrl":{"description":"The URL to an OCI registry.","example":"https://registry-1.docker.io/account/bundle","type":"string"},"OperatingSystem":{"description":"Operating system for container images (Go GOOS conventions)","enum":["aix","android","darwin","dragonfly","freebsd","illumos","ios","js","linux","netbsd","openbsd","plan9","solaris","wasip1","windows","other"],"type":"string"},"Org":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgAttributes"},"id":{"description":"The Snyk ID of the organization.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id","attributes"],"type":"object"},"Org20230529":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgAttributes20230529"},"id":{"description":"The Snyk ID of the organization.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"relationships":{"properties":{"tenant":{"properties":{"data":{"properties":{"id":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"type":{"description":"The type of the resource for tenant operations","enum":["tenant"],"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id","attributes"],"type":"object"},"OrgAttributes":{"additionalProperties":false,"properties":{"access_requests_enabled":{"description":"Whether the organization permits access requests from users who are not members of the organization.","example":false,"type":"boolean"},"created_at":{"description":"The time the organization was created.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"},"group_id":{"description":"The Snyk ID of the group to which the organization belongs.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"is_personal":{"description":"Whether the organization is independent (that is, not part of a group).","example":true,"type":"boolean"},"name":{"description":"The display name of the organization.","example":"My Org","type":"string"},"slug":{"description":"The canonical (unique and URL-friendly) name of the organization.","example":"my-org","type":"string"},"updated_at":{"description":"The time the organization was last modified.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["name","slug","is_personal"],"type":"object"},"OrgAttributes20230529":{"additionalProperties":false,"properties":{"created_at":{"description":"The time the organization was created.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"},"group_id":{"description":"The Snyk ID of the group to which the organization belongs.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"is_personal":{"description":"Whether the organization is independent (that is, not part of a group).","example":true,"type":"boolean"},"name":{"description":"The display name of the organization.","example":"My Org","type":"string"},"slug":{"description":"The canonical (unique and URL-friendly) name of the organization.","example":"my-org","type":"string"},"updated_at":{"description":"The time the organization was last modified.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["name","slug","is_personal"],"type":"object"},"OrgFilters":{"properties":{"cve":{"description":"CVE identifier(s) to filter by (e.g. CVE-2024-1234). Rows whose cve is in this list are included.","items":{"type":"string"},"type":"array"},"empty_project_tags":{"enum":["include","exclude","only"],"type":"string"},"environment":{"items":{"type":"string"},"type":"array"},"introduced":{"properties":{"from":{"format":"date-time","type":"string"},"to":{"format":"date-time","type":"string"}},"type":"object"},"issue_status":{"items":{"type":"string"},"type":"array"},"issue_type":{"items":{"type":"string"},"type":"array"},"lifecycle":{"items":{"type":"string"},"type":"array"},"nvd_severity":{"items":{"type":"string"},"type":"array"},"product_name":{"items":{"type":"string"},"type":"array"},"project_origin":{"items":{"type":"string"},"type":"array"},"project_tags":{"items":{"type":"string"},"type":"array"},"project_target_display_name":{"items":{"type":"string"},"type":"array"},"project_target_ref":{"items":{"type":"string"},"type":"array"},"project_type":{"items":{"type":"string"},"type":"array"},"reachability":{"items":{"type":"string"},"type":"array"},"updated":{"properties":{"from":{"format":"date-time","type":"string"},"to":{"format":"date-time","type":"string"}},"type":"object"}},"type":"object"},"OrgIacSettingsRequest":{"description":"The Infrastructure as Code settings for an org.","properties":{"attributes":{"properties":{"custom_rules":{"additionalProperties":false,"description":"The Infrastructure as Code custom rules settings for an org.","minProperties":1,"properties":{"inherit_from_parent":{"$ref":"#/components/schemas/InheritFromParent"},"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"}},"type":"object"}},"type":"object"},"type":{"description":"Content type","example":"iac_settings","type":"string"}},"required":["type","attributes"],"type":"object"},"OrgIacSettingsResponse":{"description":"The Infrastructure as Code settings for an org.","properties":{"attributes":{"properties":{"custom_rules":{"description":"The Infrastructure as Code custom rules settings for an org.","properties":{"inherit_from_parent":{"$ref":"#/components/schemas/InheritFromParent"},"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"},"parents":{"description":"Contains all parents the org can inherit settings from.","properties":{"group":{"description":"The Infrastructure as Code settings at the group level.","properties":{"custom_rules":{"description":"The Infrastructure as Code custom rules settings for a group.","properties":{"is_enabled":{"$ref":"#/components/schemas/IsEnabled"},"oci_registry_tag":{"$ref":"#/components/schemas/OciRegistryTag"},"oci_registry_url":{"$ref":"#/components/schemas/OciRegistryUrl"}},"type":"object"},"updated":{"$ref":"#/components/schemas/Updated"}},"type":"object"}},"type":"object"},"updated":{"$ref":"#/components/schemas/Updated"}},"type":"object"}},"type":"object"},"id":{"description":"ID","example":"ea536a06-0566-40ca-b96b-155568aa2027","format":"uuid","type":"string"},"type":{"description":"Content type","example":"iac_settings","type":"string"}},"type":"object"},"OrgIntegrationResource":{"additionalProperties":false,"properties":{"id":{"format":"uuid","type":"string"},"integration_type":{"type":"string"},"org_id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"type":"object"},"OrgInvitation":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgInvitationAttributes"},"id":{"format":"uuid","type":"string"},"relationships":{"properties":{"org":{"$ref":"#/components/schemas/Relationship"}},"type":"object"},"type":{"type":"string"}},"required":["type","id","attributes"],"type":"object"},"OrgInvitation20240621":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgInvitationAttributes20230828"},"id":{"format":"uuid","type":"string"},"relationships":{"properties":{"org":{"$ref":"#/components/schemas/Relationship"}},"type":"object"},"type":{"enum":["org_invitation"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"OrgInvitationAttributes":{"additionalProperties":false,"properties":{"email":{"description":"The email address of the invitee.","example":"example@email.com","type":"string"},"is_active":{"description":"The active status of the invitation. is_active of true indicates that the invitation is still waiting to be accepted. Invitations are considered inactive when accepted or revoked.\n","example":true,"type":"boolean"},"role":{"description":"The role assigned to the invitee on acceptance.","example":"Developer","type":"string"}},"required":["email","is_active","role"],"type":"object"},"OrgInvitationAttributes20230828":{"additionalProperties":false,"properties":{"email":{"description":"The email address of the invitee.","example":"example@email.com","type":"string"},"is_active":{"description":"The active status of the invitation. is_active of true indicates that the invitation is still waiting to be accepted. Invitations are considered inactive when accepted or revoked.\n","example":true,"type":"boolean"},"role":{"description":"The role public ID that will be granted to to invitee on acceptance.","example":"f1968726-1dca-42d4-a4dc-80cab99e2b6c","format":"uuid","type":"string"}},"required":["email","is_active","role"],"type":"object"},"OrgInvitationPostAttributes":{"additionalProperties":false,"properties":{"email":{"description":"The email address of the invitee.","example":"example@email.com","type":"string"},"role":{"description":"The role public ID that will be granted to to invitee on acceptance.","example":"f1968726-1dca-42d4-a4dc-80cab99e2b6c","format":"uuid"}},"required":["email","role"],"type":"object"},"OrgInvitationPostData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgInvitationPostAttributes"},"type":{"enum":["org_invitation"],"type":"string"}},"required":["type","attributes"],"type":"object"},"OrgMembership":{"additionalProperties":false,"properties":{"attributes":{"properties":{"created_at":{"description":"The date that the org membership was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time"}},"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/OrgMembershipRelationships"},"type":{"description":"Content type.","example":"org_membership","type":"string"}},"required":["type","id","attributes","relationships"],"type":"object"},"OrgMembershipAttributes":{"additionalProperties":false,"properties":{"created_at":{"description":"The time when this Org membership was created","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["created_at"],"type":"object"},"OrgMembershipOrgData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"name":{"description":"The name of the organization","example":"Example org","type":"string"}},"required":["name"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"org","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"OrgMembershipRelationships":{"additionalProperties":false,"properties":{"org":{"$ref":"#/components/schemas/OrgMembershipOrgData"},"role":{"$ref":"#/components/schemas/OrgMembershipRoleData"},"user":{"$ref":"#/components/schemas/OrgMembershipUserData"}},"required":["role","org","user"],"type":"object"},"OrgMembershipResponseData":{"additionalProperties":false,"items":{"properties":{"attributes":{"$ref":"#/components/schemas/OrgMembershipAttributes"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/OrgMembershipRelationships"},"type":{"description":"Content type","example":"org_memberships","type":"string"}},"type":"object"},"type":"array"},"OrgMembershipRoleData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"name":{"description":"The name of the role","example":"Admin role","type":"string"}},"required":["name"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"org_role","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"OrgMembershipUserData":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"email":{"description":"The email of the user","example":"user@test.com","type":"string"},"login_method":{"description":"The login method of the user","type":"string"},"name":{"description":"The name of the user","example":"User2","type":"string"},"username":{"description":"The username of the user","example":"User name 2","type":"string"}},"required":["name","username","email"],"type":"object"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"example":"user","type":"string"}},"required":["id","attributes"],"type":"object"}},"type":"object"},"OrgRelationships":{"additionalProperties":false,"properties":{"member_role":{"$ref":"#/components/schemas/MemberRoleRelationship"}},"type":"object"},"OrgRoleAttributes":{"properties":{"name":{"description":"The display name of the organization role.","example":"Collaborator","type":"string"}},"type":"object"},"OrgUpdateAttributes":{"additionalProperties":false,"properties":{"name":{"description":"The display name of the organization.","example":"My Org","maxLength":60,"minLength":1,"type":"string"}},"required":["name"],"type":"object"},"OrgWithRelationships":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgAttributes"},"id":{"description":"The Snyk ID of the organization.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/OrgRelationships"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id","attributes"],"type":"object"},"OrganizationResource":{"additionalProperties":false,"properties":{"id":{"description":"The organization ID associated with the bulk migration.","format":"uuid","type":"string"},"type":{"enum":["broker_organization"],"type":"string"}},"type":"object"},"OrganizationType":{"enum":["organization"],"example":"organization","type":"string"},"OtherEvidence":{"description":"Evidence which this API version is not capable of expressing.\n\nMore information may be available in a newer version of this API.","properties":{"source":{"enum":["other"],"type":"string"}},"required":["source"],"type":"object"},"OtherLocation":{"description":"Finding locations which this API version is not capable of expressing.\n\nThis location may be available in a newer version of this API.","properties":{"type":{"enum":["other"],"type":"string"}},"required":["type"],"type":"object"},"OtherLocator":{"description":"OtherLocator represents any locator that this version of the API is not\ncapable of expressing.","properties":{"type":{"enum":["other"],"type":"string"}},"required":["type"],"type":"object"},"OtherSubject":{"description":"OtherSubject represents any subject that this version of the API is not\ncapable of expressing.","properties":{"type":{"enum":["other"],"type":"string"}},"required":["type"],"type":"object"},"OwnerDetails":{"additionalProperties":false,"description":"Details about the package owner/maintainer","properties":{"followers_count":{"description":"Number of followers the package owner has on the source platform (e.g., GitHub) (\u003e= 0)","minimum":0,"type":"integer"},"location":{"description":"Owner location","type":"string"},"name":{"description":"Owner/maintainer name","type":"string"},"repositories_count":{"description":"Number of repositories owned by the package owner on the source platform (\u003e= 0)","minimum":0,"type":"integer"},"total_stars":{"description":"Total number of stars across all repositories owned by the package owner (\u003e= 0)","minimum":0,"type":"integer"}},"required":["followers_count","repositories_count","total_stars"],"type":"object"},"Package":{"description":"Dependency models a package dependency.","properties":{"name":{"description":"Name is the name of the package.","example":"lodash","type":"string"},"version":{"description":"Version is the version of the named package.","example":"1.2.3","type":"string"}},"required":["name","version"],"type":"object"},"PackageAttributes":{"allOf":[{"$ref":"#/components/schemas/BasePackageAttributes"},{"properties":{"latest_version":{"description":"The latest published version of this package","example":"4.19.2","type":"string"},"package_details":{"$ref":"#/components/schemas/PackageDetails"}},"type":"object"}],"description":"Attributes for a package resource","example":{"ecosystem":"npm","language":"JavaScript","latest_version":"4.19.2","owner_details":{"followers_count":123,"location":"somewhere","name":"expressjs","repositories_count":45,"total_stars":65000},"package_details":{"homepage_url":"https://expressjs.com","registry_url":"https://www.npmjs.com/package/express","repository_url":"https://github.com/expressjs/express"},"package_health":{"community":{"description":"...","has_code_of_conduct_file":true,"has_contributing_file":true,"has_funding_file":false,"has_readme_file":true,"rating":"Active","stargazers_count":75000},"description":"The package has mixed or concerning signals that require closer review. Applies to medium, high, and critical vulnerabilities. Low-severity vulnerabilities are excluded.","maintenance":{"description":"...","first_release_published_at":"2010-01-03T00:00:00Z","forks_count":66,"is_archived":false,"is_forked":false,"latest_release_number":"4.19.2","latest_release_published_at":"2024-10-08T00:00:00Z","lifecycle":"active","rating":"Healthy","total_versions_count":760},"overall_rating":"Review recommended","popularity":{"dependent_packages_count":280,"dependent_repos_count":65000,"description":"...","downloads":12000,"rating":"Influential project"},"security":{"description":"...","direct_vulnerabilities":true,"direct_vulnerabilities_total":3,"rating":"Security issues found"}},"package_id":"pkg:npm/express","package_name":"express"}},"PackageDetails":{"description":"Base package details with URLs","properties":{"homepage_url":{"description":"Package homepage URL","example":"https://expressjs.com","type":"string"},"registry_url":{"description":"Package registry URL","example":"https://www.npmjs.com/package/express","type":"string"},"repository_url":{"description":"Source repository URL","example":"https://github.com/expressjs/express","type":"string"}},"type":"object"},"PackageHealth":{"additionalProperties":false,"description":"Overall health assessment of the package based on multiple signals","properties":{"community":{"$ref":"#/components/schemas/CommunityDetails"},"description":{"description":"Human-readable explanation of the overall rating","type":"string"},"maintenance":{"$ref":"#/components/schemas/MaintenanceDetails"},"overall_rating":{"description":"Overall health assessment of the package based on security, maintenance, community, and popularity signals","enum":["Healthy","Review recommended","Not recommended","Not enough data to compute health status"],"type":"string"},"popularity":{"$ref":"#/components/schemas/PopularityDetails"},"security":{"$ref":"#/components/schemas/SecurityDetails"}},"type":"object"},"PackageLocation":{"description":"Package dependency version.\n\nFinding type: SCA","example":{"package":{"name":"log4j","version":"2.4.1"},"type":"package"},"properties":{"package":{"$ref":"#/components/schemas/Package"},"type":{"enum":["package"],"type":"string"}},"required":["type","package"],"type":"object"},"PackageMeta":{"properties":{"name":{"description":"The package’s name","example":"woodstox-core","type":"string"},"namespace":{"description":"A name prefix, such as a maven group id or docker image owner","example":"com.fasterxml.woodstox","type":"string"},"type":{"description":"The package type or protocol","example":"maven","type":"string"},"url":{"description":"The purl of the package","example":"pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0","type":"string"},"version":{"description":"The version of the package","example":"5.0.0","type":"string"}},"type":"object"},"PackageMeta__0":{"properties":{"name":{"description":"The package’s name","example":"spring-core","type":"string"},"namespace":{"description":"A name prefix, such as a maven group id or docker image owner","example":"org.springframework","type":"string"},"type":{"description":"The package type or protocol","example":"maven","type":"string"},"url":{"description":"The purl of the package","example":"pkg:maven/com.fasterxml.woodstox/woodstox-core@5.0.0","type":"string"},"version":{"description":"The version of the package","example":"1.0.0","type":"string"}},"type":"object"},"PackageRepresentation":{"properties":{"package":{"$ref":"#/components/schemas/PackageMeta"}},"type":"object"},"PackageVersionAttributes":{"allOf":[{"$ref":"#/components/schemas/BasePackageAttributes"},{"properties":{"latest_version_indicator":{"description":"Whether this is the latest version of the package","example":true,"type":"boolean"},"package_details":{"$ref":"#/components/schemas/PackageVersionDetails"},"package_version":{"description":"The specific version string of this package","example":"4.19.2","type":"string"},"package_version_id":{"description":"Package version identifier in PURL format (e.g., pkg:npm/express@4.19.2)","example":"pkg:npm/express@4.19.2","type":"string"},"published_at":{"description":"Timestamp when this version was published","example":"2024-10-08T00:00:00Z","format":"date-time","type":"string"}},"required":["package_version_id","package_version","latest_version_indicator"],"type":"object"}],"description":"Attributes for a package version resource","example":{"ecosystem":"npm","language":"JavaScript","latest_version_indicator":true,"owner_details":{"followers_count":123,"location":"somewhere","name":"expressjs","repositories_count":45,"total_stars":65000},"package_details":{"download_url":"https://registry.npmjs.org/express/-/express-4.19.2.tgz","homepage_url":"https://expressjs.com","registry_url":"https://www.npmjs.com/package/express","registry_version_url":"https://www.npmjs.com/package/express/v/4.19.2","repository_url":"https://github.com/expressjs/express"},"package_health":{"community":{"description":"...","has_code_of_conduct_file":true,"has_contributing_file":true,"has_funding_file":false,"has_readme_file":true,"rating":"Active","stargazers_count":75000},"description":"The package has mixed or concerning signals that require closer review. Applies to medium, high, and critical vulnerabilities. Low-severity vulnerabilities are excluded.","maintenance":{"description":"...","first_release_published_at":"2010-01-03T00:00:00Z","forks_count":66,"is_archived":false,"is_forked":false,"latest_release_number":"4.19.2","latest_release_published_at":"2024-10-08T00:00:00Z","lifecycle":"active","rating":"Healthy","total_versions_count":760},"overall_rating":"Review recommended","popularity":{"dependent_packages_count":280,"dependent_repos_count":65000,"description":"...","downloads":12000,"rating":"Influential project"},"security":{"description":"...","direct_vulnerabilities":true,"direct_vulnerabilities_total":3,"rating":"Security issues found"}},"package_id":"pkg:npm/express","package_name":"express","package_version":"4.19.2","package_version_id":"pkg:npm/express@4.19.2","published_at":"2024-10-08T00:00:00Z"}},"PackageVersionDetails":{"allOf":[{"$ref":"#/components/schemas/PackageDetails"},{"properties":{"download_url":{"description":"Direct download URL for this version","example":"https://registry.npmjs.org/express/-/express-4.19.2.tgz","type":"string"},"registry_version_url":{"description":"Registry URL for this specific version","example":"https://www.npmjs.com/package/express/v/4.19.2","type":"string"}},"type":"object"}]},"PaginatedLinks":{"additionalProperties":false,"example":{"first":"https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K","last":"https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K","next":"https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"},"properties":{"first":{"$ref":"#/components/schemas/LinkProperty"},"last":{"$ref":"#/components/schemas/LinkProperty"},"next":{"$ref":"#/components/schemas/LinkProperty"},"prev":{"$ref":"#/components/schemas/LinkProperty"},"self":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"PaginationLinks":{"description":"Cursor-based pagination links","properties":{"first":{"description":"Link to the first page","format":"uri","type":"string"},"next":{"description":"Link to the next page (if available)","format":"uri","type":"string"},"prev":{"description":"Link to the previous page (if available)","format":"uri","type":"string"},"self":{"description":"Link to the current page","format":"uri","type":"string"}},"type":"object"},"PassFail":{"description":"Indicate whether a Test passes or fails.","enum":["pass","fail"],"type":"string"},"PatTenantId":{"description":"Identifier of the tenant to which the Personal Access Token is scoped.","example":"550e8400-e29b-41d4-a716-446655440000","format":"uuid","nullable":true,"type":"string"},"PatchProjectRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"properties":{"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"},"tags":{"example":[{"key":"tag-key","value":"tag-value"}],"items":{"properties":{"key":{"example":"tag-key","type":"string"},"value":{"example":"tag-value","type":"string"}},"type":"object"},"type":"array"},"test_frequency":{"description":"Test frequency of a project. Also controls when automated PRs may be created.","enum":["daily","weekly","never"],"example":"daily","type":"string"}},"type":"object"},"id":{"description":"The Resource ID.","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"relationships":{"properties":{"owner":{"properties":{"data":{"properties":{"id":{"description":"The public ID of the user that owns the project","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","nullable":true,"type":"string"},"type":{"enum":["user"]}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"type":"object"},"type":{"description":"The Resource type.","enum":["project"],"type":"string"}},"required":["type","id","attributes","relationships"],"type":"object"}},"required":["data"],"type":"object"},"PermissionType":{"enum":["cf","tf","bash"],"type":"string"},"PermissionsAttributes":{"properties":{"data":{"type":"string"},"type":{"$ref":"#/components/schemas/PermissionType"}},"required":["data","type"],"type":"object"},"PersonalAccessTokenCreatedAt":{"description":"Date/Time when the token was created","example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"},"PersonalAccessTokenExpiresAt":{"description":"Date/Time when the token expires","example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"},"PersonalAccessTokenId":{"description":"The personal access token id","example":"01HSBP9DKDK39KWZQV84PSPRHY","format":"ulid","type":"string"},"PersonalAccessTokenLabel":{"description":"A human-friendly name for the personal access token","example":"my token","format":"string","type":"string"},"PersonalAccessTokenType":{"description":"Type of the resource.","enum":["personal_access_token"],"type":"string"},"PinPackageAdvice":{"description":"Pin a package at a specific version. Pinning is a capability not supported\nby all ecosystems, which causes a transitive dependency to be pinned at\na specific version with an override.\n\nFor example, the `replace` go.mod directive can override package dependency\nconstraints, forcing a specific version to be used in the application.\n\nPinning could break an application.\n\nNote: In practice pin actions today are solely used in python pip's packages as pip does not calculate upgrade paths","example":{"format":"pin_package_advice","package_name":"requests","pin_version":"2.25.1"},"properties":{"format":{"enum":["pin_package_advice"],"type":"string"},"package_name":{"type":"string"},"pin_version":{"type":"string"}},"required":["format","package_name","pin_version"],"type":"object"},"Platform":{"enum":["aix/ppc64","android/386","android/amd64","android/arm","android/arm/v5","android/arm/v6","android/arm/v7","android/arm64","android/arm64/v8","darwin/amd64","darwin/arm","darwin/arm/v5","darwin/arm/v6","darwin/arm/v7","darwin/arm64","darwin/arm64/v8","dragonfly/amd64","freebsd/386","freebsd/amd64","freebsd/arm","freebsd/arm/v5","freebsd/arm/v6","freebsd/arm/v7","illumos/amd64","ios/arm64","ios/arm64/v8","js/wasm","linux/386","linux/amd64","linux/arm","linux/arm/v5","linux/arm/v6","linux/arm/v7","linux/arm64","linux/arm64/v8","linux/loong64","linux/mips","linux/mipsle","linux/mips64","linux/mips64le","linux/ppc64","linux/ppc64le","linux/riscv64","linux/s390x","linux/x86_64","netbsd/386","netbsd/amd64","netbsd/arm","netbsd/arm/v5","netbsd/arm/v6","netbsd/arm/v7","openbsd/386","openbsd/amd64","openbsd/arm","openbsd/arm/v5","openbsd/arm/v6","openbsd/arm/v7","openbsd/arm64","openbsd/arm64/v8","plan9/386","plan9/amd64","plan9/arm","plan9/arm/v5","plan9/arm/v6","plan9/arm/v7","solaris/amd64","windows/386","windows/amd64","windows/arm","windows/arm/v5","windows/arm/v6","windows/arm/v7","windows/arm64","windows/arm64/v8"],"example":"linux/amd64","type":"string"},"PlatformType":{"enum":["aws","azure","google"],"type":"string"},"PolicyActionIgnore":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/PolicyActionIgnoreData"}},"required":["data"],"type":"object"},"PolicyActionIgnoreData":{"additionalProperties":false,"properties":{"expires":{"example":"2024-03-16T00:00:00Z","format":"date-time","type":"string"},"ignore_type":{"enum":["wont-fix","not-vulnerable","temporary-ignore"],"type":"string"},"reason":{"maxLength":10000,"type":"string"}},"required":["ignore_type"],"type":"object"},"PolicyAttributes":{"additionalProperties":false,"properties":{"action":{"$ref":"#/components/schemas/PolicyActionIgnore"},"action_type":{"enum":["ignore"],"type":"string"},"conditions_group":{"$ref":"#/components/schemas/PolicyConditionsGroup"},"name":{"maxLength":255,"type":"string"},"source":{"description":"The source of the policy creation. Defaults to 'api' if not provided.","enum":["api","cli","ide","web","unknown"],"type":"string"}},"required":["name","conditions_group","action","action_type"],"type":"object"},"PolicyComponent":{"description":"A component policy, an overall policy is made up of one or more component policies combined in various ways.","properties":{"name":{"type":"string"},"policy":{"type":"object"},"sub_policies":{"items":{"type":"object"},"type":"array"},"type":{"type":"string"}},"required":["name","type"],"type":"object"},"PolicyCondition":{"additionalProperties":false,"properties":{"field":{"description":"field refers to the type of identifier used in the condition of the policy. The available value is versioned and hierarchical:\n- `snyk/asset/finding/v1` : identity of the finding scoped to a Snyk assets (e.g. a repository).\nFor a given issue, `snyk/asset/finding/v1` can be extracted from the `key_asset` field in the [issues API](https://apidocs.snyk.io/?version=2024-10-15#get-/orgs/-org_id-/issues). \nIn addition, finding identities can be extracted from the fingerprints section of the SARIF, which is accessible via the Snyk CLI. More details can be found in the [CLI documentation](https://docs.snyk.io/snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-cli-for-snyk-code/view-snyk-code-cli-results#export-test-results).\n","enum":["snyk/asset/finding/v1"],"type":"string"},"operator":{"description":"Operator for the field to value matching. Currently\nonly 'includes' is supported, which does an exact\nstring match on the value.\n","enum":["includes"],"type":"string"},"value":{"description":"The value of the field to match on.\n","type":"string"}},"required":["field","operator","value"],"type":"object"},"PolicyConditionsGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/PolicyCondition"},"maxItems":1,"minItems":1,"type":"array"},"logical_operator":{"description":"The logical operator for the policy condition. Currently only 'and' is supported.","enum":["and"],"type":"string"}},"required":["logical_operator","conditions"],"type":"object"},"PolicyEventAttributes":{"additionalProperties":false,"properties":{"changes":{"$ref":"#/components/schemas/PolicyEventChanges"},"comment":{"type":"string"},"created_at":{"example":"2024-03-16T00:00:00Z","format":"date-time","type":"string"},"created_by":{"$ref":"#/components/schemas/Principal"},"type":{"$ref":"#/components/schemas/PolicyEventType"}},"required":["created_at","type","created_by","changes"],"type":"object"},"PolicyEventChanges":{"additionalProperties":false,"properties":{"new_action":{"$ref":"#/components/schemas/PolicyActionIgnore"},"new_conditions_group":{"$ref":"#/components/schemas/PolicyConditionsGroup"},"new_name":{"type":"string"},"new_review":{"$ref":"#/components/schemas/PolicyReview"},"old_action":{"$ref":"#/components/schemas/PolicyActionIgnore"},"old_conditions_group":{"$ref":"#/components/schemas/PolicyConditionsGroup"},"old_name":{"type":"string"},"old_review":{"$ref":"#/components/schemas/PolicyReview"}},"type":"object"},"PolicyEventResponse":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/PolicyEventAttributes"},"id":{"description":"A unique identifier for this event.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"type":{"enum":["policy_event"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"PolicyEventType":{"enum":["approve","reject","cancel","reopen","edit","create"],"type":"string"},"PolicyModification":{"description":"Prior attribute values and the reason they were modified.","properties":{"pointer":{"description":"A JSON Pointer (RFC 6901) reference to the modified value, relative to\nthe top-level attributes of the same Finding.","example":"/rating/severity","type":"string"},"policy":{"allOf":[{"$ref":"#/components/schemas/PolicyRef"}],"description":"Policy which modified the finding, if available."},"prior":{"description":"The prior value at the referenced pointer.","example":"low"},"reason":{"description":"A human-readable explanation for why the value was modified.","example":"CWE-123 poses an elevated risk to workloads exposed to the public internet","type":"string"}},"required":["pointer","reason"],"type":"object"},"PolicyRef":{"description":"Reference to a single policy.","oneOf":[{"enum":["local_policy"],"type":"string"},{"$ref":"#/components/schemas/ManagedPolicyRef"}]},"PolicyRefSet":{"description":"A set of local and/or managed policies.","properties":{"ids":{"items":{"$ref":"#/components/schemas/Uuid"},"type":"array"},"local_policy":{"type":"boolean"}},"required":["ids"],"type":"object"},"PolicyResponse":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/PolicyResponseAttributes"},"id":{"description":"A unique identifier for this particular occurrence of the policy.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"type":{"enum":["policy"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"PolicyResponseAttributes":{"additionalProperties":false,"properties":{"action":{"$ref":"#/components/schemas/PolicyActionIgnore"},"action_type":{"enum":["ignore"],"type":"string"},"conditions_group":{"$ref":"#/components/schemas/PolicyConditionsGroup"},"created_at":{"example":"2024-03-16T00:00:00Z","format":"date-time","type":"string"},"created_by":{"$ref":"#/components/schemas/Principal"},"name":{"type":"string"},"review":{"$ref":"#/components/schemas/PolicyReview"},"updated_at":{"example":"2024-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["name","conditions_group","action","action_type","review","created_at","updated_at"],"type":"object"},"PolicyReview":{"description":"Review status.","enum":["pending","approved","rejected","not-required"],"type":"string"},"PolymorphicAssetData":{"description":"JSON:API data for any asset type (polymorphic)","properties":{"attributes":{"oneOf":[{"$ref":"#/components/schemas/ContainerImageAttributesResponse"}]},"id":{"description":"The unique identifier of the asset","format":"uuid","type":"string"},"links":{"description":"Self-referencing link","properties":{"self":{"description":"Link to the current resource","format":"uri","type":"string"}},"required":["self"],"type":"object"},"relationships":{"description":"JSON:API relationships linking to related resources","properties":{"projects":{"description":"Link to the asset's related projects","properties":{"links":{"properties":{"related":{"description":"URL to the related projects endpoint","type":"string"}},"type":"object"}},"type":"object"},"targets":{"description":"Link to the asset's related targets","properties":{"links":{"properties":{"related":{"description":"URL to the related targets endpoint","type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"type":{"description":"The JSON:API resource type","enum":["container_images"],"type":"string"}},"required":["type","id"],"type":"object"},"PopularityDetails":{"additionalProperties":false,"description":"Popularity signals for the package","properties":{"dependent_packages_count":{"description":"Number of packages that depend on this package (\u003e= 0)","minimum":0,"type":"integer"},"dependent_repos_count":{"description":"Number of repositories that depend on this package (\u003e= 0)","minimum":0,"type":"integer"},"description":{"description":"Human-readable explanation of the popularity rating","type":"string"},"downloads":{"description":"Download count (\u003e= 0)","minimum":0,"type":"integer"},"rating":{"description":"Popularity rating based on downloads and ecosystem usage","enum":["Limited","Small","Recognized","Popular","Influential project","Key ecosystem project"],"type":"string"}},"required":["dependent_packages_count","dependent_repos_count","downloads"],"type":"object"},"Principal":{"properties":{"email":{"type":"string"},"id":{"description":"The Snyk ID corresponding to this user or service account that created the policy","format":"uuid","type":"string"},"name":{"description":"Name of the user or service account that created the policy","type":"string"}},"required":["name","id"],"type":"object"},"Principal20240422":{"additionalProperties":false,"properties":{"attributes":{"anyOf":[{"$ref":"#/components/schemas/User20240422"},{"$ref":"#/components/schemas/ServiceAccount20240422"},{"$ref":"#/components/schemas/AppInstance"}]},"id":{"description":"The Snyk ID corresponding to this user, service account or app","example":"55a348e2-c3ad-4bbc-b40e-9b232d1f4121","format":"uuid","type":"string"},"type":{"description":"Content type.","enum":["user","service_account","app_instance"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"Problem":{"additionalProperties":false,"example":{"id":"SNYK-DEBIAN8-CURL-358558","source":"snyk","type":"rule"},"properties":{"disclosed_at":{"description":"When this problem was disclosed to the public.","format":"date-time","type":"string"},"discovered_at":{"description":"When this problem was first discovered.","format":"date-time","type":"string"},"id":{"maxLength":1024,"minLength":1,"type":"string"},"source":{"example":"CVE","maxLength":64,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/ProblemTypeDef"},"updated_at":{"description":"When this problem was last updated.","format":"date-time","type":"string"},"url":{"description":"An optional URL for this problem.","format":"uri","maxLength":4096,"minLength":1,"type":"string"}},"required":["id","type","source"],"type":"object"},"Problem3":{"properties":{"disclosed_at":{"description":"When this problem was disclosed to the public.","format":"date-time","type":"string"},"discovered_at":{"description":"When this problem was first discovered.","format":"date-time","type":"string"},"id":{"example":"CWE-61","maxLength":1024,"minLength":1,"type":"string"},"source":{"example":"CVE","maxLength":64,"minLength":1,"type":"string"},"updated_at":{"description":"When this problem was last updated.","format":"date-time","type":"string"},"url":{"description":"An optional URL for this problem.","format":"uri","maxLength":4096,"minLength":1,"type":"string"}},"required":["id","source"],"type":"object"},"ProblemTypeDef":{"enum":["rule","vulnerability"],"type":"string"},"ProgressRelationships":{"properties":{"catalog":{"$ref":"#/components/schemas/CatalogRelationship"},"user":{"$ref":"#/components/schemas/UserRelationship"}},"required":["user","catalog"],"type":"object"},"ProjectAttributes":{"additionalProperties":false,"properties":{"build_args":{"oneOf":[{"$ref":"#/components/schemas/YarnBuildArgs"},{"$ref":"#/components/schemas/ContainerBuildArgs"},{"$ref":"#/components/schemas/NugetBuildArgs"}]},"business_criticality":{"example":["medium"],"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"created":{"description":"The date that the project was created on","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"},"environment":{"example":["external","hosted"],"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"lifecycle":{"example":["production"],"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"},"name":{"description":"Project name.","example":"snyk/goof","type":"string"},"origin":{"description":"The origin the project was added from.","example":"github","type":"string"},"read_only":{"description":"Whether the project is read-only","type":"boolean"},"settings":{"$ref":"#/components/schemas/ProjectSettings20240531"},"status":{"description":"Describes if a project is currently monitored or it is de-activated.","enum":["active","inactive"],"example":"active","type":"string"},"tags":{"example":[{"key":"tag-key","value":"tag-value"}],"items":{"properties":{"key":{"example":"tag-key","type":"string"},"value":{"example":"tag-value","type":"string"}},"type":"object"},"type":"array"},"target_file":{"description":"Path within the target to identify a specific file/directory/image etc. when scanning just part of the target, and not the entity.","example":"package.json","type":"string"},"target_reference":{"description":"The additional information required to resolve which revision of the resource should be scanned.","example":"main","type":"string"},"target_runtime":{"description":"Dotnet Target, for relevant projects","type":"string"},"type":{"description":"The package manager of the project.","example":"maven","type":"string"}},"required":["name","type","target_file","target_reference","origin","created","status","read_only","settings"],"type":"object"},"ProjectEntityLocator":{"description":"ProjectEntityLocator locates a Snyk Project by its public ID.","properties":{"project_id":{"description":"Public ID of the Snyk Project.","format":"uuid","type":"string"},"type":{"enum":["project_entity"],"type":"string"}},"required":["type","project_id"],"type":"object"},"ProjectMeta":{"additionalProperties":false,"properties":{"imported":{"description":"The time the project was imported","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"},"issues_critical_count":{"description":"The sum of critical severity issues of the project","example":10,"type":"number"},"issues_high_count":{"description":"The sum of high severity issues of the project","example":10,"type":"number"},"issues_low_count":{"description":"The sum of low severity issues of the project","example":10,"type":"number"},"issues_medium_count":{"description":"The sum of medium severity issues of the project","example":10,"type":"number"},"last_tested_at":{"description":"The time the project was last tested","example":"2021-05-29T09:50:54.014Z","format":"date-time","type":"string"}},"required":["imported","last_tested_at","issues_critical_count","issues_high_count","issues_medium_count","issues_low_count"],"type":"object"},"ProjectNameLocator":{"description":"ProjectNameLocator locates a Snyk Project by its name.","properties":{"project_name":{"description":"Name of the Snyk Project.","type":"string"},"target_reference":{"description":"Target reference which differentiates this project, for example, with a\nbranch name or version. Projects having the same reference can be grouped\nbased on that reference.","type":"string"},"type":{"enum":["project_name"],"type":"string"}},"required":["type","project_name"],"type":"object"},"ProjectOfCollection":{"additionalProperties":false,"properties":{"id":{"format":"uuid","type":"string"},"meta":{"$ref":"#/components/schemas/ProjectMeta"},"relationships":{"additionalProperties":false,"properties":{"target":{"properties":{"data":{"properties":{"id":{"description":"ID of the target that owns the project","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"enum":["target"]}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"required":["target"],"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type","meta","relationships"],"type":"object"},"ProjectRelationshipAttributes":{"additionalProperties":false,"description":"Attributes of the project resource","properties":{"base_image_remediation":{"$ref":"#/components/schemas/BaseImageRemediation"},"is_canonical":{"description":"Indicates whether this project is the canonical project for its target_file.\nProjects are grouped by target_file, and within each group, the project with the most\nrecent snapshot_created_at timestamp is marked as canonical. This canonical project\nis used for computing vulnerability counts for the asset.\nWhen target_file is empty, each project is its own group (always canonical).\n","type":"boolean"},"issues":{"description":"Issue counts by severity","properties":{"critical":{"description":"Count of critical severity issues","type":"integer"},"high":{"description":"Count of high severity issues","type":"integer"},"low":{"description":"Count of low severity issues","type":"integer"},"medium":{"description":"Count of medium severity issues","type":"integer"}},"required":["critical","high","medium","low"],"type":"object"},"monitor_created_at":{"description":"Timestamp when the monitor was created","format":"date-time","type":"string"},"monitor_id":{"description":"The ID of the monitor associated with this project","format":"uuid","type":"string"},"org_id":{"description":"The ID of the organization that owns this project","format":"uuid","type":"string"},"project_type":{"description":"Type of the project (e.g., npm, maven)","enum":["rubygems","composer","sbt","maven","gomodules","poetry","cocoapods","pipenv","pnpm","pub","yarn","yarn-workspace","paket","pip","unmanaged","gradle","nuget","cpp","npm","conan","govendor","hex","golangdep","cargo","swift","golang","secrets","iac","uv","sast","armconfig","helmconfig","terraformconfig","cloudformationconfig","k8sconfig","cloudconfig","dockerfile","deb","apk","linux","rpm"],"type":"string"},"risk_score":{"description":"The calculated risk score for this project","type":"integer"},"snapshot_created_at":{"description":"Timestamp when the snapshot was created","format":"date-time","type":"string"},"snapshot_id":{"description":"The ID of the snapshot","format":"uuid","type":"string"},"target_file":{"description":"Path to the manifest file","type":"string"},"target_id":{"description":"The ID of the target this project belongs to","format":"uuid","type":"string"},"target_origin":{"description":"Origin of the target (e.g., github, gitlab)","type":"string"},"target_ref":{"description":"The target reference (e.g., branch name)","type":"string"}},"type":"object"},"ProjectRelationshipData":{"additionalProperties":false,"description":"Full project resource with attributes","properties":{"attributes":{"$ref":"#/components/schemas/ProjectRelationshipAttributes"},"id":{"description":"The unique identifier of the project","example":"11111111-2222-3333-4444-555555555555","format":"uuid","type":"string"},"type":{"description":"The JSON:API resource type","enum":["project"],"example":"project","type":"string"}},"required":["id","type"],"type":"object"},"ProjectRelationshipListResponse":{"additionalProperties":false,"description":"Response containing linked projects with full attributes","properties":{"data":{"items":{"$ref":"#/components/schemas/ProjectRelationshipData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"},"links":{"$ref":"#/components/schemas/RelationshipLinks"}},"required":["data","jsonapi","links"],"type":"object"},"ProjectRelationships":{"additionalProperties":false,"properties":{"importer":{"$ref":"#/components/schemas/Relationship"},"organization":{"$ref":"#/components/schemas/Relationship"},"owner":{"$ref":"#/components/schemas/Relationship"},"target":{"oneOf":[{"$ref":"#/components/schemas/Relationship"},{"$ref":"#/components/schemas/ProjectRelationshipsTarget"}]}},"required":["target","organization"],"type":"object"},"ProjectRelationshipsTarget":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"additionalProperties":false,"properties":{"display_name":{"description":"The human readable name that represents this target. These are generated based on the provided properties, and the source. In the future we may support updating this value.\n","example":"snyk-fixtures/goof","type":"string"},"url":{"description":"The URL for the resource. We do not use this as part of our representation of the identity of the target, as it can be changed externally to Snyk We are reliant on individual integrations providing us with this value. Currently it is only provided by the CLI\n","example":"http://github.com/snyk/local-goof","nullable":true,"type":"string"}},"type":"object"},"id":{"description":"The Resource ID.","format":"uuid","type":"string"},"meta":{"properties":{"integration_data":{"description":"A collection of properties regarding integration data","type":"object"}},"type":"object"},"type":{"description":"The Resource type.","example":"target","type":"string"}},"required":["type","id","attributes"],"type":"object"},"links":{"$ref":"#/components/schemas/RelatedLink"}},"required":["data","links"],"type":"object"},"ProjectSettings20240531":{"additionalProperties":false,"properties":{"auto_dependency_upgrade":{"$ref":"#/components/schemas/AutoDependencyUpgradeSettings20240531"},"auto_remediation_prs":{"$ref":"#/components/schemas/AutoRemediationPRsSettings20240531"},"manual_remediation_prs":{"$ref":"#/components/schemas/ManualRemediationPRsSettings20240531"},"pull_request_assignment":{"$ref":"#/components/schemas/PullRequestAssignmentSettings20240531"},"pull_requests":{"$ref":"#/components/schemas/PullRequestsSettings20240531"},"recurring_tests":{"$ref":"#/components/schemas/RecurringTestsSettings"}},"required":["recurring_tests","pull_requests"],"type":"object"},"ProjectSettingsData":{"properties":{"attributes":{"additionalProperties":false,"properties":{"is_active":{"$ref":"#/components/schemas/IsActive"},"severity_threshold":{"$ref":"#/components/schemas/SeverityThreshold"},"target_channel_id":{"$ref":"#/components/schemas/TargetChannelId"},"target_channel_name":{"$ref":"#/components/schemas/TargetChannelName"},"target_project_name":{"description":"The target file name for the project.","example":"snyk/goof:package.json","type":"string"}},"required":["target_channel_id","target_channel_name","severity_threshold","target_project_name","is_active"],"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"type":{"example":"slack","type":"string"}},"type":"object"},"ProjectSettingsPatchRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"minProperties":1,"properties":{"is_active":{"$ref":"#/components/schemas/IsActive"},"severity_threshold":{"$ref":"#/components/schemas/SeverityThreshold"},"target_channel_id":{"$ref":"#/components/schemas/TargetChannelId"}},"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"type":{"enum":["slack"],"type":"string"}},"required":["type","attributes","id"],"type":"object"}},"type":"object"},"ProposedBaseImages":{"description":"Categorized base image upgrade recommendations","properties":{"alternative_upgrade":{"items":{"$ref":"#/components/schemas/ImageInfo"},"type":"array"},"major_upgrade":{"items":{"$ref":"#/components/schemas/ImageInfo"},"type":"array"},"minor_upgrade":{"items":{"$ref":"#/components/schemas/ImageInfo"},"type":"array"}},"type":"object"},"PublicApp":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/PublicAppAttributes__0"},"id":{"$ref":"#/components/schemas/Id"},"links":{"$ref":"#/components/schemas/Links"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id"],"type":"object"},"PublicAppAttributes":{"additionalProperties":false,"properties":{"client_id":{"$ref":"#/components/schemas/Uuid"},"context":{"$ref":"#/components/schemas/Context"},"name":{"$ref":"#/components/schemas/AppName"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["name","client_id"],"type":"object"},"PublicAppAttributes__0":{"properties":{"client_id":{"$ref":"#/components/schemas/ClientId__0"},"context":{"$ref":"#/components/schemas/Context"},"name":{"$ref":"#/components/schemas/AppName"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"required":["name","client_id"],"type":"object"},"PublicAppData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/PublicAppAttributes"},"id":{"$ref":"#/components/schemas/Uuid"},"links":{"$ref":"#/components/schemas/Links"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id"],"type":"object"},"PublicFacingRiskFactor":{"properties":{"included_in_score":{"default":false,"type":"boolean"},"links":{"$ref":"#/components/schemas/RiskFactorLinks"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"type":"boolean"}},"required":["name","updated_at","value"],"type":"object"},"PublicTarget":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"created_at":{"description":"The creation date of the target","example":"2022-09-01T00:00:00Z","format":"date-time","type":"string"},"display_name":{"description":"The human readable name that represents this target. These are generated based on the provided properties, and the source.\n","example":"snyk-fixtures/goof","type":"string"},"is_private":{"description":"If the target is private, or publicly accessible","example":false,"type":"boolean"},"url":{"description":"The URL for the resource.","example":"http://github.com/snyk/local-goof","nullable":true,"type":"string"}},"required":["display_name","url","is_private"],"type":"object"},"id":{"description":"The id of this target","example":"55a348e2-c3ad-4bbc-b40e-9b232d1f4121","format":"uuid","type":"string"},"relationships":{"additionalProperties":false,"properties":{"integration":{"additionalProperties":false,"description":"The configured integration which this target relates to","properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"integration_type":{"description":"The human readable name for this type of integration","example":"gitlab","type":"string"}},"required":["integration_type"],"type":"object"},"id":{"example":"7667dae6-602c-45d9-baa9-79e1a640f199","format":"uuid","nullable":true,"type":"string"},"type":{"description":"Content type.","example":"integration","type":"string"}},"required":["id","type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"organization":{"additionalProperties":false,"description":"The organization which owns this target","properties":{"data":{"additionalProperties":false,"properties":{"id":{"example":"e661d4ef-5ad5-4cef-ad16-5157cefa83f5","format":"uuid","type":"string"},"type":{"description":"Content type.","example":"organization","type":"string"}},"required":["type","id"],"type":"object"}},"required":["data"],"type":"object"}},"required":["organization","integration"],"type":"object"},"type":{"description":"Content type.","example":"target","type":"string"}},"required":["type","id","attributes"],"type":"object"},"PullRequestAssignmentSettings20240531":{"additionalProperties":false,"description":"Automatically assign pull requests created by Snyk (limited to private repos). If not specified, settings will be inherited from the Organization's integration.","properties":{"assignees":{"description":"Manually specify users to assign (and all will be assigned).","example":["my-github-username"],"items":{"type":"string"},"type":"array"},"is_enabled":{"description":"Automatically assign pull requests created by Snyk.","example":true,"type":"boolean"},"type":{"description":"Automatically assign the last user to change the manifest file (\"auto\"), or manually specify a list of users (\"manual\").","enum":["auto","manual"],"example":"auto","type":"string"}},"type":"object"},"PullRequestTemplateAttributes":{"additionalProperties":false,"minProperties":1,"properties":{"commit_message":{"description":"The commit message that will be used when the pull request is created","example":"chore(deps): bump {{package_name}} from {{package_from}} to {{package_to}}","minLength":1,"type":"string"},"description":{"description":"The description of the pull request","example":"{{ #is_upgrade_pr }} This PR has been opened to make sure our repositories are kept up-to-date. It updates {{ package_name }} from version {{ package_from }} to version {{ package_to }}. Review relevant docs for possible breaking changes. {{ /is_upgrade_pr }}\n","minLength":1,"type":"string"},"title":{"description":"Specify a title for the pull request","example":"Snyk has created this PR to upgrade {{package_name}} from {{package_from}} to {{package_to}}.","minLength":1,"type":"string"}},"type":"object"},"PullRequestsSettings20240531":{"additionalProperties":false,"description":"Settings which describe how pull requests for a project are tested.","properties":{"fail_only_for_issues_with_fix":{"description":"Only fail when the issues found have a fix available.","example":true,"type":"boolean"},"is_enabled":{"description":"Test pull requests for vulnerabilities. If this value is unset, the setting is inherited from the org default.","example":true,"type":"boolean"},"policy":{"description":"Fail if the project has any issues (\"all\"), or fail if a PR is introducing a new dependency with issues (\"only_new\"). If this value is unset, the setting is inherited from the org default.","enum":["all","only_new"],"example":"all","type":"string"},"severity_threshold":{"description":"Only fail for issues greater than or equal to the specified severity. If this value is unset, the setting is inherited from the org default.","enum":["low","medium","high","critical"],"example":"high","type":"string"}},"type":"object"},"PullRequsetTemplateId":{"example":"https://api.snyk.io/rest/groups/7626925e-4b0f-11ee-be56-0242ac120002/pull_request_template","format":"uri","type":"string"},"QuayCrAttributes":{"properties":{"required":{"properties":{"broker_client_url":{"example":"https://\u003cbroker.client.hostname\u003e:\u003cport\u003e","type":"string"},"cr_agent_url":{"example":"https://\u003cagent-host\u003e:\u003cagent-port\u003e","type":"string"},"cr_base":{"type":"string"},"cr_password":{"format":"uuid","type":"string"},"cr_username":{"type":"string"}},"required":["cr_base","cr_username","cr_password","broker_client_url","cr_agent_url"],"type":"object"},"type":{"enum":["quay-cr"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"QueryVersion":{"description":"Requested API version","example":"2024-10-15","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"},"Rating":{"description":"Rating represents qualitative metrics on a finding.","properties":{"severity":{"allOf":[{"$ref":"#/components/schemas/Severity"}],"description":"Severity level of the finding."}},"required":["severity"],"type":"object"},"ReachabilityEvidence":{"description":"Indicate the reachability signals as additional evidence for the finding.","properties":{"paths":{"description":"Paths by which the vulnerable code can be reached.\n\nIncludes the name of the function, the path through the\nsource code that reaches the function, and the location\nat which the vulnerable function is called.","items":{"$ref":"#/components/schemas/ReachablePath"},"minItems":1,"type":"array"},"reachability":{"$ref":"#/components/schemas/ReachabilityType"},"source":{"enum":["reachability"],"type":"string"}},"required":["source","reachability"],"type":"object"},"ReachabilityFilter":{"description":"Represent various reachability filters available for findings.","enum":["reachable","no_path_found","no_info"],"type":"string"},"ReachabilityType":{"description":"Reachability enum for reachability signal.","enum":["none","function","no_info","not_applicable"],"type":"string"},"ReachablePath":{"description":"ReachablePath represents the paths to a vulnerable function.","properties":{"call_paths":{"description":"Paths in code bundle that call the vulnerable function.","items":{"type":"string"},"type":"array"},"function_name":{"description":"Vulnerable function name.","type":"string"},"location":{"allOf":[{"$ref":"#/components/schemas/FileRegion"}],"description":"Location in a file where the vulnerability can be found."}},"required":["function_name","call_paths"],"type":"object"},"ReadTenantMembershipResponseRelationships":{"additionalProperties":false,"properties":{"role":{"$ref":"#/components/schemas/TenantMembershipTenantRoleRelationshipFull"},"tenant":{"$ref":"#/components/schemas/TenantMembershipTenantRelationshipFull"},"user":{"$ref":"#/components/schemas/TenantMembershipUserRelationshipFullWithMeta"}},"required":["role","tenant","user"],"type":"object"},"RecurringTestsSettings":{"additionalProperties":false,"description":"Settings which describe how recurring tests are run for a project.","properties":{"frequency":{"description":"Test frequency of a project. Also controls when automated PRs may be created.","enum":["daily","weekly","never"],"example":"daily","type":"string"}},"type":"object"},"RedirectUris":{"description":"List of allowed redirect URIs (OAuth callbacks) where Snyk will redirect users after authorization.\n\nThese are URLs controlled by your application that Snyk will send the user to after they authorize your app. \nThe redirect URI used in your authorization request must exactly match one of the URIs registered here.\n\n**Important:** The redirect URI in your OAuth authorization request must be an exact match (including protocol, domain, path, and query parameters) to one of the URIs specified in this list.\n\n**Example valid redirect URI:** `https://example.com/callback` or `https://myapp.example.com/auth/snyk/callback`\n\nFor more information on the complete OAuth workflow, see the [Snyk Apps API tutorial](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/tutorial-create-a-snyk-app).\n","example":["https://example.com/callback","https://example.com/auth/snyk/callback"],"items":{"format":"uri","type":"string"},"minItems":1,"type":"array"},"RedirectUrisNoMin":{"description":"List of allowed redirect URIs (OAuth callbacks) where Snyk will redirect users after authorization.\n\nThese are URLs controlled by your application that Snyk will send the user to after they authorize your app. \nThe redirect URI used in your authorization request must exactly match one of the URIs registered here.\n\n**Important:** The redirect URI in your OAuth authorization request must be an exact match (including protocol, domain, path, and query parameters) to one of the URIs specified in this list.\n\n**Example valid redirect URI:** `https://example.com/callback` or `https://myapp.example.com/auth/snyk/callback`\n\nFor more information on the complete OAuth workflow, see the [Snyk Apps API tutorial](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/tutorial-create-a-snyk-app).\n","example":["https://example.com/callback","https://example.com/auth/snyk/callback"],"items":{"format":"uri","type":"string"},"type":"array"},"RelatedLink":{"additionalProperties":false,"example":{"related":"https://example.com/api/other_resource"},"properties":{"related":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"Relationship":{"example":{"data":{"id":"4a72d1db-b465-4764-99e1-ecedad03b06a","type":"resource"},"links":{"related":{"href":"https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"}}},"properties":{"data":{"additionalProperties":false,"properties":{"id":{"example":"4a72d1db-b465-4764-99e1-ecedad03b06a","format":"uuid","type":"string"},"type":{"description":"Type of the related resource","example":"resource","pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"}},"required":["type","id"],"type":"object"},"links":{"$ref":"#/components/schemas/RelatedLink"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","links"],"type":"object"},"RelationshipLinks":{"allOf":[{"$ref":"#/components/schemas/JsonApiLinks"},{"$ref":"#/components/schemas/PaginationLinks"}],"description":"Links for relationship endpoint responses (combines relationship + pagination links)"},"RelationshipObjectToOne":{"properties":{"data":{"$ref":"#/components/schemas/RelationshipObjectToOneData"}},"required":["data"],"type":"object"},"RelationshipObjectToOneData":{"properties":{"id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"required":["id","type"],"type":"object"},"Remedy3":{"properties":{"description":{"description":"A markdown-formatted optional description of this remedy.","example":"Upgrade the package version to 5.4.0,6.4.0 to fix this vulnerability","type":"string"},"details":{"properties":{"upgrade_package":{"description":"A minimum version to upgrade to in order to remedy the issue.","example":"5.4.0,6.4.0","type":"string"}},"type":"object"},"type":{"description":"The type of the remedy. Always ‘indeterminate’.","example":"indeterminate","type":"string"}},"type":"object"},"RepositoryGroup":{"description":"A repository with its matching tags grouped together","properties":{"repository":{"description":"The repository name","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/ImageTag"},"type":"array"}},"required":["repository","tags"],"type":"object"},"Resolution":{"additionalProperties":false,"description":"An optional field recording when and via what means an issue was resolved, if it was resolved.\nResolved issues are retained for XX days.\n","properties":{"details":{"description":"Optional details about the resolution. Used by Snyk Cloud so far.","type":"string"},"resolved_at":{"description":"The time when this issue was resolved.","format":"date-time","type":"string"},"type":{"$ref":"#/components/schemas/ResolutionTypeDef"}},"required":["type","resolved_at"],"type":"object"},"ResolutionTypeDef":{"enum":["disappeared","fixed"],"type":"string"},"ResourceAttributes":{"example":{"created_at":"2022-08-10T17:19:33.14749Z","hash":"3333342563a86c675333de5848c9220a7bb35c039e7b9c0688c10f72b4666666","kind":"runtime","location":"us-west-2","name":"example-bucket","namespace":"us-west-2","native_id":"arn:aws:s3:::example-bucket","options":"json here","origin":"aws-account","platform":"aws","resource_id":"example-bucket","resource_type":"aws_s3_bucket","revision":1,"state":{"acl":"private","arn":"arn:aws:s3:::example-bucket","bucket":"example-bucket"},"tags":{"stage":"prod"},"updated_at":"2022-08-10T17:19:33.14749Z"},"properties":{"created_at":{"description":"When the resource was first recorded","example":"2022-08-10T17:19:33.14749Z","format":"date-time","type":"string"},"deleted_at":{"format":"date-time","nullable":true,"type":"string"},"hash":{"description":"Computed hash value for the resource based on its attributes","example":"3333342563a86c675333de5848c9220a7bb35c039e7b9c0688c10f72b4666666","type":"string"},"is_managed":{"nullable":true,"type":"boolean"},"kind":{"$ref":"#/components/schemas/ResourceKind"},"location":{"description":"Physical location (AWS region)","example":"us-west-2","type":"string"},"name":{"description":"Human friendly resource name","example":"example-bucket","type":"string"},"namespace":{"description":"Resource namespace (AWS region)","example":"us-west-2","type":"string"},"native_id":{"description":"ID of the physical resource from the cloud provider (AWS ARN, if available)","example":"arn:aws:s3:::example-bucket","type":"string"},"platform":{"description":"Resource platform: aws","example":"aws","type":"string"},"relationships":{"additionalProperties":true,"type":"object"},"removed_at":{"format":"date-time","nullable":true,"type":"string"},"resource_id":{"description":"Unique ID for the resource","example":"4a662442-7445-55c3-adcc-cbbbdd99999","type":"string"},"resource_type":{"description":"Terraform resource type","example":"aws_s3_bucket","type":"string"},"revision":{"description":"Increment for each change to a resource","example":2,"type":"integer"},"schema_version":{"nullable":true,"type":"string"},"source_location":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"state":{"additionalProperties":true,"description":"Terraform state attributes","type":"object"},"tags":{"additionalProperties":true,"description":"Resource tags from the cloud provider","example":{"stage":"prod"},"type":"object"},"updated_at":{"description":"When the resource was last updated","example":"2022-08-10T17:19:33.14749Z","format":"date-time","nullable":true,"type":"string"}},"required":["created_at","updated_at","revision","kind","hash","platform","resource_type","resource_id"],"type":"object"},"ResourceKind":{"description":"Kind of resource: cloud","example":"cloud - cloud - iac","type":"string"},"ResourcePath":{"example":",5.4.0),[6.0.0.pr1,6.4.0)","maxLength":2024,"minLength":1,"type":"string"},"ResourcePathRepresentation":{"description":"An object that contains an opaque identifying string.","properties":{"resource_path":{"$ref":"#/components/schemas/ResourcePath"}},"required":["resource_path"],"type":"object"},"ResourceReference":{"additionalProperties":false,"properties":{"id":{"example":"4a72d1db-b465-4764-99e1-ecedad03b06a","format":"uuid","type":"string"},"type":{"description":"Type of the related resource","example":"resource","pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"}},"required":["type","id"],"type":"object"},"ResourceRelationships":{"additionalProperties":true,"description":"Resource relationships","example":{"environment":{"data":{"id":"11000000-0000-0000-0000-000000000000","type":"environment"},"links":{"related":"/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..."}},"organization":{"data":{"id":"10000000-0000-0000-0000-000000000000","type":"organization"},"links":{"related":"/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..."}},"scan":{"data":{"id":"12000000-0000-0000-0000-000000000000","type":"scan"},"links":{"related":"/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..."}}},"type":"object"},"Risk":{"additionalProperties":false,"description":"Risk prioritization information for an issue","example":{"factors":[{"name":"deployed","updated_at":"2023-09-07T13:36:37Z","value":true}],"score":{"model":"v4","value":700}},"properties":{"factors":{"description":"Risk factors identified for an issue","items":{"$ref":"#/components/schemas/RiskFactor"},"type":"array"},"score":{"$ref":"#/components/schemas/RiskScore"}},"required":["factors"],"type":"object"},"RiskFactor":{"discriminator":{"mapping":{"deployed":"#/components/schemas/DeployedRiskFactor","loaded_package":"#/components/schemas/LoadedPackageRiskFactor","os_condition":"#/components/schemas/OSConditionRiskFactor","public_facing":"#/components/schemas/PublicFacingRiskFactor"},"propertyName":"name"},"oneOf":[{"$ref":"#/components/schemas/DeployedRiskFactor"},{"$ref":"#/components/schemas/OSConditionRiskFactor"},{"$ref":"#/components/schemas/PublicFacingRiskFactor"},{"$ref":"#/components/schemas/LoadedPackageRiskFactor"}]},"RiskFactorLinks":{"properties":{"evidence":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"RiskScore":{"description":"Risk prioritization score based on an analysis model","example":{"model":"v1","value":700},"properties":{"model":{"description":"Risk scoring model used to calculate the score value","type":"string"},"updated_at":{"format":"date-time","type":"string"},"value":{"description":"Risk score value, which may be used for overall prioritization","maximum":1000,"minimum":0,"type":"integer"}},"required":["value","model"],"type":"object"},"RoleId":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"RootFs":{"description":"Root filesystem information with ordered layer diff IDs.\nEach diff_id is a SHA256 digest of the uncompressed layer content.\n","properties":{"diff_ids":{"description":"Diff IDs for each layer (SHA256 of uncompressed content)","items":{"maxLength":1024,"type":"string"},"maxItems":256,"type":"array"},"type":{"description":"Root filesystem type (e.g., \"layers\")","maxLength":128,"type":"string"}},"required":["diff_ids","type"],"type":"object"},"RsqlFilterString":{"description":"RSQL filter expression for filtering results.\n\n**Supported operators:**\n- `==` (equal), `!=` (not equal)\n- `\u003c` or `=lt=` (less than), `\u003e` or `=gt=` (greater than)\n- `\u003c=` or `=le=` (less than or equal), `\u003e=` or `=ge=` (greater than or equal)\n- `=in=(val1,val2)` (IN list), `=out=(val1,val2)` (NOT IN list)\n- `;` or ` and ` (logical AND), `,` or ` or ` (logical OR) - word operators are case-insensitive\n\n**Wildcard pattern matching:**\nUse `*` (asterisk) for flexible string matching with `==` and `!=` operators:\n- `*value*` - Contains (e.g., `registry==*docker*` matches \"docker.io\")\n- `value*` - Starts with (e.g., `registry==docker*` matches \"docker.io\")\n- `*value` - Ends with (e.g., `name==*nginx` matches \"library/nginx\")\n- `!=*value*` - Does not contain (e.g., `class!=*test*`)\n\nNote: Special SQL characters (%, _) are automatically escaped for security.\n\n**Quoted values:**\nValues can optionally be wrapped in single quotes (`'...'`) or double quotes (`\"...\"`).\nQuotes are stripped before comparison, so `registry=='docker.io'` is equivalent to `registry==docker.io`.\nEscaped quotes inside quoted values are supported (e.g., `name==\"O\\\"Reilly\"`).\nQuoting is required when filtering for empty values (see below).\n\n**Filtering for empty values:**\nUse empty quotes (`''` or `\"\"`) with `==` or `!=` to filter by empty fields:\n- `registry==''` - Matches assets where registry is empty\n- `registry!=''` - Matches assets where registry has a value\n\n**Multi-field substring search:**\nUse the special `q` field to search across multiple fields simultaneously using case-insensitive substring matching:\n- `q==\u003csearch_term\u003e` - Searches across all searchable string fields (labels, tags, registry, repository, name, config_digest, manifest_digest, index_digest, image_tag)\n- Only supports the `==` operator (no wildcards needed - automatically searches for substring matches)\n- Uses case-insensitive pattern matching (PostgreSQL ILIKE)\n- Does not support linguistic features like stemming or ranking\n- Special characters are automatically escaped for security\n- Can be combined with other filters: `q==nginx;type==container_images`\n\n**Supported fields:**\n\nCommon fields (apply to all asset types):\n- `q` (string) - Multi-field substring search (see above)\n- `id` (UUID) - Asset ID\n- `type` (string) - Type of asset. Allowed values: `container_images`\n- `class` (string) - Class of asset (e.g., A, B)\n- `created_at` (timestamp) - Asset creation timestamp (ISO 8601 format)\n- `updated_at` (timestamp) - Asset last update timestamp (ISO 8601 format)\n- `labels` (string array) - Asset labels\n- `tags` (object) - Asset tags. Requires a sub-field (e.g., `tags.env==production`)\n\nContainer image fields (apply when type is `container_images`):\n- `registry` (string) - Container image registry (e.g., docker.io)\n- `repository` (string) - Container image repository path\n- `name` (string) - Container image name\n- `config_digest` (string) - Image config digest\n- `manifest_digest` (string) - Distribution manifest digest\n- `index_digest` (string) - Distribution index digest\n- `image_tag` (string) - Image tag from discovery source\n- `image_labels` (object) - OCI image config labels. Requires a sub-field (e.g., `image_labels.vendor==nginx`)\n\n**Examples:**\n- `q==nginx` - Multi-field substring search for \"nginx\"\n- `q==docker.io;type==container_images` - Search \"docker.io\" substring in container images only\n- `type==container_images` - Exact match on asset type\n- `registry==*docker*` - Registry contains \"docker\" (wildcard)\n- `created_at\u003e2024-01-01` or `created_at=gt=2024-01-01` - Date comparison\n- `class==A;created_at=ge=2024-01-01` - AND combination\n- `labels=in=(production,staging)` - Labels IN list\n- `tags.env==production` - Tag sub-field filter\n- `image_labels.vendor==nginx` - Image label sub-field filter\n- `registry=='docker.io'` - Quoted value (equivalent to `registry==docker.io`)\n- `registry==''` - Assets where registry is empty\n- `registry!=''` - Assets where registry has a value\n","example":"type==container_images;created_at\u003e2024-01-01","type":"string"},"SSOConnection":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/SSOConnectionAttributes"},"id":{"example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"type":{"description":"Content type.","example":"sso_connection","type":"string"}},"required":["type","id","attributes"],"type":"object"},"SSOConnectionAttributes":{"additionalProperties":false,"properties":{"name":{"description":"The display name of the sso connection.","example":"My SSO","type":"string"}},"required":["name"],"type":"object"},"SastEnablement":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"autofix_enabled":{"type":"boolean"},"sast_enabled":{"type":"boolean"}},"required":["sast_enabled"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"required":["type","id","attributes"],"type":"object"},"SastScanConfiguration":{"description":"Scan configuration parameters for the SAST scanner.","type":"object"},"SbomDocument":{"additionalProperties":true,"type":"object"},"SbomReachabilitySubject":{"description":"**Deprecated**\n\nProvide a BundleResource with SBOM Bundle ID,\na BundleResource with Source Bundle ID, and include\nSCA Scan Configuration instead.\n\nSBOM Reachability tests can also be initiated using\nUploadResources if using the File Upload API.\n\nTest subject for SBOM test with reachability analysis.","properties":{"code_bundle_id":{"description":"Source code to inspect for the reach of the vulnerable dependencies.","pattern":"^[a-fA-F0-9]{64}$","type":"string"},"locator":{"allOf":[{"$ref":"#/components/schemas/LocalPathLocator"}],"description":"Locate the local paths from which the SBOM and source code were derived."},"sbom_bundle_id":{"description":"The SBOM to test for vulnerable dependencies.","pattern":"^[a-fA-F0-9]{64}$","type":"string"},"type":{"enum":["sbom_reachability"],"type":"string"}},"required":["type","sbom_bundle_id","code_bundle_id","locator"],"type":"object"},"SbomResource":{"additionalProperties":false,"properties":{"id":{"example":"b68b0b85-d039-4c05-abc0-04eb50ca0fe9","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type"],"type":"object"},"SbomResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/SbomResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"}},"required":["jsonapi","data"],"type":"object"},"SbomSubject":{"description":"**Deprecated**\n\nProvide a BundleResource with SBOM Bundle ID and include\nSCA Scan Configuration instead.\n\nSBOM tests can also be initiated using an\nUploadResource if using the File Upload API.\n\nTest subject for SBOM test without reachability analysis.","properties":{"locator":{"allOf":[{"$ref":"#/components/schemas/LocalPathLocator"}],"description":"Locate the local paths from which the SBOM and source code were derived."},"sbom_bundle_id":{"description":"The SBOM to test for vulnerable dependencies.","pattern":"^[a-fA-F0-9]{64}$","type":"string"},"type":{"enum":["sbom"],"type":"string"}},"required":["type","sbom_bundle_id","locator"],"type":"object"},"SbomTestCreateAttributes":{"properties":{"format":{"type":"string"},"sbom":{"additionalProperties":true,"type":"object"}},"required":["sbom"],"type":"object"},"SbomTestResultsAttributes":{"additionalProperties":true,"type":"object"},"ScaScanConfiguration":{"description":"Scan configuration parameters for the SCA scanner.","type":"object"},"ScanAttributes":{"description":"Scan attributes","example":{"created_at":"2022-05-06T12:25:15-04:00","error":"","finished_at":"2022-05-06T12:25:15-04:00","kind":"user_initiated","options":{"role_arn":"arn:aws:iam::123456789012:role/SnykCloud1234"},"revision":1,"status":"success","updated_at":"2022-05-06T12:25:15-04:00"},"properties":{"created_at":{"description":"When the scan was created","example":"2022-05-06T12:25:15-04:00","format":"date-time","type":"string"},"deleted_at":{"format":"date-time","nullable":true,"type":"string"},"environment_id":{"description":"Environment ID","example":"052781a7-17f6-494d-0000-25c8b509abcd","format":"uuid","type":"string"},"error":{"description":"Error message if the scan failed","example":"could not start scan","nullable":true,"type":"string"},"finished_at":{"description":"When the scan finished","example":"2022-05-06T12:25:15-04:00","format":"date-time","nullable":true,"type":"string"},"kind":{"description":"Scan kind","enum":["scheduled","user_initiated","event_driven",null],"example":"user_initiated","nullable":true,"type":"string"},"options":{"example":{"role_arn":"arn:aws:iam::123456789012:role/SnykCloud1234"},"nullable":true,"type":"object"},"organization_id":{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","format":"uuid","type":"string"},"partial_errors":{"description":"Errors that didn't fail the scan","type":"string"},"revision":{"description":"Increment for each change to a scan","example":1,"type":"number"},"status":{"description":"Scan status","enum":["queued","in_progress","success","error",null],"example":"in_progress","nullable":true,"type":"string"},"updated_at":{"description":"When the scan was last updated","example":"2022-05-06T12:25:15-04:00","format":"date-time","nullable":true,"type":"string"}},"required":["created_at","revision","kind","status","error"],"type":"object"},"ScanConfiguration":{"description":"A map of scanner types to their specific set of\nconfiguration parameters.\n\nThe presence of a scanner's configuration in the\nprovided ScanConfiguration is used to determine what scans\nto run on the list of Resources provided.\n\nNote that an empty config object is different than\nomitting the field. An omitted scanner config results in\nthat scanner not being run. A provided empty scan config\nwill run the scanner if it is possible.","example":{"secrets":{}},"properties":{"container":{"$ref":"#/components/schemas/ContainerScanConfiguration"},"iac":{"$ref":"#/components/schemas/IacScanConfiguration"},"sast":{"$ref":"#/components/schemas/SastScanConfiguration"},"sca":{"$ref":"#/components/schemas/ScaScanConfiguration"},"secrets":{"$ref":"#/components/schemas/SecretsScanConfiguration"}},"type":"object"},"ScanCreateAttributes":{"additionalProperties":false,"description":"Scan create attributes","type":"object"},"ScanCreateRelationships":{"description":"Scan create relationships","properties":{"environment":{"properties":{"data":{"example":{"id":"12000000-0000-0000-0000-000000000000","type":"environment"},"properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["type","id"],"type":"object"}},"type":"object"}},"type":"object"},"ScanEngine":{"description":"Scan engine information associated with an asset","properties":{"issues":{"$ref":"#/components/schemas/IssueCounts"},"last_seen":{"description":"When the scan engine was last seen","format":"date-time","type":"string"},"link":{"description":"Link to the scan engine details","format":"uri","maxLength":1024,"type":"string"},"name":{"description":"Name of the scan engine","maxLength":256,"type":"string"},"type":{"description":"Type of scan engine","enum":["sca","sast","container","iac","secrets"],"type":"string"}},"required":["type","name","last_seen","issues"],"type":"object"},"ScanItemType":{"enum":["project","environment"],"example":"project","type":"string"},"ScanRelationships":{"additionalProperties":true,"description":"Scan relationships","example":{"environment":{"data":{"id":"12000000-0000-0000-0000-000000000000","type":"environment"},"links":{"related":"/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..."}},"organization":{"data":{"id":"10000000-0000-0000-0000-000000000000","type":"organization"},"links":{"related":"/path/to/\u003crelated resource\u003e/\u003crelated-id\u003e?version=\u003cresolved version\u003e\u0026..."}}},"type":"object"},"ScanType":{"example":"scan","type":"string"},"ScmBundleStoreAttributes":{"properties":{"target_id":{"description":"The id of the target which has been imported into Snyk.","format":"uuid","type":"string"},"target_version":{"description":"The branch or commit hash to scan","example":"main","type":"string"}},"required":["target_id"],"type":"object"},"ScmBundleStoreData":{"properties":{"attributes":{"$ref":"#/components/schemas/ScmBundleStoreAttributes"},"type":{"enum":["ai_bom_scm_bundle"],"type":"string"}},"required":["type","attributes"],"type":"object"},"ScmContext":{"description":"Additional SCM information about a resource.\nProvides context about where the content came from; the resource itself is the testable item.\nScmResource does not use this; it identifies SCM via its own fields.","properties":{"branch":{"maxLength":256,"type":"string"},"commit_ref":{"maxLength":1024,"type":"string"},"repo_url":{"maxLength":1024,"type":"string"}},"type":"object"},"ScmRepoLocator":{"description":"ScmRepoLocator locates a test subject by SCM repository coordinates.","properties":{"branch_name":{"description":"Branch name, if known and applicable to locating the test subject.\n\nIf not specified, the branch name can be assumed to be the \"default\nintegration branch\" of the repository.","type":"string"},"type":{"enum":["scm_repo"],"type":"string"},"url":{"description":"URL of the SCM repository.","format":"uri","type":"string"}},"required":["type","url"],"type":"object"},"ScmResource":{"description":"Resource representing a repository of source files located in\na Source Code Management tool (e.g. GitHub).\n\nScmResources provide Snyk with the requisite information to\nlocate and scan the source files located in the repository.\n\nCurrently supported scans utilizing ScmResources are:\n- SAST scans on (1) ScmResource that references a repo already\nimported into Snyk","example":{"commit":"8dbd1ea7201a0d49603467981075a633d91e40b9","file_patterns":[],"integration_id":"00000000-0000-0000-0000-000000000000","ref":"main","repo_url":"https://github.com/example/repo","type":"scm"},"properties":{"commit":{"description":"Commit hash to reference specifically.","maxLength":1024,"type":"string"},"file_patterns":{"description":"File Patterns to include in the scan. Elements must be less than 256 characters.\n\nCurrently unsupported. Provide an empty list.","items":{"$ref":"#/components/schemas/String256"},"maxItems":20,"type":"array"},"integration_id":{"description":"Integration ID assigned to the specific SCM.\nThis ID can be found in the Snyk UI by navigating to\n\"Settings\" \u003e \"Integrations\" \u003e \"\u003cYour SCM\u003e\"\n\nThe ID will be displayed under \"General\" \u003e \"Integration ID\"","format":"uuid","type":"string"},"ref":{"description":"Ref contains a branch name or other non-commit hash reference\nto a version of the content.","maxLength":1024,"type":"string"},"repo_url":{"description":"URL at which the repository can be found in the SCM.","example":"https://github.com/snyk/cli","maxLength":1024,"type":"string"},"type":{"enum":["scm"],"type":"string"}},"required":["type","repo_url","integration_id"],"type":"object"},"Scopes":{"description":"The scopes this app is allowed to request during authorization.","items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"},"SdlcStage":{"description":"SDLC stage where the test was initiated.","enum":["ide","cli","pr_check","ci_cd","mcp","other"],"type":"string"},"SearchAttributesObject":{"properties":{"attribute":{"description":"Name of the Asset attribute to filter on, not required if a logical operator is used","enum":["id","type","removed","name","repository_url","file_path","sources","risk_factors","repository_freshness","browse_url","image_id","image_digests","image_tags","image_repositories","image_registries","tags","class","organizations","created_at","updated_at"],"type":"string"},"operator":{"description":"Required, name of the Operator for the query","enum":["and","or","equal","not_equal","contains","not_contains","starts_with","ends_with","in","not_in","greater_than","lower_than","equal_or_greater_than","equal_or_lower_than"],"type":"string"},"values":{"description":"Required values, which can be strings, dates, integers, booleans, or nested attributes","items":{"anyOf":[{"description":"A string value","type":"string"},{"description":"A date value in ISO 8601 format","format":"date","type":"string"},{"description":"An integer value","type":"integer"},{"description":"Search object","type":"object"},{"description":"A boolean value","type":"boolean"}]},"type":"array"}},"required":["operator","values"],"type":"object"},"SearchObject":{"description":"The request body can be empty or include query parameters.","properties":{"query":{"properties":{"attributes":{"$ref":"#/components/schemas/SearchAttributesObject"}},"required":["attributes"],"type":"object"}},"type":"object"},"SecretAttributes":{"additionalProperties":false,"properties":{"encrypted":{"type":"string"},"expires_at":{"format":"date-time","type":"string"},"nonce":{"type":"string"}},"required":["nonce","encrypted","expires_at"],"type":"object"},"SecretsScanConfiguration":{"description":"Scan configuration parameters for the Secrets scanner.","type":"object"},"SecurityDetails":{"additionalProperties":false,"description":"Security signals for the package","properties":{"description":{"description":"Human-readable explanation of the security rating","type":"string"},"direct_vulnerabilities":{"description":"Whether the package has direct vulnerabilities","type":"boolean"},"direct_vulnerabilities_counts":{"$ref":"#/components/schemas/DirectVulnerabilitiesCounts"},"direct_vulnerabilities_total":{"description":"Total count of direct vulnerabilities (\u003e= 0)","minimum":0,"type":"integer"},"rating":{"description":"Security rating based on known vulnerabilities","enum":["No known security issues","Minor security issues found","Security issues found"],"type":"string"}},"required":["direct_vulnerabilities","direct_vulnerabilities_total"],"type":"object"},"SelfLink":{"additionalProperties":false,"example":{"self":"https://example.com/api/this_resource"},"properties":{"self":{"$ref":"#/components/schemas/LinkProperty"}},"type":"object"},"ServiceAccount":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"access_token":{"description":"The Snyk access token for this service account. Only returned on creation, and only when auth_type is access_token..","type":"string"},"access_token_expires_at":{"description":"The expiry date of the access token. Only provided when auth_type is access_token.","example":"2025-08-16T00:00:00Z","format":"date-time","type":"string"},"access_token_ttl_seconds":{"description":"The time, in seconds, that an oauth access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_client_secret or oauth_private_key_jwt.","type":"number"},"api_key":{"description":"The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.","type":"string"},"auth_type":{"description":"The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an oauth access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out in OIDC Connect Core 1.0, section 9.\n * access_token - Access tokens are long-lived, can be used more than once for increased flexibility, and have expiries for enhanced security.","enum":["api_key","oauth_client_secret","oauth_private_key_jwt","access_token"],"type":"string"},"client_id":{"description":"The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_client_secret or oauth_private_key_jwt.","type":"string"},"client_secret":{"description":"The client secret used for obtaining oauth access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.","type":"string"},"created_at":{"description":"The time at which the service account was created.","example":"2025-08-16T00:00:00Z","format":"date-time","type":"string"},"jwks_url":{"description":"A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.","type":"string"},"level":{"description":"The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.","enum":["Group","Org"],"type":"string"},"name":{"description":"A human-friendly name of the service account.","type":"string"},"role_id":{"description":"The ID of the role which the Service Account is associated with.","format":"uuid","type":"string"}},"required":["name","auth_type","role_id"],"type":"object"},"id":{"format":"uuid","type":"string"},"links":{"$ref":"#/components/schemas/Links"},"type":{"type":"string"}},"required":["type","id","attributes"],"type":"object"},"ServiceAccount20240422":{"additionalProperties":false,"properties":{"default_org_context":{"description":"ID of the default org for the service account.","format":"uuid","type":"string"},"name":{"description":"The name of the service account.","example":"user","type":"string"}},"required":["name"],"type":"object"},"SessionAttributes":{"properties":{"created_at":{"format":"date-time","type":"string"}},"required":["created_at"],"type":"object"},"SessionData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/SessionAttributes"},"id":{"$ref":"#/components/schemas/Id"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type","id","attributes"],"type":"object"},"SettingsAttributes":{"additionalProperties":false,"properties":{"severity_threshold":{"$ref":"#/components/schemas/SeverityThreshold"},"target_channel_id":{"$ref":"#/components/schemas/TargetChannelId"}},"required":["target_channel_id","severity_threshold"],"type":"object"},"SettingsRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/SettingsAttributes"},"type":{"enum":["slack"],"type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"Severity":{"description":"Indicate the severity of a finding discovered by a Test.","enum":["critical","high","medium","low","none","other"],"type":"string"},"Severity3":{"properties":{"level":{"description":"Level of severity calculated via vector","example":"medium","type":"string"},"score":{"description":"The CVSS score calculated from the vector, representing the severity of the vulnerability on a scale from 0 to 10.","example":5.3,"nullable":true,"type":"number"},"source":{"description":"The source of this severity. The value must be the id of a referenced problem or class, in which case that problem or class is the source of this issue. If source is omitted, this severity is sourced internally in the Snyk application.","example":"Snyk","type":"string"},"type":{"description":"Indicates if the CVSS item is primary or secondary. Clients should prefer the primary CVSS vector.","example":"primary","type":"string"},"vector":{"description":"CVSS vector string detailing the metrics of a vulnerability.","example":"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:L","nullable":true,"type":"string"},"version":{"description":"CVSS version being described.","example":"4.0","type":"string"}},"type":"object"},"SeverityLevel":{"enum":["low","medium","high","critical"],"type":"string","x-enum-varnames":["Low","Medium","High","Critical"]},"SeverityThreshold":{"description":"Minimum Snyk issue severity to send a notification for, messages will not be sent for any issue below this value","enum":["low","medium","high","critical"],"example":"high","type":"string"},"SlackChannel":{"properties":{"attributes":{"properties":{"name":{"description":"Name of the Slack Channel","example":"general","type":"string"},"type":{"description":"Channel type","enum":["public","private","direct_message","multiparty_direct_message"],"type":"string"}},"type":"object"},"id":{"example":"slack://channel?team=T123456\u0026id=C123456","format":"uri","type":"string"},"type":{"example":"slack_channel","type":"string"}},"type":"object"},"SlackDefaultSettingsData":{"properties":{"attributes":{"additionalProperties":false,"properties":{"severity_threshold":{"$ref":"#/components/schemas/SeverityThreshold"},"target_channel_id":{"$ref":"#/components/schemas/TargetChannelId"},"target_channel_name":{"$ref":"#/components/schemas/TargetChannelName"}},"required":["target_channel_id","target_channel_name","severity_threshold"],"type":"object"},"id":{"$ref":"#/components/schemas/Uuid"},"type":{"example":"slack","type":"string"}},"type":"object"},"Slots":{"properties":{"disclosure_time":{"description":"The time at which this vulnerability was disclosed.","example":"2022-06-16T13:51:13Z","format":"date-time","type":"string"},"exploit_details":{"$ref":"#/components/schemas/ExploitDetails"},"publication_time":{"description":"The time at which this vulnerability was published.","example":"2022-06-16T14:00:24.315507Z","type":"string"},"references":{"items":{"properties":{"title":{"description":"Descriptor for an external reference to the issue","type":"string"},"url":{"description":"URL for an external reference to the issue","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"SnykReferenceResource":{"description":"SnykReferenceResources contain references to source code,\ncontainers, SBOMs, and other testable content that has already\nbeen provided to Snyk to create a Project or Target.\n\nIf the intended content to test is already known to Snyk as a\nProject, Target, or otherwise, this SnykReferenceResource can\nbe used to initiate a Test with the appropriate ID.\n\nCurrently no scans are supported through the Test API for\nSnykReferenceResources.","example":{"ref_id":"00000000-0000-0000-0000-000000000000","reference_type":"project","type":"snyk_ref"},"properties":{"ref_id":{"description":"ID referring the contents already known by Snyk.","format":"uuid","type":"string"},"reference_type":{"description":"Kind of Snyk reference contained in Ref ID.\n\nTargets and Projects exist in Snyk currently.\n\nAssets are a feature in-development, and are listed\nhere for future-forward compatibility.","enum":["target","project","asset"],"type":"string"},"scm_context":{"$ref":"#/components/schemas/ScmContext"},"type":{"enum":["snyk_ref"],"type":"string"}},"required":["type","reference_type","ref_id"],"type":"object"},"SonarqubeAttributes":{"properties":{"sonarqube_api_token":{"format":"uuid","type":"string"},"sonarqube_host_url":{"example":"sonarqube.customer.com","type":"string"}},"required":["sonarqube_host_url","sonarqube_api_token"],"type":"object"},"String256":{"maxLength":256,"type":"string"},"Suppression":{"description":"Details about a finding's suppression in test results.\n\nSuppressed findings do not contribute to the test outcome, but they are still\nprovided in the results.","properties":{"created_at":{"description":"When the suppression was first created.","format":"date-time","type":"string"},"expires_at":{"description":"When the suppression will expire.","format":"date-time","type":"string"},"justification":{"description":"Reason given for an ignore pending approval.","type":"string"},"path":{"description":"Dependency path to the vulnerable package to be suppressed.\n\nIf not provided, the suppression will apply to all packages with the given\nvulnerability ID.","items":{"type":"string"},"type":"array"},"policy":{"allOf":[{"$ref":"#/components/schemas/PolicyRef"}],"description":"Policy responsible for the state of suppression represented here, if available."},"skipIfFixable":{"description":"Skip the suppression if an actual fix is available.","type":"boolean"},"status":{"allOf":[{"$ref":"#/components/schemas/SuppressionStatus"}],"description":"Status of the suppression."}},"required":["status"],"type":"object"},"SuppressionStatus":{"description":"Status of a suppression on a finding.","enum":["ignored","pending_ignore_approval","other"],"type":"string"},"Tag":{"properties":{"tag_type":{"type":"string"},"tag_values":{"items":{"type":"string"},"type":"array"}},"required":["tag_type","tag_values"],"type":"object"},"TagsReplace":{"additionalProperties":{"maxLength":40,"pattern":"^[a-zA-Z0-9_/:?#@\u0026=+%~-]+$","type":"string"},"description":"Full replacement of all tags on the asset.\nAll existing tags will be removed and replaced with the provided tags.\n","maxProperties":100,"type":"object"},"TagsUpdate":{"additionalProperties":false,"description":"Updates the asset's tags by adding or removing key-value pairs.\nBoth add and remove can be specified in the same request.\nIf a tag key appears in both add and remove, the request will fail.\n","minProperties":1,"properties":{"add":{"additionalProperties":{"maxLength":40,"pattern":"^[a-zA-Z0-9_/:?#@\u0026=+%~-]+$","type":"string"},"description":"Tags to add to the asset (key-value pairs).\nTag keys must be 1-30 characters and contain only alphanumeric characters, underscores, and hyphens.\nTag values must be up to 40 characters and contain only alphanumeric characters and _/:?#@\u0026=+%~- symbols.\n","maxProperties":100,"type":"object"},"remove":{"description":"Tag keys to remove from the asset.\nTag keys must be 1-30 characters and contain only alphanumeric characters, underscores, and hyphens.\n","items":{"maxLength":30,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"maxItems":100,"type":"array"}},"type":"object"},"TargetChannelId":{"example":"slack://channel?team=team-id\u0026id=channel-id","format":"uri","type":"string"},"TargetChannelName":{"example":"channel-name","minLength":1,"type":"string"},"TargetRelationshipAttributes":{"additionalProperties":false,"description":"Attributes of the target resource","properties":{"imported_at":{"description":"Timestamp when the target was imported","format":"date-time","type":"string"},"integration_id":{"description":"The ID of the integration associated with this target","format":"uuid","type":"string"},"target_file":{"description":"Path to the manifest file","type":"string"},"target_origin":{"description":"Origin of the target (e.g., github, gitlab)","type":"string"},"target_ref":{"description":"The target reference (e.g., branch name)","type":"string"}},"type":"object"},"TargetRelationshipData":{"additionalProperties":false,"description":"Full target resource with attributes","properties":{"attributes":{"$ref":"#/components/schemas/TargetRelationshipAttributes"},"id":{"description":"The unique identifier of the target","example":"66666666-7777-8888-9999-000000000000","format":"uuid","type":"string"},"type":{"description":"The JSON:API resource type","enum":["target"],"example":"target","type":"string"}},"required":["id","type"],"type":"object"},"TargetRelationshipListResponse":{"additionalProperties":false,"description":"Response containing linked targets with full attributes","properties":{"data":{"items":{"$ref":"#/components/schemas/TargetRelationshipData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"},"links":{"$ref":"#/components/schemas/RelationshipLinks"}},"required":["data","jsonapi","links"],"type":"object"},"Tenant":{"properties":{"data":{"properties":{"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"enum":["tenant"],"type":"string"}},"required":["id","type"],"type":"object"}},"type":"object"},"TenantAttributes":{"properties":{"created_at":{"description":"The time the tenant was created.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"},"name":{"description":"The display name of the tenant.","example":"My Tenant","type":"string"},"slug":{"description":"The canonical (unique and URL-friendly) name of the tenant.","example":"my-tenant","type":"string"},"updated_at":{"description":"The time the tenant was last modified.","example":"2022-03-16T00:00:00Z","format":"date-time","type":"string"}},"required":["name","slug","created_at","updated_at"],"type":"object"},"TenantId__0":{"description":"Unique identifier for a tenant.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"TenantMembershipId":{"description":"Unique identifier for a tenant membership.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"TenantMembershipResponseAttributes":{"additionalProperties":false,"properties":{"created_at":{"$ref":"#/components/schemas/CreatedAt"}},"required":["created_at"],"type":"object"},"TenantMembershipResponseDataObject":{"properties":{"attributes":{"$ref":"#/components/schemas/TenantMembershipResponseAttributes"},"id":{"$ref":"#/components/schemas/TenantMembershipId"},"relationships":{"$ref":"#/components/schemas/ReadTenantMembershipResponseRelationships"},"type":{"$ref":"#/components/schemas/TenantMembershipType"}},"required":["id","type","attributes","relationships"],"type":"object"},"TenantMembershipTenantRelationshipDataFull":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/TenantName"}},"required":["name"],"type":"object"},"id":{"$ref":"#/components/schemas/TenantId__0"},"type":{"$ref":"#/components/schemas/TenantType"}},"required":["id","type","attributes"],"type":"object"},"TenantMembershipTenantRelationshipFull":{"additionalProperties":false,"description":"The tenant to which the membership applies.","properties":{"data":{"$ref":"#/components/schemas/TenantMembershipTenantRelationshipDataFull"}},"required":["data"],"type":"object"},"TenantMembershipTenantRoleRelationshipBasic":{"additionalProperties":false,"description":"The role held by the user in the tenant.","properties":{"data":{"$ref":"#/components/schemas/TenantMembershipTenantRoleRelationshipDataBasic"}},"required":["data"],"type":"object"},"TenantMembershipTenantRoleRelationshipDataBasic":{"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/TenantRoleId"},"type":{"$ref":"#/components/schemas/TenantRoleType"}},"required":["id","type"],"type":"object"},"TenantMembershipTenantRoleRelationshipDataFull":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/TenantRoleName"}},"required":["name"],"type":"object"},"id":{"$ref":"#/components/schemas/TenantRoleId"},"type":{"$ref":"#/components/schemas/TenantRoleType"}},"required":["id","type","attributes"],"type":"object"},"TenantMembershipTenantRoleRelationshipFull":{"additionalProperties":false,"description":"The role held by the user in the tenant.","properties":{"data":{"$ref":"#/components/schemas/TenantMembershipTenantRoleRelationshipDataFull"}},"required":["data"],"type":"object"},"TenantMembershipType":{"description":"Resource type for tenant memberships.","enum":["tenant_membership"],"type":"string"},"TenantMembershipUserRelationshipDataAttributes":{"additionalProperties":false,"properties":{"account_type":{"$ref":"#/components/schemas/UserAccountType"},"active":{"$ref":"#/components/schemas/UserIsActive"},"email":{"$ref":"#/components/schemas/UserEmail"},"login_method":{"$ref":"#/components/schemas/UserLoginMethod"},"name":{"$ref":"#/components/schemas/UserName"},"username":{"$ref":"#/components/schemas/UserUsername"}},"required":["name","email","login_method"],"type":"object"},"TenantMembershipUserRelationshipDataFullWithMeta":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/TenantMembershipUserRelationshipDataAttributes"},"id":{"$ref":"#/components/schemas/UserId"},"meta":{"additionalProperties":false,"properties":{"tenant_owner":{"description":"Whether the user is the owner of the tenant.","type":"boolean"}},"type":"object"},"type":{"$ref":"#/components/schemas/UserType"}},"required":["id","type","attributes"],"type":"object"},"TenantMembershipUserRelationshipFullWithMeta":{"additionalProperties":false,"description":"The user to which the membership belongs.","properties":{"data":{"$ref":"#/components/schemas/TenantMembershipUserRelationshipDataFullWithMeta"}},"required":["data"],"type":"object"},"TenantName":{"description":"The display name of the tenant.","example":"My Tenant","type":"string"},"TenantRelationships":{"properties":{"owner":{"properties":{"data":{"properties":{"id":{"example":"b667f176-df52-4b0a-9954-117af6b05ab7","format":"uuid","type":"string"},"type":{"description":"The type of the resource. Always 'user'.","example":"user","type":"string"}},"required":["id","type"],"type":"object"}},"required":["data"],"type":"object"}},"type":"object"},"TenantResponseData":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/TenantAttributes"},"id":{"description":"The Snyk ID of the tenant.","example":"59d6d97e-3106-4ebb-b608-352fad9c5b34","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/TenantRelationships"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","id","attributes"],"type":"object"},"TenantRoleId":{"description":"Unique identifier for a tenant role.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"TenantRoleMeta":{"additionalProperties":false,"properties":{"app_count":{"type":"integer"},"service_account_count":{"type":"integer"},"user_count":{"type":"integer"}},"type":"object"},"TenantRoleName":{"description":"The display name of the role.","example":"Role name","type":"string"},"TenantRoleResponseAttributes":{"additionalProperties":false,"properties":{"custom":{"default":false,"type":"boolean"},"description":{"type":"string"},"name":{"type":"string"},"normalized_name":{"type":"string"},"permissions":{"items":{"type":"string"},"type":"array"}},"required":["name","description","permissions","custom"],"type":"object"},"TenantRoleResponseData":{"properties":{"attributes":{"$ref":"#/components/schemas/TenantRoleResponseAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"meta":{"$ref":"#/components/schemas/TenantRoleMeta"},"relationships":{"properties":{"tenant":{"$ref":"#/components/schemas/Tenant"}},"type":"object"},"type":{"$ref":"#/components/schemas/TenantRoleType20241015"}},"required":["id","type","attributes"],"type":"object"},"TenantRoleType":{"description":"Resource type for tenant roles.","enum":["tenant_role"],"type":"string"},"TenantRoleType20241015":{"description":"The type of the resource for tenant role operations","enum":["tenant_role"],"type":"string"},"TenantRolesExternalMeta":{"properties":{"permissions":{"items":{"properties":{"description":{"example":"Edit details of the Group","type":"string"},"name":{"example":"Edit Group Details","type":"string"},"parent":{"example":"group.read","type":"string"},"value":{"type":"string"}},"required":["value","description","name"],"type":"object"},"type":"array"}},"type":"object"},"TenantType":{"description":"Resource type for tenants.","enum":["tenant"],"type":"string"},"TenantUpdateAttributes":{"additionalProperties":false,"properties":{"name":{"description":"The display name of the tenant.","example":"My Tenant","maxLength":60,"minLength":1,"type":"string"}},"required":["name"],"type":"object"},"TestAttributes":{"description":"TestAttributes represents the attributes of a Test resource.","properties":{"config":{"allOf":[{"$ref":"#/components/schemas/TestConfiguration"}],"description":"The test configuration. If not specified, caller accepts test configuration\ndefaults within the calling scope (org, group or tenant settings, etc)."},"created_at":{"description":"Creation time of the test resource.","format":"date-time","readOnly":true,"type":"string"},"effective_summary":{"allOf":[{"$ref":"#/components/schemas/FindingSummary"}],"description":"Summary of findings discovered by the test, effective to the outcome\ndecision. This summary excludes findings suppressed by policy.\n\nThis attribute is set when the test execution\ncompletes (state.execution == 'finished') successfully (without fatal errors\nblocking an outcome).","readOnly":true},"outcome":{"allOf":[{"$ref":"#/components/schemas/TestOutcome"}],"description":"The outcome of the test.\n\nThis attribute is set when the test execution\ncompletes (state.execution == 'completed') successfully (without fatal errors\nblocking an outcome).","readOnly":true},"raw_summary":{"allOf":[{"$ref":"#/components/schemas/FindingSummary"}],"description":"Summary of findings regardless of whether they are effective or not. This\nsummary includes all findings, even those suppressed by policy.\n\nThis attribute is set when the test execution\ncompletes (state.execution == 'finished') successfully (without fatal errors\nblocking an outcome).","readOnly":true},"resources":{"description":"The units of testable content to be scanned by Snyk.\n\nResources are provided in conjunction with the ScanConfiguration,\nand appropriate scans to run are determined from that combination.\n\nThere is a \"best-fit\" approach taken, and not all Resources will be\nscanned by all requested scanners. E.g. Container resources cannot be\nscanned by the SAST scanner.","example":[{"resource":{"content_type":"source","file_patterns":["*.go"],"repository_url":"https://example.com/source/repo","revision_id":"abcde12345","type":"upload"},"type":"base"},{"resource":{"ref_id":"6BD4F5E2-D4E8-4C6B-BB0E-ECF0A70423F5","reference_type":"target","type":"snyk_ref"},"type":"base"}],"items":{"$ref":"#/components/schemas/TestResource"},"type":"array"},"sdlc_stage":{"allOf":[{"$ref":"#/components/schemas/SdlcStage"}],"description":"SDLC stage where the test was initiated."},"state":{"allOf":[{"$ref":"#/components/schemas/TestState"}],"description":"The state of the test's execution.","readOnly":true},"subject":{"allOf":[{"$ref":"#/components/schemas/TestSubject"}],"description":"**Deprecated**\n\nUse an equivalent combination of Resources and\nScan Configurations instead. See Subject descriptions\nfor appropriate replacements.\n\nThe subject of a test."},"subject_locators":{"description":"**Deprecated**\n\nMetadata about testable content is located on\nResources directly.\n\nAdditional locators which may help locate the test subject across test workflows.\n\nTest subjects generally will have a primary locator. Additional locators\nmay be provided to help link the test to existing projects and/or assets in\nthe Snyk platform.","example":[{"paths":["package.json"],"type":"local_path"}],"items":{"$ref":"#/components/schemas/TestSubjectLocator"},"type":"array"},"test_facts":{"description":"Facts about the test that were computed during test execution.","items":{"$ref":"#/components/schemas/TestFact"},"readOnly":true,"type":"array"},"user_public_id":{"description":"Public identifier of the user who initiated the test.","maxLength":64,"type":"string"}},"required":["created_at","state"],"type":"object"},"TestAttributesCreate":{"description":"TestAttributes represents the attributes of a Test resource.","properties":{"config":{"allOf":[{"$ref":"#/components/schemas/TestConfiguration"}],"description":"The test configuration. If not specified, caller accepts test configuration\ndefaults within the calling scope (org, group or tenant settings, etc)."},"resources":{"description":"The units of testable content to be scanned by Snyk.\n\nResources are provided in conjunction with the ScanConfiguration,\nand appropriate scans to run are determined from that combination.\n\nThere is a \"best-fit\" approach taken, and not all Resources will be\nscanned by all requested scanners. E.g. Container resources cannot be\nscanned by the SAST scanner.","example":[{"resource":{"content_type":"source","file_patterns":["*.go"],"repository_url":"https://example.com/source/repo","revision_id":"abcde12345","type":"upload"},"type":"base"},{"resource":{"ref_id":"6BD4F5E2-D4E8-4C6B-BB0E-ECF0A70423F5","reference_type":"target","type":"snyk_ref"},"type":"base"}],"items":{"$ref":"#/components/schemas/TestResourceCreateItem"},"type":"array"},"sdlc_stage":{"allOf":[{"$ref":"#/components/schemas/SdlcStage"}],"description":"SDLC stage where the test was initiated."},"subject":{"allOf":[{"$ref":"#/components/schemas/TestSubjectCreate"}],"description":"**Deprecated**\n\nUse an equivalent combination of Resources and\nScan Configurations instead. See Subject descriptions\nfor appropriate replacements.\n\nThe subject of a test."},"subject_locators":{"description":"**Deprecated**\n\nMetadata about testable content is located on\nResources directly.\n\nAdditional locators which may help locate the test subject across test workflows.\n\nTest subjects generally will have a primary locator. Additional locators\nmay be provided to help link the test to existing projects and/or assets in\nthe Snyk platform.","example":[{"paths":["package.json"],"type":"local_path"}],"items":{"$ref":"#/components/schemas/TestSubjectLocator"},"type":"array"},"user_public_id":{"description":"Public identifier of the user who initiated the test.","maxLength":64,"type":"string"}},"type":"object"},"TestConfiguration":{"description":"Test configuration.","properties":{"local_policy":{"allOf":[{"$ref":"#/components/schemas/LocalPolicy"}],"description":"Inline configured policy options for determining outcome of this specific test.\n\nIf centrally managed policies are in scope, inline policies are overridden\nby managed policies. Policy references explain which policies were\neffective for test evaluation."},"project_business_criticality":{"maxLength":256,"type":"string"},"project_environment":{"items":{"type":"string"},"maxItems":10,"type":"array"},"project_lifecycle":{"items":{"type":"string"},"maxItems":10,"type":"array"},"project_tags":{"items":{"type":"string"},"maxItems":10,"type":"array"},"publish_report":{"description":"Publish findings into a report, viewable in the Snyk web UI.","type":"boolean"},"scan_config":{"$ref":"#/components/schemas/ScanConfiguration"},"target_name":{"maxLength":256,"type":"string"},"target_reference":{"description":"Fields from CLI.","maxLength":1024,"type":"string"},"timeout":{"allOf":[{"$ref":"#/components/schemas/TimeoutSpec"}],"description":"Maximum test time in seconds, after which execution will be cancelled and\nthe test will fail with reason \"timeout\"."}},"type":"object"},"TestData":{"description":"TestData represents a Test resource object.","properties":{"attributes":{"$ref":"#/components/schemas/TestAttributes"},"id":{"format":"uuid","readOnly":true,"type":"string"},"links":{"properties":{"findings":{"allOf":[{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"}],"description":"Link to the findings discovered by the test, when it completes."}},"readOnly":true,"type":"object"},"type":{"enum":["tests"],"type":"string"}},"required":["id","type","attributes"],"type":"object"},"TestDataCreate":{"description":"TestData represents a Test resource object.","properties":{"attributes":{"$ref":"#/components/schemas/TestAttributesCreate"},"type":{"enum":["tests"],"type":"string"}},"required":["type","attributes"],"type":"object"},"TestExecutionStates":{"enum":["pending","started","finished","errored"],"type":"string"},"TestExecutionType":{"enum":["test-workflow-execution","custom-execution"],"type":"string"},"TestFact":{"allOf":[{"$ref":"#/components/schemas/DependencyCountFact"}],"description":"TestFact represents a test fact union.","type":"object"},"TestOutcome":{"description":"Outcome of a test; pass or fail.","properties":{"breached_policies":{"allOf":[{"$ref":"#/components/schemas/PolicyRefSet"}],"description":"Test-level policies which were breached in a failing outcome.\n\nThis array may be truncated for a large number of policies."},"reason":{"allOf":[{"$ref":"#/components/schemas/TestOutcomeReason"}],"description":"Reason for the outcome, if applicable."},"result":{"allOf":[{"$ref":"#/components/schemas/PassFail"}],"description":"Whether the test passed or failed."}},"required":["result"],"type":"object"},"TestOutcomeReason":{"description":"Reasons for the outcome.","enum":["policy_breach","timeout","other"],"type":"string"},"TestPolicyResponseAttributes":{"properties":{"images_to_delete":{"description":"List of images grouped by repositories that would be deleted based on the policy rules (only populated when delete_images is enabled)","items":{"$ref":"#/components/schemas/RepositoryGroup"},"type":"array"},"images_to_import":{"description":"List of images grouped by repositories that would be imported based on the policy rules","items":{"$ref":"#/components/schemas/RepositoryGroup"},"type":"array"},"total_images_processed":{"description":"Total number of images that were evaluated during the policy test, including both matching and non-matching images","type":"integer"}},"required":["images_to_import","images_to_delete","total_images_processed"],"type":"object"},"TestRequestBody":{"description":"TestRequestBody represents the request body used when creating an Test.","properties":{"data":{"$ref":"#/components/schemas/TestDataCreate"}},"required":["data"],"type":"object"},"TestResource":{"anyOf":[{"$ref":"#/components/schemas/BaseResource"},{"$ref":"#/components/schemas/DiffResource"}],"description":"TestResources contain single instances of testable content\nto be provided to Snyk scanners.","discriminator":{"mapping":{"base":"#/components/schemas/BaseResource","diff":"#/components/schemas/DiffResource"},"propertyName":"type"}},"TestResourceCreateItem":{"anyOf":[{"$ref":"#/components/schemas/BaseResourceCreateItem"},{"$ref":"#/components/schemas/DiffResourceCreateItem"}],"description":"TestResources contain single instances of testable content\nto be provided to Snyk scanners.","discriminator":{"mapping":{"base":"#/components/schemas/BaseResourceCreateItem","diff":"#/components/schemas/DiffResourceCreateItem"},"propertyName":"type"}},"TestState":{"description":"Test execution state information.","properties":{"errors":{"description":"Errors which occurred during the execution of a test.\n\nIf execution state is errored, at least one error will be\nindicated here.","items":{"$ref":"#/components/schemas/io.snyk.api.common.Error"},"type":"array"},"execution":{"allOf":[{"$ref":"#/components/schemas/TestExecutionStates"}],"description":"Current execution state of the test. This should be polled to completion\n(\"completed\" or \"errored\") when waiting for a test result.\n\nCompletion is no guarantee of an outcome in the event of fatal errors."},"warnings":{"description":"Non-fatal errors which occurred during the execution of a test.\n\nExecution state and warnings are not linked; any of passed/failed/\nerrored tests can have warnings.","items":{"$ref":"#/components/schemas/io.snyk.api.common.Error"},"type":"array"}},"required":["execution"],"type":"object"},"TestSubject":{"description":"The subject of a test, which identifies the asset/project and content references\nnecessary to conduct a security test.","discriminator":{"mapping":{"deepcode_bundle":"#/components/schemas/DeepcodeBundleSubject","dep_graph":"#/components/schemas/DepGraphSubject","git_url_coordinates":"#/components/schemas/GitUrlCoordinatesSubject","other":"#/components/schemas/OtherSubject","sbom":"#/components/schemas/SbomSubject","sbom_reachability":"#/components/schemas/SbomReachabilitySubject"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/DeepcodeBundleSubject"},{"$ref":"#/components/schemas/DepGraphSubject"},{"$ref":"#/components/schemas/GitUrlCoordinatesSubject"},{"$ref":"#/components/schemas/SbomReachabilitySubject"},{"$ref":"#/components/schemas/OtherSubject"},{"$ref":"#/components/schemas/SbomSubject"}]},"TestSubjectCreate":{"description":"The subject of a test, which identifies the asset/project and content references\nnecessary to conduct a security test.","discriminator":{"mapping":{"deepcode_bundle":"#/components/schemas/DeepcodeBundleSubject","dep_graph":"#/components/schemas/DepGraphSubjectCreate","git_url_coordinates":"#/components/schemas/GitUrlCoordinatesSubject","other":"#/components/schemas/OtherSubject","sbom":"#/components/schemas/SbomSubject","sbom_reachability":"#/components/schemas/SbomReachabilitySubject"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/DeepcodeBundleSubject"},{"$ref":"#/components/schemas/DepGraphSubjectCreate"},{"$ref":"#/components/schemas/GitUrlCoordinatesSubject"},{"$ref":"#/components/schemas/SbomReachabilitySubject"},{"$ref":"#/components/schemas/OtherSubject"},{"$ref":"#/components/schemas/SbomSubject"}]},"TestSubjectLocator":{"discriminator":{"mapping":{"local_path":"#/components/schemas/LocalPathLocator","other":"#/components/schemas/OtherLocator","project_entity":"#/components/schemas/ProjectEntityLocator","project_name":"#/components/schemas/ProjectNameLocator","scm_repo":"#/components/schemas/ScmRepoLocator"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ProjectEntityLocator"},{"$ref":"#/components/schemas/ProjectNameLocator"},{"$ref":"#/components/schemas/ScmRepoLocator"},{"$ref":"#/components/schemas/LocalPathLocator"},{"$ref":"#/components/schemas/OtherLocator"}]},"TimeoutSpec":{"description":"Specification for a test timeout policy. If the test does not complete within\nthe seconds specified, the test will instantly complete with the given outcome.","properties":{"outcome":{"$ref":"#/components/schemas/PassFail"},"seconds":{"format":"uint32","type":"integer"}},"required":["seconds","outcome"],"type":"object"},"Titles":{"items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"Type":{"type":"string"},"TypeDef":{"description":"The type of an issue.","enum":["package_vulnerability","license","cloud","code","custom","config"],"example":"cloud","type":"string"},"Types":{"example":"resource","pattern":"^[a-z][a-z0-9]*(_[a-z][a-z0-9]*)*$","type":"string"},"UpdateAssignmentsPayload":{"properties":{"assignments_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"due_date":{"format":"date","type":"string"}},"required":["assignments_ids","due_date"],"type":"object"},"UpdateBrokerConnectionIntegrationWithContext":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"properties":{"org_id":{"format":"uuid","type":"string"}},"required":["org_id"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"enum":["broker_integration"],"type":"string"}},"required":["attributes","type","id"],"type":"object"}},"required":["data"],"type":"object"},"UpdateBrokerConnectionIntegrationWithContextResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/BrokerConnectionIntegrationWithContextResource"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data"],"type":"object"},"UpdateBrokerConnectionRequest":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CommonConnectionAttributes"},"id":{"format":"uuid","readOnly":true,"type":"string"},"type":{"enum":["broker_connection"],"type":"string"}},"required":["attributes","id","type"],"type":"object"}},"required":["data"],"type":"object"},"UpdateBrokerContextRequest":{"additionalProperties":false,"properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/BrokerContextAttributes"},"id":{"format":"uuid","type":"string"},"type":{"enum":["broker_context"],"type":"string"}},"required":["attributes","type","id"],"type":"object"}},"required":["data"],"type":"object"},"UpdateBrokerDeploymentRequest":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/BrokerDeploymentUpdateResource"}},"required":["data"],"type":"object"},"UpdateCollectionRequest":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/name"}},"required":["name"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"UpdateCollectionWithProjectsRequest":{"additionalProperties":false,"properties":{"data":{"description":"IDs of items to add to a collection","items":{"additionalProperties":false,"properties":{"id":{"format":"uuid","type":"string"},"type":{"description":"Type of the item id","enum":["project"],"type":"string"}},"required":["id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["data"],"type":"object"},"UpdateDeploymentCredentialRequest":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/DeploymentCredentialResource"}},"required":["data"],"type":"object"},"UpdateGroupPolicyAttributes":{"additionalProperties":false,"description":"Attributes of a policy that can be updated.\nAt least one of 'name', 'conditions_group', 'action_type', or 'action' must be provided.\n","minProperties":1,"properties":{"action":{"$ref":"#/components/schemas/GroupPolicyAction"},"action_type":{"$ref":"#/components/schemas/GroupPolicyActionType"},"conditions_group":{"$ref":"#/components/schemas/GroupPolicyConditionsGroup"},"name":{"type":"string"}},"type":"object"},"UpdateGroupPolicyPayload":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/UpdateGroupPolicyAttributes"},"id":{"description":"the UUID of the policy to update.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"type":{"enum":["policy"],"type":"string"}},"required":["type","attributes","id"],"type":"object"}},"required":["data"],"type":"object"},"UpdateOrgMembershipRequestBody20240825":{"additionalProperties":false,"properties":{"attributes":{"type":"object"},"id":{"description":"The Snyk ID of the organization.","example":"f60ff965-6889-4db2-8c86-0285d62f35ab","format":"uuid","type":"string"},"relationships":{"additionalProperties":false,"properties":{"role":{"properties":{"data":{"additionalProperties":false,"properties":{"id":{"description":"The Snyk ID of the Org Role.","example":"f60ff965-6889-4db2-8c86-0285d62f35ab","format":"uuid","type":"string"},"type":{"description":"The type of the resource. Always 'org_role'.","example":"org_role","type":"string"}},"required":["type","id"],"type":"object"}},"type":"object"}},"required":["role"],"type":"object"},"type":{"description":"The type of the resource. Always 'org_membership'.","example":"org_membership","type":"string"}},"required":["type","id","relationships"],"type":"object"},"UpdatePolicyAttributes":{"additionalProperties":false,"description":"Attributes of a policy that can be updated.\nAt least one of 'name', 'conditions_group', 'action', or 'review' must be provided.\n\nIn order to update the review field, the caller will need to have the\n\"Review Ignore Request\" permission.\n","properties":{"action":{"$ref":"#/components/schemas/PolicyActionIgnore"},"conditions_group":{"$ref":"#/components/schemas/PolicyConditionsGroup"},"name":{"maxLength":255,"type":"string"},"review":{"$ref":"#/components/schemas/UpdatePolicyReview"}},"type":"object"},"UpdatePolicyPayload":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/UpdatePolicyAttributes"},"id":{"description":"the UUID of the policy to update.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"$ref":"#/components/schemas/Meta"},"type":{"enum":["policy"],"type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"},"UpdatePolicyReview":{"description":"Review update.\n\nTo provide an optional message relating to the review state change, add a string 'message' property to the 'meta' object.\n","enum":["pending","approved","rejected"],"type":"string"},"UpdateTenantMembershipRequestData":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"type":"object"},"id":{"$ref":"#/components/schemas/TenantMembershipId"},"relationships":{"$ref":"#/components/schemas/UpdateTenantMembershipRequestRelationships"},"type":{"$ref":"#/components/schemas/TenantMembershipType"}},"required":["id","type","relationships"],"type":"object"},"UpdateTenantMembershipRequestRelationships":{"additionalProperties":false,"properties":{"role":{"$ref":"#/components/schemas/TenantMembershipTenantRoleRelationshipBasic"}},"required":["role"],"type":"object"},"UpdateTenantRoleRequestAttributes":{"additionalProperties":false,"minProperties":1,"properties":{"description":{"description":"The description of the tenant role.","maxLength":160,"minLength":1,"type":"string"},"name":{"description":"The name of the tenant role.","maxLength":60,"minLength":1,"type":"string"},"permissions":{"description":"Requested permissions of the tenant role. Must be the entire set of permissions.","items":{"type":"string"},"type":"array"}},"type":"object"},"Updated":{"description":"The last time the settings were updated.","example":"2021-11-12T10:31:06.026Z","format":"date-time","type":"string"},"UpgradePackageAdvice":{"description":"Upgrade a package from one version to another.","example":{"format":"upgrade_package_advice","package_name":"lodash","upgrade_paths":[{"dependency_path":[{"name":"lodash","version":"2.1.1"},{"name":"minimist","version":"4.7.6"}],"is_drop":false}]},"properties":{"format":{"enum":["upgrade_package_advice"],"type":"string"},"package_name":{"description":"The package that's receiving an upgrade to fix this vulnerability","type":"string"},"upgrade_paths":{"description":"Upgrading a package may lead to one or more paths to change. These paths are modelled as evidence\nin DependencyPathEvidence.\n\nUltimately upgradePaths illustrates the minimum version upgrades that need to happen to apply this action.","items":{"$ref":"#/components/schemas/UpgradePath"},"type":"array"}},"required":["format","package_name","upgrade_paths"],"type":"object"},"UpgradePath":{"description":"Upgrade path model all known dependency paths that will change when applying an upgrade action.","properties":{"dependency_path":{"items":{"$ref":"#/components/schemas/Package"},"maxItems":100,"type":"array"},"is_drop":{"description":"A drop describes an upgrade path, where the vulnerability gets addressed by removing the vulnerable dependency.\nThis typically happens when a package somewhere mid-way drops this library in newer versions.\n\nNote: For drops, the length of the upgradePath will be smaller than the length of the original dependencyPath.","type":"boolean"}},"required":["dependency_path","is_drop"],"type":"object"},"UploadResource":{"description":"Resource referring to an Upload Revision created through the\nFile Upload API (currently in Closed Beta).\n\nRevisions contain collections of files uploaded by clients to\nSnyk for testing.\n\nUploadResources can be marked either as SBOM or Source to\nindicate the contents of the Revision.\n\nSBOM UploadResources should provide the following fields:\n- type\n- revision_id\n- name\n- file_patterns (may be empty)\n\nSource UploadResources should provide the following fields:\n- type\n- revision_id\n- repository_url\n- root_folder_id\n- file_patterns (may be empty)\n\nCurrently supported scans utilizing UploadResources are:\n- SBOM (SCA): (1) UploadResource containing an SBOM\n- SBOM + Reachability Analysis (SCA): (1) UploadResource containing an SBOM, (1) UploadResource containing Source files.\n- Secrets: (1) UploadResource containing Source files","example":{"content_type":"source","file_patterns":[],"repository_url":"https://github.com/example/repo","revision_id":"00000000-0000-0000-0000-000000000000","root_folder_id":".","type":"upload"},"properties":{"content_type":{"description":"Content present in the Upload Revision.\n\nCurrently only SBOMs and Source files are accepted\ncontent types.","enum":["sbom","source"],"type":"string"},"file_patterns":{"description":"File Patterns to include in the scan. Elements must be less than 256 characters.\n\nCurrently unsupported. Provide an empty list.","items":{"$ref":"#/components/schemas/String256"},"maxItems":20,"type":"array"},"name":{"description":"A name to assign to the SBOM contained in the UploadRevision.\n\nOverrides the filename in the UploadRevision.","maxLength":256,"type":"string"},"repository_url":{"description":"Repository URL at which the Source files are stored.","maxLength":1024,"type":"string"},"revision_id":{"description":"The ID returned from the File Upload API for a given Revision.\nThe File Upload API is released in Closed Beta.\nCustomers with access may view the preview documentation for\ninformation on its usage.","example":"5025c59b-c4dd-48e3-b98a-e98d838f4c9b","maxLength":1024,"type":"string"},"root_folder_id":{"description":"Folder inside the UploadRevision at which the Source files are located.","maxLength":1024,"type":"string"},"scm_context":{"$ref":"#/components/schemas/ScmContext"},"type":{"enum":["upload"],"type":"string"}},"required":["type","revision_id","content_type","file_patterns"],"type":"object"},"User":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"active":{"description":"Whether the user status is enabled or not","example":true,"type":"boolean"},"email":{"description":"The email of the user.","example":"user@someorg.com","type":"string"},"membership":{"properties":{"created_at":{"description":"The date the membership was established.","example":"2022-09-14T09:19:29.206Z","format":"date-time","type":"string"},"strategy":{"description":"Whether the membership is a direct, or indirect membership.","enum":["direct","indirect"],"example":"direct","type":"string"}},"type":"object"},"name":{"description":"The name of the user.","example":"user","type":"string"},"username":{"description":"The username of the user.","example":"username","type":"string"}},"type":"object"},"id":{"description":"The Snyk ID corresponding to this user","example":"55a348e2-c3ad-4bbc-b40e-9b232d1f4121","format":"uuid","type":"string"},"type":{"description":"Content type.","example":"user","type":"string"}},"required":["type","id","attributes"],"type":"object"},"User20240422":{"additionalProperties":false,"properties":{"avatar_url":{"description":"The avatar url of the user.","example":"https://snyk.io/avatar.png","format":"uri","type":"string"},"default_org_context":{"description":"ID of the default org for the user.","format":"uuid","type":"string"},"email":{"description":"The email of the user.","example":"user@someorg.com","type":"string"},"name":{"description":"The name of the user.","example":"user","type":"string"},"username":{"description":"The username of the user.","example":"username","type":"string"}},"required":["name","email","avatar_url"],"type":"object"},"UserAccountType":{"description":"The type of the user account.","example":"user","type":"string"},"UserEmail":{"description":"The e-mail address of the user.","example":"user@example.com","type":"string"},"UserId":{"description":"Unique identifier for a user.","example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"UserIsActive":{"description":"Whether the user is active.","example":true,"type":"boolean"},"UserLoginMethod":{"description":"The authentication method used by the user.","example":"saml","type":"string"},"UserName":{"description":"The real name of the user.","example":"Firstname Lastname","type":"string"},"UserPatchRequestBody":{"additionalProperties":false,"properties":{"attributes":{"properties":{"membership":{"nullable":true,"properties":{"role":{"description":"Role name","example":"MEMBER","type":"string"}},"type":"object"}},"required":["membership"],"type":"object"},"id":{"description":"The Snyk ID corresponding to this user","example":"55a348e2-c3ad-4bbc-b40e-9b232d1f4121","format":"uuid","type":"string"},"type":{"description":"Content type","example":"user","type":"string"}},"required":["type","id","attributes"],"type":"object"},"UserRelationship":{"properties":{"data":{"properties":{"attributes":{"properties":{"email":{"type":"string"},"username":{"type":"string"}},"required":["email","username"],"type":"object"},"id":{"type":"string"},"type":{"enum":["user"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["links","data"],"type":"object"},"UserType":{"description":"Resource type for users.","enum":["user"],"type":"string"},"UserUsername":{"description":"The username of the user.","example":"username","type":"string"},"UsersProgress":{"properties":{"attributes":{"$ref":"#/components/schemas/UsersProgressAttributes"},"id":{"format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/ProgressRelationships"},"type":{"enum":["progress"],"type":"string"}},"required":["id","type","attributes","relationships"],"type":"object"},"UsersProgressAttributes":{"properties":{"completion_date":{"format":"date-time","type":"string"},"completion_history":{"items":{"format":"date-time","type":"string"},"type":"array"},"is_expired":{"type":"boolean"},"resource":{"enum":["learning_path","lesson"],"type":"string"},"status":{"enum":["completed","inProgress","todo"],"type":"string"}},"required":["status","resource","completion_history"],"type":"object"},"UsersProgressResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UsersProgress"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["jsonapi","links","data"],"type":"object"},"Uuid":{"format":"uuid","type":"string"},"VersioningSchema":{"allOf":[{"oneOf":[{"$ref":"#/components/schemas/VersioningSchemaSemverType"},{"$ref":"#/components/schemas/VersioningSchemaCustomType"},{"$ref":"#/components/schemas/VersioningSchemaSingleSelectionType"}]}],"description":"The versioning scheme used by images in the repository.\n\nA versioning schema is a system for identifying and organizing different versions of a project. \nIt is used to track changes and updates to the project over time, and to help users identify which version they are using. \nA versioning schema typically consists of a series of numbers or labels that are incremented to reflect the progression of versions. \nFor example, a versioning schema might use a series of numbers, such as \"1.0\", \"1.1\", \"2.0\", and so on, to indicate major and minor releases of a product. \nA consistent and well-defined versioning schema helps users and tools understand and track the development of a project.\n"},"VersioningSchemaCustomType":{"additionalProperties":false,"description":"The Custom Schema type is a way for Snyk to understand your company’s container image tag versioning scheme,\nenabling Snyk to give more accurate base image upgrade recommendations.\n\nThis schema type is essentially a regular expression that groups the different parts of an image’s tag into comparable sections.\n\nIf your container image's tags follow a versioning scheme other than Semantic Versioning (SemVer), \nit is highly recommended that you select the \"Custom Versioning\" schema for your image repositories.\n","properties":{"expression":{"description":"The regular expression used to describe the format of tags.\nKeep in mind that backslashes in the expression need to be escaped due to being encompassed in a JSON string.\n","example":"(?\u003cC0\u003e.)\\-(?\u003cM2\u003e.*)","type":"string"},"label":{"description":"A customizable string that can be set for a custom versioning schema to describe its meaning.\nThis label has no function.\n","example":"calendar with flavor schema","type":"string"},"type":{"enum":["custom"],"type":"string"}},"required":["type","expression"],"type":"object"},"VersioningSchemaSemverType":{"additionalProperties":false,"properties":{"type":{"enum":["semver"],"example":"semver","type":"string"}},"required":["type"],"type":"object"},"VersioningSchemaSingleSelectionType":{"additionalProperties":false,"description":"The Single Selection Versioning Schema allows manual setting of which image should be given as a recommendation.\n\nOnly one image can be set as the current recommendation. If no images are set as the current selection, \nno recommendation will be given.\n\nIt is recommended to use this versioning schema if your repository's tags aren't supported by the other schemas.\n","properties":{"is_selected":{"description":"Whether this image should be the recommendation. Only one image can be selected at a given time. Setting this\nas true will remove previous selection.\n","example":true,"type":"boolean"},"type":{"enum":["single-selection"],"example":"single-selection","type":"string"}},"required":["type","is_selected"],"type":"object"},"WorkloadAttributes":{"properties":{"required":{"properties":{"workload_internal_uri":{"type":"string"},"workload_type_id":{"format":"uuid","type":"string"}},"required":["workload_type_id","workload_internal_uri"],"type":"object"},"type":{"enum":["workload"],"type":"string"},"validations":{"items":{"type":"object"},"type":"array"}},"required":["type","required"],"type":"object"},"YarnBuildArgs":{"additionalProperties":false,"properties":{"root_workspace":{"type":"string"}},"required":["root_workspace"],"type":"object"},"io.snyk.api.common.Error":{"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","format":"uuid","type":"string"},"links":{"$ref":"#/components/schemas/io.snyk.api.common.ErrorLink"},"meta":{"type":"object"},"source":{"properties":{"parameter":{"type":"string"},"pointer":{"type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","type":"string"}},"required":["status","detail"],"type":"object"},"io.snyk.api.common.ErrorDocument":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/io.snyk.api.common.Error"},"minItems":1,"type":"array"},"jsonapi":{"$ref":"#/components/schemas/io.snyk.api.common.JsonApi"}},"required":["jsonapi","errors"],"type":"object"},"io.snyk.api.common.ErrorLink":{"additionalProperties":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"},"description":"A link that leads to further details about this particular occurrance of the problem.","properties":{"about":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"}},"type":"object"},"io.snyk.api.common.JsonApi":{"properties":{"version":{"description":"Version of the JSON API specification this server supports.","enum":["1.0"],"type":"string"}},"required":["version"],"type":"object"},"io.snyk.api.common.LinkObject":{"properties":{"href":{"$ref":"#/components/schemas/io.snyk.api.common.LinkString"},"meta":{"$ref":"#/components/schemas/io.snyk.api.common.Meta"}},"required":["href"],"type":"object"},"io.snyk.api.common.LinkProperty":{"oneOf":[{"$ref":"#/components/schemas/io.snyk.api.common.LinkString"},{"$ref":"#/components/schemas/io.snyk.api.common.LinkObject"}]},"io.snyk.api.common.LinkString":{"format":"uri","type":"string"},"io.snyk.api.common.Meta":{"additionalProperties":{},"description":"Free-form object that may contain non-standard information.","type":"object"},"io.snyk.api.common.PaginatedLinks":{"properties":{"first":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"},"last":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"},"next":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"},"prev":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"},"self":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"}},"type":"object"},"io.snyk.api.common.RelatedLink":{"properties":{"related":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"}},"type":"object"},"io.snyk.api.v1testdepgraph.request.DepGraph":{"additionalProperties":{},"properties":{"graph":{"$ref":"#/components/schemas/io.snyk.api.v1testdepgraph.request.Graph"},"pkgManager":{"$ref":"#/components/schemas/io.snyk.api.v1testdepgraph.request.PackageManager"},"pkgs":{"items":{"$ref":"#/components/schemas/io.snyk.api.v1testdepgraph.request.Package"},"type":"array"},"schemaVersion":{"type":"string"}},"required":["schemaVersion","pkgManager","pkgs","graph"],"type":"object"},"io.snyk.api.v1testdepgraph.request.Graph":{"additionalProperties":{},"properties":{"nodes":{"items":{"$ref":"#/components/schemas/io.snyk.api.v1testdepgraph.request.Node"},"type":"array"},"rootNodeId":{"type":"string"}},"required":["rootNodeId","nodes"],"type":"object"},"io.snyk.api.v1testdepgraph.request.Node":{"additionalProperties":{},"properties":{"deps":{"items":{"$ref":"#/components/schemas/io.snyk.api.v1testdepgraph.request.NodeRef"},"type":"array"},"nodeId":{"type":"string"},"pkgId":{"type":"string"}},"required":["nodeId","pkgId","deps"],"type":"object"},"io.snyk.api.v1testdepgraph.request.NodeRef":{"additionalProperties":{},"properties":{"nodeId":{"type":"string"}},"required":["nodeId"],"type":"object"},"io.snyk.api.v1testdepgraph.request.Package":{"additionalProperties":{},"properties":{"id":{"type":"string"},"info":{"$ref":"#/components/schemas/io.snyk.api.v1testdepgraph.request.PackageInfo"}},"required":["id","info"],"type":"object"},"io.snyk.api.v1testdepgraph.request.PackageInfo":{"additionalProperties":{},"properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"type":"object"},"io.snyk.api.v1testdepgraph.request.PackageManager":{"additionalProperties":{},"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"name":{"description":"User-defined name of the collection","maxLength":255,"minLength":1,"pattern":"^([a-zA-Z0-9 _\\-\\/:.])+$","type":"string"}},"securitySchemes":{"APIToken":{"description":"API key value must be prefixed with \\\"Token \\\".","in":"header","name":"Authorization","type":"apiKey"},"BearerAuth":{"scheme":"bearer","type":"http"}}},"info":{"title":"Snyk API","version":"REST"},"openapi":"3.0.3","paths":{"/custom_base_images":{"get":{"description":"Get a list of custom base images with support for ordering and filtering.\nEither the org_id or group_id parameters must be set to authorize successfully.\nIf sorting by version, the repository filter is required.\n","operationId":"getCustomBaseImages","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"The ID of the container project that the custom base image is based off of.","in":"query","name":"project_id","schema":{"format":"uuid","type":"string"}},{"description":"The organization ID of the custom base image","in":"query","name":"org_id","schema":{"format":"uuid","type":"string"}},{"description":"The group ID of the custom base image","in":"query","name":"group_id","schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Repository"},{"$ref":"#/components/parameters/Tag"},{"$ref":"#/components/parameters/IncludeInRecommendations"},{"description":"Which column to sort by. \nIf sorting by version, the versioning schema is used.\n","in":"query","name":"sort_by","schema":{"enum":["repository","tag","version"],"type":"string"}},{"$ref":"#/components/parameters/SortDirection"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomBaseImageCollectionResponse"}}},"description":"Returns custom base images","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a custom base image collection","tags":["Custom Base Images"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-08-21","2023-09-20","2024-01-04","2024-05-31"],"x-snyk-api-resource":"custombaseimages","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-31","x-stability-level":"stable"},"post":{"description":"In order to create a custom base image, you first need to import your base images into Snyk.\nYou can do this through the CLI, UI, or API.\n\nThis endpoint marks an image as a custom base image. This means that the image will get\nadded to the pool of images from which Snyk can recommend base image upgrades.\n\nNote, after the first image in a repository gets added, a versioning schema cannot be passed in this endpoint.\nTo update the versioning schema, the PATCH endpoint must be used.\n","operationId":"createCustomBaseImage","parameters":[{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomBaseImagePostRequest"}}},"description":"The properties used in the creation of a custom base image"},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomBaseImageResponse"}}},"description":"Successfully created a custom base image","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create a Custom Base Image from an existing container project","tags":["Custom Base Images"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-08-21","2023-09-20","2024-01-04","2024-05-31"],"x-snyk-api-resource":"custombaseimages","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-31","x-stability-level":"stable"}},"/custom_base_images/{custombaseimage_id}":{"delete":{"description":"Delete a custom base image resource. (the related container project is unaffected)","operationId":"deleteCustomBaseImage","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/CustomBaseImageId"}],"responses":{"204":{"description":"Successfully deleted the custom base image","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete a custom base image","tags":["Custom Base Images"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-08-21","2023-09-20","2024-01-04","2024-05-31"],"x-snyk-api-resource":"custombaseimages","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-31","x-stability-level":"stable"},"get":{"description":"Get a custom base image","operationId":"getCustomBaseImage","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/CustomBaseImageId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomBaseImageResponse"}}},"description":"Returns a custom base image","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a custom base image","tags":["Custom Base Images"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-08-21","2023-09-20","2024-01-04","2024-05-31"],"x-snyk-api-resource":"custombaseimages","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-31","x-stability-level":"stable"},"patch":{"description":"Updates a custom base image's attributes","operationId":"updateCustomBaseImage","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/CustomBaseImageId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomBaseImagePatchRequest"}}},"description":"custom base image to be updated"},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomBaseImageResponse"}}},"description":"Returns the updated custom base image","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update a custom base image","tags":["Custom Base Images"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-08-21","2023-09-20","2024-01-04","2024-05-31"],"x-snyk-api-resource":"custombaseimages","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-31","x-stability-level":"stable"}},"/groups":{"get":{"description":"Returns a list of groups which a user is a member of","operationId":"listGroups","parameters":[{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Group"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A list of groups is returned","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get all groups (Early Access)","tags":["Groups"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-01-31~experimental","2023-01-30~beta"],"x-snyk-api-resource":"groups","x-snyk-api-stability":"beta","x-snyk-api-version":"2023-01-30~beta","x-stability-level":"beta"}},"/groups/{group_id}":{"get":{"description":"Get a group\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"getGroup","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Unique identifier of the group.","in":"path","name":"group_id","required":true,"schema":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GroupResponse"}}},"description":"Returns an instance of a Group","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get Group (Early Access)","tags":["Group"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-01-31~experimental","2023-01-30~beta","2024-04-25~experimental"],"x-snyk-api-resource":"groups","x-snyk-api-stability":"beta","x-snyk-api-version":"2023-01-30~beta","x-stability-level":"beta"}},"/groups/{group_id}/apps/installs":{"get":{"description":"Get a list of Snyk Apps installed for a Group\n\n#### Required permissions\n\n- `View Apps (group.app.read)`","operationId":"getAppInstallsForGroup","parameters":[{"description":"Expand relationships.","explode":false,"in":"query","name":"expand","schema":{"items":{"enum":["app"],"type":"string"},"type":"array"},"style":"form"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/AppInstallData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"A list of apps installed for the specified group.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Get a list of Snyk Apps installed for a Group","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03","2024-05-23"],"x-snyk-api-resource":"app_installs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-23","x-stability-level":"stable"},"post":{"description":"Install a Snyk App to this group, the Snyk App must use unattended authentication e.g. client credentials\n\n#### Required permissions\n\n- `Install Apps (group.app.install)`","operationId":"createGroupAppInstall","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"properties":{"type":{"enum":["app_install"],"example":"app_install","type":"string"}},"type":"object"},"relationships":{"additionalProperties":false,"properties":{"app":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/Uuid"},"type":{"enum":["app"],"example":"app","type":"string"}},"required":["id","type"],"type":"object"}},"required":["data"],"type":"object"}},"required":["app"],"type":"object"}},"required":["data","relationships"],"type":"object"}}},"description":"App Install to be created"},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppInstallWithClient"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"The newly created app install.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Install a Snyk App for a Group","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03","2024-05-23"],"x-snyk-api-resource":"app_installs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-23","x-stability-level":"stable"}},"/groups/{group_id}/apps/installs/{install_id}":{"delete":{"description":"Revoke app authorization for a Snyk group with install ID\n\n#### Required permissions\n\n- `Install Apps (group.app.install)`","operationId":"deleteGroupAppInstallById","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/InstallId"}],"responses":{"204":{"description":"The Snyk App install is revoked, with no content (no errors).","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Revoke app authorization for a Snyk group with install ID","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03","2024-05-23"],"x-snyk-api-resource":"app_installs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-23","x-stability-level":"stable"}},"/groups/{group_id}/apps/installs/{install_id}/secrets":{"post":{"description":"Manage client secret for non-interactive Snyk App installations\n\n#### Required permissions\n\n- `Edit Apps (group.app.edit)`","operationId":"updateGroupAppInstallSecret","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/InstallId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"mode":{"description":"Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n","enum":["replace","create","delete"],"type":"string"},"secret":{"description":"Secret to delete when using `delete` mode","type":"string"}},"required":["mode"],"type":"object"},"type":{"enum":["app"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppInstallDataWithSecret"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Secret has been updated.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Manage client secret for non-interactive Snyk App installations","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03","2024-05-23"],"x-snyk-api-resource":"app_installs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-23","x-stability-level":"stable"}},"/groups/{group_id}/assets/search":{"post":{"description":"List Assets with filters\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"listAssets","parameters":[{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"summary":"One filter, one attribute","value":{"query":{"attributes":{"attribute":"type","operator":"equal","values":["repository"]}}}},"example2":{"summary":"Two filters","value":{"query":{"attributes":{"operator":"and","values":[{"attribute":"type","operator":"equal","values":["repository"]},{"attribute":"sources","operator":"equal","values":["snyk","github"]}]}}}},"example3":{"summary":"Nested filters - X and (Y or Z)","value":{"query":{"attributes":{"operator":"and","values":[{"attribute":"type","operator":"equal","values":["repository"]},{"operator":"or","values":[{"attribute":"class","operator":"in","values":["A","B"]},{"attribute":"risk_factors","operator":"in","values":["Deployed"]}]}]}}}}},"schema":{"anyOf":[{"description":"Empty body","type":"object"},{"$ref":"#/components/schemas/SearchObject"}]}}},"description":"Filter criteria for listing assets. Can be empty or contain query filters.","required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/AssetResponseData"},"type":"array"},"jsonapi":{"additionalProperties":false,"properties":{"version":{"type":"string"}},"type":"object"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"Assets found","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"List Assets with filters (Early Access)","tags":["Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta","2025-09-28~beta"],"x-snyk-api-resource":"assets","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-snyk-deprecated-by":"2025-09-28~beta","x-snyk-sunset-eligible":"2025-12-28","x-stability-level":"beta"}},"/groups/{group_id}/assets/{asset_id}":{"get":{"description":"Get an Asset by its ID\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"getAsset","parameters":[{"$ref":"#/components/parameters/AssetId"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AssetResponseData"},"jsonapi":{"additionalProperties":false,"properties":{"version":{"type":"string"}},"type":"object"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Asset found","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get an Asset by its ID (Early Access)","tags":["Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta","2025-09-28~beta"],"x-snyk-api-resource":"assets","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-snyk-deprecated-by":"2025-09-28~beta","x-snyk-sunset-eligible":"2025-12-28","x-stability-level":"beta"}},"/groups/{group_id}/assets/{asset_id}/relationships/assets":{"get":{"description":"List related assets with pagination\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"listRelatedAssets","parameters":[{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/AssetId"},{"$ref":"#/components/parameters/StartingAfterCursor"},{"$ref":"#/components/parameters/EndingBeforeCursor"},{"description":"Number of records to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"number"}},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/AssetTypeFilter"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/AssetResponseData"},"type":"array"},"jsonapi":{"additionalProperties":false,"properties":{"version":{"type":"string"}},"type":"object"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"Related assets found","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"List related assets with pagination (Early Access)","tags":["Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta","2025-09-28~beta"],"x-snyk-api-resource":"assets","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-snyk-deprecated-by":"2025-09-28~beta","x-snyk-sunset-eligible":"2025-12-28","x-stability-level":"beta"}},"/groups/{group_id}/assets/{asset_id}/relationships/projects":{"get":{"description":"List asset projects with pagination\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"listAssetProjects","parameters":[{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/AssetId"},{"$ref":"#/components/parameters/StartingAfterCursor"},{"$ref":"#/components/parameters/EndingBeforeCursor"},{"description":"Number of records to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"number"}},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/AssetProjectResponseData"},"type":"array"},"jsonapi":{"additionalProperties":false,"properties":{"version":{"type":"string"}},"type":"object"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"Assets found","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"List asset projects with pagination (Early Access)","tags":["Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta","2025-09-28~beta"],"x-snyk-api-resource":"assets","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-snyk-deprecated-by":"2025-09-28~beta","x-snyk-sunset-eligible":"2025-12-28","x-stability-level":"beta"}},"/groups/{group_id}/audit_logs/search":{"get":{"description":"Search audit logs for a Group. \"api.access\" events are omitted from results unless explicitly requested using the events parameter. Some Organization level events are supported as well as the following\nGroup level events:\n - api.access\n - group.cloud_config.settings.edit\n - group.create\n - group.delete\n - group.edit\n - group.notification_settings.edit\n - group.org.add\n - group.org.remove\n - group.policy.create\n - group.policy.delete\n - group.policy.edit\n - group.request_access_settings.edit\n - group.role.create\n - group.role.delete\n - group.role.edit\n - group.service_account.create\n - group.service_account.delete\n - group.service_account.edit\n - group.settings.edit\n - group.settings.feature_flag.edit\n - group.sso.add\n - group.sso.auth0_connection.create\n - group.sso.auth0_connection.edit\n - group.sso.create\n - group.sso.delete\n - group.sso.edit\n - group.sso.membership.sync\n - group.sso.remove\n - group.tag.create\n - group.tag.delete\n - group.user.add\n - group.user.remove\n - group.user.role.edit\n\n#### Required permissions\n\n- `View Audit Logs (group.audit.read)`","operationId":"listGroupAuditLogs","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/Cursor"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/To"},{"$ref":"#/components/parameters/Size"},{"$ref":"#/components/parameters/SortOrder"},{"$ref":"#/components/parameters/UserId"},{"$ref":"#/components/parameters/ProjectId"},{"$ref":"#/components/parameters/Events"},{"$ref":"#/components/parameters/ExcludeEvents"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AuditLogSearch"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"Group Audit Logs.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Search Group audit logs.","tags":["Audit Logs"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-09-11","2024-04-29"],"x-snyk-api-resource":"audit-logs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-04-29","x-stability-level":"stable"}},"/groups/{group_id}/export":{"post":{"description":"Create and start an export for a group\n\n#### Required permissions\n\n- `View reports (group.report.read)`","operationId":"createGroupExport","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/groupId"},{"$ref":"#/components/parameters/include_deleted"},{"$ref":"#/components/parameters/include_deactivated"}],"requestBody":{"$ref":"#/components/requestBodies/CreateGroupExport"},"responses":{"202":{"$ref":"#/components/responses/CreateExport"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/500"}},"security":[{"TokenAuth":[]}],"summary":"Start an export","tags":["Export"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15"],"x-snyk-api-resource":"export","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-stability-level":"stable"}},"/groups/{group_id}/export/{export_id}":{"get":{"description":"Get an export results\n\n#### Required permissions\n\n- `View reports (group.report.read)`","operationId":"getGroupExport","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/groupId"},{"$ref":"#/components/parameters/exportId"}],"responses":{"200":{"$ref":"#/components/responses/GetExport"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"security":[{"TokenAuth":[]}],"summary":"Get export results","tags":["Export"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15"],"x-snyk-api-resource":"export","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-stability-level":"stable"}},"/groups/{group_id}/inventory/assets":{"get":{"description":"Retrieves a polymorphic list of all asset types for a given group.\nThe tenant is resolved from the group_id.\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"listAssetsGroup","parameters":[{"description":"The unique identifier of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"$ref":"#/components/parameters/RsqlFilter"},{"description":"Comma-separated sort fields. Prefix with `-` for descending order.","example":"-created_at","in":"query","name":"sort","schema":{"type":"string"}},{"description":"Number of results to return per page","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}},{"$ref":"#/components/parameters/SparseFieldsets"},{"$ref":"#/components/parameters/MetaCount"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AssetListResponse"}}},"description":"Successful response with a polymorphic list of assets","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"summary":"List or search all assets (synchronous) - Group scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"},"patch":{"description":"Partially updates multiple assets within a group context.\nMaximum of 100 assets can be updated per request.\nThe operation is transactional - all updates succeed or all fail.\n\n#### Required permissions\n\n- `Edit Group Details (group.edit)`","operationId":"updateAssetsBulkGroup","parameters":[{"description":"The unique identifier of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AssetBulkPatchRequestBody"}}},"required":true},"responses":{"204":{"description":"Assets updated successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Bulk update asset attributes - Group scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/groups/{group_id}/inventory/assets/filters":{"get":{"description":"Returns a list of valid field names that can be used for filtering assets using RSQL.\nEach field includes its name, data type, and which asset types it applies to.\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"getFilterFieldsGroup","parameters":[{"description":"The unique identifier of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Comma-separated list of asset types to filter the available filter fields","example":"container_images","in":"query","name":"asset_types","schema":{"type":"string"}},{"description":"Number of results to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/FilterFieldsResponse"}}},"description":"List of available filter fields","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get available filter fields - Group scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/groups/{group_id}/inventory/assets/filters/{filter_id}/values":{"get":{"description":"Returns a list of distinct values for a specific filter field.\nUseful for building autocomplete functionality in filter UIs.\n\nUse the UUID from the filter fields list endpoint to identify which field to query.\n\nFor object filter values, both the keys and values are returned.\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"getFilterValuesGroup","parameters":[{"description":"The unique identifier of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"The UUID of the filter field to get values for (from the filter fields list endpoint)","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","in":"path","name":"filter_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Full text search term to filter the list of values. If keys_only is true, this will filter the keys of the object filter values. If key is provided, this will filter the value for the specific key of the object filter values.","example":"prod","in":"query","name":"q","schema":{"maxLength":100,"type":"string"}},{"description":"Number of results to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}},{"description":"Return only the keys of the object filter values","in":"query","name":"keys_only","schema":{"type":"boolean"}},{"description":"Return only the value for a specific key of the object filter values","in":"query","name":"key","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/FilterValuesResponse"}}},"description":"List of filter values","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get filter value suggestions (autocomplete) - Group scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/groups/{group_id}/inventory/assets/groups":{"get":{"description":"Returns a list of valid group field names that can be used for grouping assets within a group context.\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"getGroupFieldsGroup","parameters":[{"description":"The unique identifier of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Comma-separated list of asset types to filter group fields","in":"query","name":"asset_types","schema":{"type":"string"}},{"description":"Maximum number of results to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for forward pagination","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for backward pagination","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GroupFieldsResponse"}}},"description":"List of available group fields","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get available group fields - Group scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/groups/{group_id}/inventory/assets/groups/{group_field_id}/values":{"get":{"description":"Returns aggregated values for a specific group field id, showing the count of assets\nfor each distinct value.\n\nUse the UUID from the group fields list endpoint to identify which field to query.\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"getGroupValuesGroup","parameters":[{"description":"The unique identifier of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"The UUID of the group field to get values for (from the group fields list endpoint)","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","in":"path","name":"group_field_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Comma-separated list of asset types to filter the aggregation","example":"container_images","in":"query","name":"asset_types","schema":{"type":"string"}},{"$ref":"#/components/parameters/RsqlFilterGroupValues"},{"$ref":"#/components/parameters/SortGroupValues"},{"description":"Maximum number of group values to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for forward pagination","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for backward pagination","in":"query","name":"ending_before","schema":{"type":"string"}},{"$ref":"#/components/parameters/MetaFieldsGroupValues"},{"$ref":"#/components/parameters/AggregateGroupValues"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GroupValuesResponse"}}},"description":"List of group values with aggregated metadata","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get group value aggregation - Group scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/groups/{group_id}/inventory/assets/searches":{"post":{"description":"Initiates an asynchronous search for assets within a group context.\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"createAssetSearchGroup","parameters":[{"description":"The unique identifier of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateSearchRequestBody"}}}},"responses":{"302":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"jsonapi":{"additionalProperties":false,"properties":{"version":{"type":"string"}},"type":"object"}},"type":"object"}}},"description":"Found - Redirects to search results endpoint","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"description":"URL to retrieve search results","schema":{"format":"uri","type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create an asset search (asynchronous) - Group scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/groups/{group_id}/inventory/assets/searches/{search_id}/results":{"get":{"description":"Gets paginated results for a previously initiated asset search within a group context.\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"getAssetSearchResultsGroup","parameters":[{"description":"The unique identifier of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/SearchId"},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Sort order for results (e.g., -created_at for descending)","in":"query","name":"sort","schema":{"type":"string"}},{"description":"Maximum number of results to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for forward pagination","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for backward pagination","in":"query","name":"ending_before","schema":{"type":"string"}},{"$ref":"#/components/parameters/SparseFieldsets"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AssetListResponse"}}},"description":"Search results retrieved successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Retrieve asset search results (asynchronous) - Group scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/groups/{group_id}/inventory/assets/{asset_id}":{"get":{"description":"Retrieves a single asset by its unique identifier within a group context.\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"getAssetGroup","parameters":[{"description":"The unique identifier of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the asset","in":"path","name":"asset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"$ref":"#/components/parameters/SparseFieldsets"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/PolymorphicAssetData"},"links":{"properties":{"self":{"format":"uri","type":"string"}},"type":"object"}},"required":["data"],"type":"object"}}},"description":"Asset retrieved successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a single asset by ID - Group scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"},"patch":{"description":"Partially updates an asset's attributes within a group context.\nSupports updating class, labels (add/remove), and tags (add/remove).\n\n#### Required permissions\n\n- `Edit Group Details (group.edit)`","operationId":"updateAssetGroup","parameters":[{"description":"The unique identifier of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the asset","in":"path","name":"asset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AssetPatchRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/PolymorphicAssetData"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"},"links":{"description":"Self-referencing link","properties":{"self":{"description":"Link to the current resource","format":"uri","type":"string"}},"required":["self"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Asset updated successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update asset attributes - Group scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/groups/{group_id}/inventory/assets/{asset_id}/relationships/projects":{"get":{"description":"Retrieves a paginated list of Snyk projects linked to this asset with full attributes.\nReturns the `id`, `type`, and `attributes` of each related project.\nScoped to the specified group.\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"listAssetProjectsGroup","parameters":[{"description":"The unique identifier of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the asset","in":"path","name":"asset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}},{"description":"Maximum number of results to return per page","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Filter projects by canonical status.\n- `with`: Returns all projects (canonical attribute is populated).\n- `only`: Returns only canonical projects (those used for vulnerability counts).\n- `none`: Returns only non-canonical projects.\nWhen omitted, returns all projects without canonical filtering.\n","in":"query","name":"canonical","schema":{"enum":["with","only","none"],"type":"string"}},{"description":"Filter projects by target ID. When provided, returns only projects that belong to\nthe specified target. When omitted, returns projects from all targets.\n","in":"query","name":"target_id","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ProjectRelationshipListResponse"}}},"description":"Successfully retrieved linked projects","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"List projects for an asset (group scope) (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"project","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/groups/{group_id}/inventory/assets/{asset_id}/relationships/targets":{"get":{"description":"Retrieves a paginated list of Snyk targets linked to this asset with full attributes.\nReturns the `id`, `type`, and `attributes` of each related target.\nScoped to the specified group.\n\n#### Required permissions\n\n- `View Groups (group.read)`","operationId":"listAssetTargetsGroup","parameters":[{"description":"The unique identifier of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the asset","in":"path","name":"asset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}},{"description":"Maximum number of results to return per page","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/TargetRelationshipListResponse"}}},"description":"Successfully retrieved linked targets","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"List targets for an asset (group scope) (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"target","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/groups/{group_id}/issues":{"get":{"description":"Get a list of a group's issues.\n\n#### Required permissions\n\n- `View Issues (group.issues.read)`","operationId":"listGroupIssues","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"example":"4a18d42f-0706-4ad0-b127-24078731fbed","format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ScanItemId"},{"$ref":"#/components/parameters/ScanItemType"},{"$ref":"#/components/parameters/Type"},{"description":"A filter to select issues updated before this date.","in":"query","name":"updated_before","schema":{"format":"date-time","type":"string"}},{"description":"A filter to select issues updated after this date.","in":"query","name":"updated_after","schema":{"format":"date-time","type":"string"}},{"description":"A filter to select issues created before this date.","in":"query","name":"created_before","schema":{"format":"date-time","type":"string"}},{"description":"A filter to select issues created after this date.","in":"query","name":"created_after","schema":{"format":"date-time","type":"string"}},{"$ref":"#/components/parameters/EffectiveSeverityLevel"},{"$ref":"#/components/parameters/Status"},{"$ref":"#/components/parameters/Ignored"}],"responses":{"200":{"$ref":"#/components/responses/ListIssues200"},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"403":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Get issues by group ID","tags":["Issues"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-03-10~experimental","2023-09-29~beta","2024-01-23"],"x-snyk-api-resource":"issues","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-01-23","x-stability-level":"stable"}},"/groups/{group_id}/issues/{issue_id}":{"get":{"description":"Get an issue\n\n#### Required permissions\n\n- `View Issues (group.issues.read)`","operationId":"getGroupIssueByIssueID","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"example":"4a18d42f-0706-4ad0-b127-24078731fbed","format":"uuid","type":"string"}},{"$ref":"#/components/parameters/PathIssueId20240123"}],"responses":{"200":{"$ref":"#/components/responses/GetIssue20020240123"},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"403":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Get an issue","tags":["Issues"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-01-23"],"x-snyk-api-resource":"issues","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-01-23","x-stability-level":"stable"}},"/groups/{group_id}/jobs/export/{export_id}":{"get":{"description":"Get an export job status\n\n#### Required permissions\n\n- `View reports (group.report.read)`","operationId":"getGroupExportJobStatus","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/groupId"},{"$ref":"#/components/parameters/exportId"}],"responses":{"200":{"$ref":"#/components/responses/GetExportJob"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"security":[{"TokenAuth":[]}],"summary":"Get export status","tags":["Export"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15"],"x-snyk-api-resource":"export","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-stability-level":"stable"}},"/groups/{group_id}/memberships":{"get":{"description":"Returns all memberships of the group\n\n#### Required permissions\n\n- `View Group Memberships (group.membership.read)`","operationId":"listGroupMemberships","parameters":[{"description":"The ID of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/SortBy__0"},{"$ref":"#/components/parameters/SortOrder__0"},{"$ref":"#/components/parameters/EmailFilter"},{"$ref":"#/components/parameters/UserIdFilter"},{"$ref":"#/components/parameters/UsernameFilter"},{"$ref":"#/components/parameters/RoleFilter"},{"$ref":"#/components/parameters/IncludeGroupMembershipCount"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/GroupMembershipResponseData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"List of group memberships is returned","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get all memberships of the group","tags":["Groups"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-05-09~experimental","2024-08-25"],"x-snyk-api-resource":"groups","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-08-25","x-stability-level":"stable"},"post":{"description":"Create a group membership for a user with role\n\n#### Required permissions\n\n- `Add Group Memberships (group.membership.add)`","operationId":"createGroupMembership","parameters":[{"description":"The ID of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateGroupMembershipRequestBody"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/GroupMembership"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"Membership for the group was created","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create a group membership for a user with role","tags":["Groups"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-05-09~experimental","2024-08-25"],"x-snyk-api-resource":"groups","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-08-25","x-stability-level":"stable"}},"/groups/{group_id}/memberships/{membership_id}":{"delete":{"description":"Deletes a membership from a group\n\n#### Required permissions\n\n- `Delete Group Memberships (group.membership.delete)`","operationId":"deleteGroupMembership","parameters":[{"description":"The ID of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The ID of the Group Membership","in":"path","name":"membership_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Cascade"},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"description":"group membership is deleted from Group","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete a membership from a group","tags":["Groups"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-05-09~experimental","2024-08-25"],"x-snyk-api-resource":"groups","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-08-25","x-stability-level":"stable"},"patch":{"description":"Update a role from a group membership\n\n#### Required permissions\n\n- `Edit Group Memberships (group.membership.edit)`","operationId":"updateGroupUserMembership","parameters":[{"description":"The ID of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The ID of the Group Membership","in":"path","name":"membership_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/MembershipPatchRequestBody"}},"type":"object"}}}},"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update a role from a group membership","tags":["Groups"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-05-09~experimental","2024-08-25"],"x-snyk-api-resource":"groups","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-08-25","x-stability-level":"stable"}},"/groups/{group_id}/org_memberships":{"get":{"description":"Get list of org memberships of a group user\n\n#### Required permissions\n\n- `View Group Memberships (group.membership.read)`\n\n- `View Organizations (group.org.list)`","operationId":"listGroupUserOrgMemberships","parameters":[{"description":"The ID of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The ID of the User","in":"query","name":"user_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/OrgName"},{"$ref":"#/components/parameters/RoleFilter"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/GroupMembershipOrgMembership"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"properties":{"org_membership_count":{"description":"Org memberships for this user within this group.","type":"number"}},"type":"object"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A list of org memberships is returned","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get list of org memberships of a group user","tags":["Groups"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-08-25"],"x-snyk-api-resource":"groups","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-08-25","x-stability-level":"stable"}},"/groups/{group_id}/orgs":{"get":{"description":"Get a paginated list of all the organizations belonging to the group.\nBy default, this endpoint returns the organizations in alphabetical order of their name.\n\n#### Required permissions\n\n- `View Groups (group.read)`\n\n- `View Organizations (group.org.list)`","operationId":"listOrgsInGroup","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/PathGroupId"},{"$ref":"#/components/parameters/QueryNameFilter"},{"$ref":"#/components/parameters/QuerySlugFilter"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Org"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A list of organizations in the group.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"List all organizations in group","tags":["Orgs"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-10-24~experimental","2023-12-14~beta","2024-02-28"],"x-snyk-api-resource":"orgs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-02-28","x-stability-level":"stable"}},"/groups/{group_id}/policies":{"get":{"description":"Get all policies for the requested group\n\n*Group level Policy APIs Access Notice:* Access to our Group level Policy APIs is currently\nrestricted via \"use-group-policy-apis\" feature flag and will result in a 403 Forbidden error\nwithout the flag enabled. Please contact your account representative for eligibility requirements.\n\n#### Required permissions\n\n- `View Policies (group.policy.read)`","operationId":"listGroupPolicies","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/GroupPolicyResponse"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["jsonapi","data"],"type":"object"}}},"description":"The group policies for the requested group","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"summary":"Get group level policies (Early Access)","tags":["Policies"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"grouppolicies","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"},"post":{"description":"Create one new group level policy.\n\n*Group level Policy APIs Access Notice:* Access to our Group level Policy APIs is currently\nrestricted via \"use-group-policy-apis\" feature flag and will result in a 403 Forbidden error\nwithout the flag enabled. Please contact your account representative for eligibility requirements.\n\n#### Required permissions\n\n- `Create Policies (group.policy.create)`","operationId":"createGroupPolicy","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateGroupPolicyPayload"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/GroupPolicyResponse"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A single policy is returned if it is successfully created.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create a new group level policy (Early Access)","tags":["Policies"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"grouppolicies","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/groups/{group_id}/policies/{policy_id}":{"delete":{"description":"Delete an existing group-level policy.\n\n*Group level Policy APIs Access Notice:* Access to our Group level Policy APIs is currently\nrestricted via \"use-group-policy-apis\" feature flag and will result in a 403 Forbidden error\nwithout the flag enabled. Please contact your account representative for eligibility requirements.\n\n#### Required permissions\n\n- `Delete Policies (group.policy.delete)`","operationId":"deleteGroupPolicy","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/PolicyId"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete an group-level policy (Early Access)","tags":["Policies"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"grouppolicies","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"},"patch":{"description":"Update the group-level policy.\n\n*Group level Policy APIs Access Notice:* Access to our Group level Policy APIs is currently\nrestricted via \"use-group-policy-apis\" feature flag and will result in a 403 Forbidden error\nwithout the flag enabled. Please contact your account representative for eligibility requirements.\n\n#### Required permissions\n\n- `Edit Policies (group.policy.edit)`","operationId":"updateGroupPolicy","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Group ID","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/PolicyId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdateGroupPolicyPayload"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/GroupPolicyResponse"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A single group policy is returned if it is successfully updated.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"}},"summary":"Update a group-level policy (Early Access)","tags":["Policies"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"grouppolicies","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/groups/{group_id}/service_accounts":{"get":{"description":"Get all service accounts for a group.\n\n#### Required permissions\n\n- `View service accounts (group.service_account.read)`","operationId":"getManyGroupServiceAccount","parameters":[{"description":"The ID of the Snyk Group that owns the service accounts.","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/ServiceAccount"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"properties":{"access_tokens":{"properties":{"max_active_tokens":{"type":"integer"},"max_expiry_days":{"type":"integer"}},"required":["max_active_tokens","max_expiry_days"],"type":"object"}},"type":"object"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A list of service accounts is returned.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a list of group service accounts.","tags":["ServiceAccounts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-09-07"],"x-snyk-api-resource":"service_accounts","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-07","x-stability-level":"stable"},"post":{"description":"Create a service account for a group. The service account can be used to access the Snyk API.\n\n#### Required permissions\n\n- `Create service accounts (group.service_account.create)`","operationId":"createGroupServiceAccount","parameters":[{"description":"The ID of the Snyk Group that is creating and owns the service account","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"access_token_expires_at":{"description":"The expiry date of the access token. Required only when auth_type is access_token.","example":"2025-08-16T00:00:00Z","format":"date-time","type":"string"},"access_token_ttl_seconds":{"description":"The time, in seconds, that a generated oauth access token will be valid for. Defaults to 1 hour if unset. Only used when auth_type is one of the oauth_* variants.","maximum":86400,"minimum":3600,"type":"number"},"auth_type":{"description":"The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an oauth access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out in OIDC Connect Core 1.0, section 9.\n * access_token - Access tokens are long-lived, can be used more than once for increased flexibility, and have expiries for enhanced security.","enum":["api_key","oauth_client_secret","oauth_private_key_jwt","access_token"],"type":"string"},"jwks_url":{"description":"A JWKs URL hosting your public keys, used to verify signed JWT requests. Must be https. Required only when auth_type is oauth_private_key_jwt.","type":"string"},"name":{"description":"A human-friendly name for the service account.","type":"string"},"role_id":{"description":"The ID of the role which the created service account should use. Obtained in the Snyk UI, via \"Group Page\" -\u003e \"Settings\" -\u003e \"Member Roles\" -\u003e \"Create new Role\". Can be shared among multiple accounts.","format":"uuid","type":"string"}},"required":["name","role_id","auth_type"],"type":"object"},"type":{"description":"The Resource type.","enum":["service_account"],"type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/ServiceAccount"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A new service account has been created","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create a service account for a group.","tags":["ServiceAccounts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-09-07"],"x-snyk-api-resource":"service_accounts","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-07","x-stability-level":"stable"}},"/groups/{group_id}/service_accounts/{serviceaccount_id}":{"delete":{"description":"Permanently delete a group-level service account by its ID.\n\n#### Required permissions\n\n- `Delete service accounts (group.service_account.delete)`","operationId":"deleteOneGroupServiceAccount","parameters":[{"description":"The ID of the Snyk Group that owns the service account.","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The ID of the service account.","in":"path","name":"serviceaccount_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"description":"Service account was successfully deleted.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete a group service account.","tags":["ServiceAccounts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-09-07"],"x-snyk-api-resource":"service_accounts","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-07","x-stability-level":"stable"},"get":{"description":"Get a group-level service account by its ID.\n\n#### Required permissions\n\n- `View service accounts (group.service_account.read)`","operationId":"getOneGroupServiceAccount","parameters":[{"description":"The ID of the Snyk Group that owns the service account.","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The ID of the service account.","in":"path","name":"serviceaccount_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/ServiceAccount"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"Service account is returned.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a group service account.","tags":["ServiceAccounts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-09-07"],"x-snyk-api-resource":"service_accounts","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-07","x-stability-level":"stable"},"patch":{"description":"Update the name of a group's service account by its ID.\n\n#### Required permissions\n\n- `Edit service accounts (group.service_account.edit)`","operationId":"updateGroupServiceAccount","parameters":[{"description":"The ID of the Snyk Group that owns the service account.","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The ID of the service account.","in":"path","name":"serviceaccount_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"name":{"description":"A human-friendly name for the service account. Must be unique within the group.","type":"string"}},"required":["name"],"type":"object"},"id":{"description":"The ID of the service account. Must match the id in the url path.","format":"uuid","type":"string"},"type":{"description":"The Resource type.","enum":["service_account"],"type":"string"}},"required":["type","id","attributes"],"type":"object"}},"required":["data"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/ServiceAccount"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"Service account is returned.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update a group service account.","tags":["ServiceAccounts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-09-07"],"x-snyk-api-resource":"service_accounts","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-07","x-stability-level":"stable"}},"/groups/{group_id}/service_accounts/{serviceaccount_id}/secrets":{"post":{"description":"Manage the client secret of a group service account by the service account ID.\n\n#### Required permissions\n\n- `Edit service accounts (group.service_account.edit)`","operationId":"updateServiceAccountSecret","parameters":[{"description":"The ID of the Snyk Group that owns the service account.","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The ID of the service account.","in":"path","name":"serviceaccount_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"mode":{"description":"Operation to perform:\n * `replace` - Replace existing secrets with a new generated secret.\n * `create` - Add a new secret, preserving existing secrets. A maximum of to two secrets can exist at a time.\n * `delete` - Remove an existing secret by value. At least one secret must remain per service account.\n","enum":["replace","create","delete"],"type":"string"},"secret":{"description":"Secret to delete when using `delete` mode","type":"string"}},"required":["mode"],"type":"object"},"type":{"description":"The Resource type.","enum":["service_account"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/ServiceAccount"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"Service account client secret has been updated.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Manage a group service account's client secret.","tags":["ServiceAccounts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-09-07"],"x-snyk-api-resource":"service_accounts","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-07","x-stability-level":"stable"}},"/groups/{group_id}/settings/iac":{"get":{"description":"Get the Infrastructure as Code Settings for a group.\n\n#### Required permissions\n\n- `View IaC settings (group.iac.settings.read)`","operationId":"getIacSettingsForGroup","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the group whose Infrastructure as Code settings are requested","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/GroupIacSettingsResponse"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"The Infrastructure as Code Settings of the group.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get the Infrastructure as Code Settings for a group","tags":["IacSettings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2021-12-09"],"x-snyk-api-resource":"iac_settings","x-snyk-api-stability":"ga","x-snyk-api-version":"2021-12-09","x-stability-level":"stable"},"patch":{"description":"Update the Infrastructure as Code Settings for a group.\n\n#### Required permissions\n\n- `Edit IaC settings (group.iac.settings.edit)`","operationId":"updateIacSettingsForGroup","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the group whose Infrastructure as Code settings are getting updated","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/GroupIacSettingsRequest"}},"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/GroupIacSettingsResponse"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"The Infrastructure as Code Settings of the group were updated.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update the Infrastructure as Code Settings for a group","tags":["IacSettings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2021-12-09"],"x-snyk-api-resource":"iac_settings","x-snyk-api-stability":"ga","x-snyk-api-version":"2021-12-09","x-stability-level":"stable"}},"/groups/{group_id}/settings/pull_request_template":{"delete":{"description":"Delete your groups pull request template. This means Snyk pull requests will start to use the default template for this group.\n\n#### Required permissions\n\n- `Edit Group settings (group.settings.edit)`","operationId":"deletePullRequestTemplate","parameters":[{"description":"Snyk Group ID","example":"7626925e-4b0f-11ee-be56-0242ac120002","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete pull request template for group","tags":["Pull Request Templates"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-10-13~beta","2024-05-08"],"x-snyk-api-resource":"pullRequestTemplates","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-08","x-stability-level":"stable"},"get":{"description":"Get your groups pull request template\n\n#### Required permissions\n\n- `View Group settings (group.settings.read)`","operationId":"getPullRequestTemplate","parameters":[{"description":"Snyk Group ID","example":"7626925e-4b0f-11ee-be56-0242ac120002","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"description":"Fetch a pull request template response","properties":{"attributes":{"$ref":"#/components/schemas/PullRequestTemplateAttributes"},"id":{"$ref":"#/components/schemas/PullRequsetTemplateId"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type","attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Fetch Pull Request Template for group.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get pull request template for group","tags":["Pull Request Templates"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-10-13~beta","2024-05-08"],"x-snyk-api-resource":"pullRequestTemplates","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-08","x-stability-level":"stable"},"post":{"description":"Configures a group level pull request template that will be used on any org or project within that group\n\n#### Required permissions\n\n- `Edit Group settings (group.settings.edit)`","operationId":"createOrUpdatePullRequestTemplate","parameters":[{"description":"Snyk Group ID","example":"7626925e-4b0f-11ee-be56-0242ac120002","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/PullRequestTemplateAttributes"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"description":"Create or update Pull Request Template response","properties":{"attributes":{"$ref":"#/components/schemas/PullRequestTemplateAttributes"},"id":{"$ref":"#/components/schemas/PullRequsetTemplateId"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type","attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Pull Request Template created for group.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create or update pull request template for group","tags":["Pull Request Templates"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-10-13~beta","2024-05-08"],"x-snyk-api-resource":"pullRequestTemplates","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-08","x-stability-level":"stable"}},"/groups/{group_id}/sso_connections":{"get":{"description":"Returns a list of SSO connections for a group\n\n#### Required permissions\n\n- `View SSO settings (group.sso.read)`","operationId":"listGroupSsoConnections","parameters":[{"description":"The ID of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SSOConnection"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"List of SSO connections is returned","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get all SSO connections for a group (Early Access)","tags":["Groups"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-01-31~experimental","2023-01-30~beta"],"x-snyk-api-resource":"groups","x-snyk-api-stability":"beta","x-snyk-api-version":"2023-01-30~beta","x-stability-level":"beta"}},"/groups/{group_id}/sso_connections/{sso_id}/users":{"get":{"description":"Returns a list of users for a SSO connection\n\n#### Required permissions\n\n- `View SSO settings (group.sso.read)`\n\n- `View users (group.user.read)`","operationId":"listGroupSsoConnectionUsers","parameters":[{"description":"The ID of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/SsoId"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/User"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"List of users is returned","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get all users using a given SSO connection (Early Access)","tags":["Groups"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-01-31~experimental","2023-01-30~beta"],"x-snyk-api-resource":"groups","x-snyk-api-stability":"beta","x-snyk-api-version":"2023-01-30~beta","x-stability-level":"beta"}},"/groups/{group_id}/sso_connections/{sso_id}/users/{user_id}":{"delete":{"description":"Deletes a user from a Group SSO connection\n\n#### Required permissions\n\n- `View SSO settings (group.sso.read)`\n\n- `Delete users (group.user.delete)`","operationId":"deleteUser","parameters":[{"description":"The ID of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/SsoId"},{"$ref":"#/components/parameters/UserId20230130"},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"description":"User is deleted from Group SSO connection","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete a user from a Group SSO connection (Early Access)","tags":["Groups"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-01-31~experimental","2023-01-30~beta"],"x-snyk-api-resource":"groups","x-snyk-api-stability":"beta","x-snyk-api-version":"2023-01-30~beta","x-stability-level":"beta"}},"/groups/{group_id}/users/{id}":{"patch":{"description":"Update a user's membership of the group.\n\nTo remove a user's membership, provide 'null' as the membership parameter (see example).\n\nAt present, only removing memberships is supported by this endpoint. To update a user's group membership, please use\nthe UI or legacy API.\n\n#### Required permissions\n\n- `View Groups (group.read)`\n\n- `View users (group.user.read)`\n\n- `Remove users (group.user.remove)`","operationId":"updateUser","parameters":[{"description":"The id of the group","in":"path","name":"group_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the user","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"example":{"data":{"attributes":{"membership":null},"id":"55a348e2-c3ad-4bbc-b40e-9b232d1f4122","type":"user"}},"schema":{"properties":{"data":{"$ref":"#/components/schemas/UserPatchRequestBody"}},"type":"object"}}},"required":true},"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update a user's role in a group (Early Access)","tags":["Users"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-10-06~beta"],"x-snyk-api-resource":"users","x-snyk-api-stability":"beta","x-snyk-api-version":"2022-10-06~beta","x-stability-level":"beta"}},"/learn/catalog":{"get":{"description":"List Snyk Learn's catalog resources","operationId":"listLearnCatalog","parameters":[{"$ref":"#/components/parameters/ApiVersion"},{"$ref":"#/components/parameters/ContentSource"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EducationResourceExtended"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","links","jsonapi"],"type":"object"}}},"description":"Returns a list of catalog resources","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"List Snyk Learn's resources (Early Access)","tags":["Catalog Resource"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-05-13~experimental","2024-10-13~beta","2024-10-15~beta"],"x-snyk-api-resource":"catalog","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-snyk-documentation":{"category":"learn"},"x-stability-level":"beta"}},"/openapi":{"get":{"description":"List available versions of OpenAPI specification","operationId":"listAPIVersions","responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"List of available versions is returned","headers":{"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"tags":["OpenAPI"]}},"/openapi/{version}":{"get":{"description":"Get OpenAPI specification effective at version.","operationId":"getAPIVersion","parameters":[{"description":"The requested version of the API","in":"path","name":"version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OpenAPI specification matching requested version is returned","headers":{"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"tags":["OpenAPI"]}},"/orgs":{"get":{"description":"Get a paginated list of organizations you have access to.","operationId":"listOrgs","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"If set, only return organizations within the specified group","in":"query","name":"group_id","schema":{"format":"uuid","type":"string"}},{"description":"If true, only return organizations that are not part of a group.","in":"query","name":"is_personal","schema":{"type":"boolean"}},{"description":"Only return orgs whose slug exactly matches this value.","in":"query","name":"slug","schema":{"maxLength":100,"pattern":"^[\\w.-]+$","type":"string"}},{"description":"Only return orgs whose name contains this value.","in":"query","name":"name","schema":{"maxLength":100,"type":"string"}},{"description":"Expand the specified related resources in the response to include their attributes.","in":"query","name":"expand","schema":{"items":{"enum":["member_role"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/OrgWithRelationships"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A list of organizations you have access to.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"List accessible organizations","tags":["Orgs"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-04-06~experimental","2022-12-15~beta","2023-05-29","2024-02-28"],"x-snyk-api-resource":"orgs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-02-28","x-stability-level":"stable"}},"/orgs/{org_id}":{"get":{"description":"Get the full details of an organization.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getOrg","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Unique identifier for org","in":"path","name":"org_id","required":true,"schema":{"example":"b667f176-df52-4b0a-9954-117af6b05ab7","format":"uuid","type":"string"}},{"description":"Expand the specified related resources in the response to include their attributes.","in":"query","name":"expand","schema":{"items":{"enum":["tenant"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Org20230529"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returns an instance of an organization","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get organization","tags":["Orgs"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-04-06~experimental","2022-12-15~beta","2023-05-29"],"x-snyk-api-resource":"orgs","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-05-29","x-stability-level":"stable"},"patch":{"description":"Update the details of an organization\n\n#### Required permissions\n\n- `Edit Organization (org.edit)`","operationId":"updateOrg","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/PathOrgId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/OrgUpdateAttributes"},"id":{"description":"The ID of the resource.","format":"uuid","type":"string"},"type":{"description":"The type of the resource.","enum":["org"],"example":"org","type":"string"}},"required":["id","type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"org resource object","properties":{"attributes":{"$ref":"#/components/schemas/OrgAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/OrgRelationships"},"type":{"enum":["org"],"example":"org","type":"string"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Instance of org is updated","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update organization","tags":["Orgs"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-04-06~experimental","2022-12-15~beta","2023-05-29","2024-02-28"],"x-snyk-api-resource":"orgs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-02-28","x-stability-level":"stable"}},"/orgs/{org_id}/ai_bom_jobs/{job_id}":{"get":{"description":"Returns the status of an AI-BOM job. The job status is returned in the response body. If the job is completed the response status code will be 303, redirecting to the getAiBom endpoint.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getAiBomJob","parameters":[{"description":"The requested version of the endpoint to process the request","example":"2024-10-15","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},{"$ref":"#/components/parameters/OrgIdParam"},{"$ref":"#/components/parameters/JobIdParam"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetAiBomResponseJobBody"}}},"description":"Successful API response with a single resource","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"retry-after":{"description":"How long the client should wait before retrying (in seconds). retry-after:0 means you can retry immediately","example":"10","schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"303":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/JobData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"Redirect to another resource after async processing.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"description":"The location of the ai_bom resource","required":true,"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrence of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found or you do not have permission to access it.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrence of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Get an AI-BOM job status (Early Access)","tags":["AiBom"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"ai_boms","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/ai_boms":{"post":{"description":"Triggers the creation of a new AI-BOM. The AI-BOM will be created in a background job. Users should query the background job status by using the getAiBomJob endpoint (/orgs/{org_id}/ai_bom_jobs/{job_id}). The response will contain a content-location header pointing to the getAiBomJob endpoint.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"createAiBom","parameters":[{"description":"The requested version of the endpoint to process the request","example":"2024-10-15","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},{"$ref":"#/components/parameters/OrgIdParam"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateAiBomRequestBody"}}}},"responses":{"202":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateAiBomResponseBody"}}},"description":"The request has been accepted for processing, but processing has not yet completed.","headers":{"content-location":{"description":"The content-location header points to the status endpoint (/orgs/{org_id}/ai_bom_jobs/{job_id}","required":true,"schema":{"format":"string","type":"string"}},"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrence of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrence of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found or you do not have permission to access it.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrence of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"503":{"$ref":"#/components/responses/503"}},"summary":"Create a new AI-BOM (Early Access)","tags":["AiBom"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"ai_boms","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/ai_boms/upload":{"post":{"description":"Creates an AI-BOM from a file bundle and persists it to the database. Unlike the standard createAiBom endpoint, this endpoint requires a repo_name and will store the AI-BOM for later retrieval and testing. The AI-BOM will be created in a background job. Users should query the background job status by using the getAiBomJob endpoint.\n\n#### Required permissions\n\n- `Edit Organization (org.edit)`","operationId":"createAndUploadAiBom","parameters":[{"description":"The requested version of the endpoint to process the request","example":"2024-10-15","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},{"$ref":"#/components/parameters/OrgIdParam"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateAndUploadAiBomRequestBody"}}}},"responses":{"202":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateAiBomResponseBody"}}},"description":"The request has been accepted for processing, but processing has not yet completed.","headers":{"content-location":{"description":"The content-location header points to the status endpoint (/orgs/{org_id}/ai_bom_jobs/{job_id}","required":true,"schema":{"format":"string","type":"string"}},"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrence of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrence of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found or you do not have permission to access it.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrence of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"503":{"$ref":"#/components/responses/503"}},"summary":"Create and upload an AI-BOM (Early Access)","tags":["AiBom"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"ai_boms","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/ai_boms/{ai_bom_id}":{"get":{"description":"Get a AI-BOM once it's job has finished\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getAiBom","parameters":[{"description":"The requested version of the endpoint to process the request","example":"2024-10-15","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},{"$ref":"#/components/parameters/OrgIdParam"},{"$ref":"#/components/parameters/AiBomIdParam"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetAiBomResponseBody"}}},"description":"Successful API response with a single resource","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrence of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found or you do not have permission to access it.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrence of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"A header containing the version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"A header containing the version of the endpoint requested by the caller.","example":"2024-10-15","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"A header containing the version of the endpoint that was served by the API.","example":"2024-10-15","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Get an AI-BOM. (Early Access)","tags":["AiBom"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"ai_boms","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/app_bots":{"get":{"deprecated":true,"description":"Get a list of app bots authorized to an organization. Deprecated, use /orgs/{org_id}/apps/installs instead.\n\n#### Required permissions\n\n- `View Apps (org.app.read)`","operationId":"getAppBots","parameters":[{"description":"Expand relationships.","explode":false,"in":"query","name":"expand","schema":{"items":{"enum":["app"],"type":"string"},"type":"array"},"style":"form"},{"description":"Organization ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/AppBot"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"A list of app bots authorized to the specified organization","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Get a list of app bots authorized to an organization.","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-03-11"],"x-snyk-api-resource":"app_bots","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-03-11","x-snyk-sunset-eligible":"2024-07-17","x-stability-level":"stable"}},"/orgs/{org_id}/app_bots/{bot_id}":{"delete":{"deprecated":true,"description":"Revoke app bot authorization. Deprecated, use /orgs/{org_id}/apps/installs/{install_id} instead.\n\n#### Required permissions\n\n- `Install Apps (org.app.install)`","operationId":"deleteAppBot","parameters":[{"description":"The ID of the app bot","in":"path","name":"bot_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":"The app bot has been deauthorized","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Revoke app bot authorization","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-03-11"],"x-snyk-api-resource":"app_bots","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-03-11","x-snyk-sunset-eligible":"2024-07-17","x-stability-level":"stable"}},"/orgs/{org_id}/apps":{"get":{"deprecated":true,"description":"Get a list of Snyk Apps created by an Organization Deprecated, use /orgs/{org_id}/apps/creations instead.\n\n#### Required permissions\n\n- `View Apps (org.app.read)`","operationId":"getApps","parameters":[{"$ref":"#/components/parameters/OrgId__0"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/AppData20220311"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"A list of apps created by the specified organization","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Get a list of Snyk Apps created by an Organization","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-03-11"],"x-snyk-api-resource":"apps","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-03-11","x-snyk-sunset-eligible":"2024-07-17","x-stability-level":"stable"},"post":{"deprecated":true,"description":"Create a new app for an organization. Deprecated, use /orgs/{org_id}/apps/creations instead.\n\n#### Required permissions\n\n- `Create Apps (org.app.create)`","operationId":"createApp","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId__0"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AppPostRequest20220311"}}},"description":"app to be created"},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AppPostResponse20220311"}}},"description":"Created Snyk App successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Create a new app for an organization.","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-03-11"],"x-snyk-api-resource":"apps","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-03-11","x-snyk-sunset-eligible":"2024-07-17","x-stability-level":"stable"}},"/orgs/{org_id}/apps/creations":{"get":{"description":"Get a list of Snyk Apps created by an Organization\n\n#### Required permissions\n\n- `View Apps (org.app.read)`","operationId":"getOrgApps","parameters":[{"$ref":"#/components/parameters/OrgId__0"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/AppData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"A list of apps created by the specified organization","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Get a list of Snyk Apps created by an Organization","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03"],"x-snyk-api-resource":"apps","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-11-03","x-stability-level":"stable"},"post":{"description":"Create a new Snyk App for an organization\n\n#### Required permissions\n\n- `Create Apps (org.app.create)`","operationId":"createOrgApp","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId__0"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AppPostRequest"}}},"description":"Snyk App details for app to be created."},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AppPostResponse"}}},"description":"Created Snyk App successfully.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Create a new Snyk App for an organization","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03"],"x-snyk-api-resource":"apps","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-11-03","x-stability-level":"stable"}},"/orgs/{org_id}/apps/creations/{app_id}":{"delete":{"description":"Delete a Snyk App by app ID\n\n#### Required permissions\n\n- `Delete Apps (org.app.delete)`","operationId":"deleteAppByID","parameters":[{"$ref":"#/components/parameters/OrgId__0"},{"$ref":"#/components/parameters/AppId"},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"description":"The app has been deleted","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Delete a Snyk App by app ID","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03"],"x-snyk-api-resource":"apps","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-11-03","x-stability-level":"stable"},"get":{"description":"Get a Snyk App by app ID\n\n#### Required permissions\n\n- `View Apps (org.app.read)`","operationId":"getAppByID","parameters":[{"$ref":"#/components/parameters/OrgId__0"},{"$ref":"#/components/parameters/AppId"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Attributes of the requested Snyk App.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Get a Snyk App by app ID","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03"],"x-snyk-api-resource":"apps","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-11-03","x-stability-level":"stable"},"patch":{"description":"Update app creation attributes with App ID\n\n#### Required permissions\n\n- `Edit Apps (org.app.edit)`","operationId":"updateAppCreationByID","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId__0"},{"$ref":"#/components/parameters/AppId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AppPatchRequest"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Attributes of the updated Snyk App.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Update app creation attributes such as name, redirect URIs, and access token time to live using the App ID","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03"],"x-snyk-api-resource":"apps","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-11-03","x-stability-level":"stable"}},"/orgs/{org_id}/apps/creations/{app_id}/secrets":{"post":{"description":"Manage client secret for a Snyk App\n\n#### Required permissions\n\n- `Edit Apps (org.app.edit)`","operationId":"manageAppCreationSecret","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId__0"},{"$ref":"#/components/parameters/AppId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"mode":{"description":"Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n","enum":["replace","create","delete"],"type":"string"},"secret":{"description":"Secret to delete when using `delete` mode","type":"string"}},"required":["mode"],"type":"object"},"type":{"enum":["app"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppDataWithSecret"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Secret has been updated.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Manage client secret for a Snyk App","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03"],"x-snyk-api-resource":"apps","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-11-03","x-stability-level":"stable"}},"/orgs/{org_id}/apps/installs":{"get":{"description":"Get a list of Snyk Apps installed for an Organization\n\n#### Required permissions\n\n- `View Apps (org.app.read)`","operationId":"getAppInstallsForOrg","parameters":[{"description":"Expand relationships.","explode":false,"in":"query","name":"expand","schema":{"items":{"enum":["app"],"type":"string"},"type":"array"},"style":"form"},{"description":"Organization ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/AppInstallData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"A list of apps installed for the specified organization.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Get a list of Snyk Apps installed for an Organization","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03","2024-05-23"],"x-snyk-api-resource":"app_installs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-23","x-stability-level":"stable"},"post":{"description":"Install a Snyk App to this organization, the Snyk App must use unattended authentication e.g. client credentials\n\n#### Required permissions\n\n- `Install Apps (org.app.install)`","operationId":"createOrgAppInstall","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId__0"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"properties":{"type":{"enum":["app_install"],"example":"app_install","type":"string"}},"type":"object"},"relationships":{"additionalProperties":false,"properties":{"app":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/Uuid"},"type":{"enum":["app"],"example":"app","type":"string"}},"required":["id","type"],"type":"object"}},"required":["data"],"type":"object"}},"required":["app"],"type":"object"}},"required":["data","relationships"],"type":"object"}}},"description":"App Install to be created"},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppInstallWithClient"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"The newly created app install.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Install a Snyk App for an Organization","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03","2024-05-23"],"x-snyk-api-resource":"app_installs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-23","x-stability-level":"stable"}},"/orgs/{org_id}/apps/installs/{install_id}":{"delete":{"description":"Revoke app authorization for a Snyk organization with install ID\n\n#### Required permissions\n\n- `Install Apps (org.app.install)`","operationId":"deleteAppOrgInstallById","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId__0"},{"$ref":"#/components/parameters/InstallId"}],"responses":{"204":{"description":"The Snyk App install is revoked, with no content (no errors).","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Revoke app authorization for a Snyk organization with install ID","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03","2024-05-23"],"x-snyk-api-resource":"app_installs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-23","x-stability-level":"stable"}},"/orgs/{org_id}/apps/installs/{install_id}/secrets":{"post":{"description":"Manage client secret for non-interactive Snyk App installations\n\n#### Required permissions\n\n- `Edit Apps (org.app.edit)`","operationId":"updateOrgAppInstallSecret","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId__0"},{"$ref":"#/components/parameters/InstallId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"mode":{"description":"Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n","enum":["replace","create","delete"],"type":"string"},"secret":{"description":"Secret to delete when using `delete` mode","type":"string"}},"required":["mode"],"type":"object"},"type":{"enum":["app"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppInstallDataWithSecret"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Secret has been updated.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Manage client secret for non-interactive Snyk App installations","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03","2024-05-23"],"x-snyk-api-resource":"app_installs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-23","x-stability-level":"stable"}},"/orgs/{org_id}/apps/{client_id}":{"delete":{"deprecated":true,"description":"Delete an app by app id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.\n\n#### Required permissions\n\n- `Delete Apps (org.app.delete)`","operationId":"deleteApp","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId__0"},{"$ref":"#/components/parameters/ClientId"}],"responses":{"204":{"description":"The app has been deleted","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Delete an app","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-03-11"],"x-snyk-api-resource":"apps","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-03-11","x-snyk-sunset-eligible":"2024-07-17","x-stability-level":"stable"},"get":{"deprecated":true,"description":"Get an App by client id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.\n\n#### Required permissions\n\n- `View Apps (org.app.read)`","operationId":"getApp","parameters":[{"$ref":"#/components/parameters/OrgId__0"},{"$ref":"#/components/parameters/ClientId"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppData20220311"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Attributes of the requested Snyk App.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Get an app by client id","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-03-11"],"x-snyk-api-resource":"apps","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-03-11","x-snyk-sunset-eligible":"2024-07-17","x-stability-level":"stable"},"patch":{"deprecated":true,"description":"Update app attributes. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.\n\n#### Required permissions\n\n- `Edit Apps (org.app.edit)`","operationId":"updateApp","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId__0"},{"$ref":"#/components/parameters/ClientId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AppPatchRequest20220311"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppData20220311"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Attributes of the updated Snyk App.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Update app attributes that are name, redirect URIs, and access token time to live","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-03-11"],"x-snyk-api-resource":"apps","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-03-11","x-snyk-sunset-eligible":"2024-07-17","x-stability-level":"stable"}},"/orgs/{org_id}/apps/{client_id}/secrets":{"post":{"deprecated":true,"description":"Manage client secrets for an app. Deprecated, use /orgs/{org_id}/apps/creations/{app_id}/secrets instead.\n\n#### Required permissions\n\n- `Edit Apps (org.app.edit)`","operationId":"manageSecrets","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId__0"},{"$ref":"#/components/parameters/ClientId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"mode":{"description":"Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n","enum":["replace","create","delete"],"type":"string"},"secret":{"description":"Secret to delete when using `delete` mode","type":"string"}},"required":["mode"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AppDataWithSecret20220311"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Secrets have been updated.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Manage client secrets for an app.","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-03-11"],"x-snyk-api-resource":"apps","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-03-11","x-snyk-sunset-eligible":"2024-07-17","x-stability-level":"stable"}},"/orgs/{org_id}/audit_logs/search":{"get":{"description":"Search audit logs for an Organization. \"api.access\" events are omitted from results unless explicitly requested using the events parameter. Supported event types:\n - api.access\n - org.app_bot.create\n - org.app.create\n - org.app.delete\n - org.app.edit\n - org.cloud_config.settings.edit\n - org.collection.create\n - org.collection.delete\n - org.collection.edit\n - org.create\n - org.delete\n - org.edit\n - org.ignore_policy.edit\n - org.integration.create\n - org.integration.delete\n - org.integration.edit\n - org.integration.settings.edit\n - org.language_settings.edit\n - org.notification_settings.edit\n - org.org_source.create\n - org.org_source.delete\n - org.org_source.edit\n - org.policy.create\n - org.policy.edit\n - org.policy.delete\n - org.project_filter.create\n - org.project_filter.delete\n - org.project.add\n - org.project.attributes.edit\n - org.project.delete\n - org.project.edit\n - org.project.fix_pr.auto_open\n - org.project.fix_pr.manual_open\n - org.project.ignore.create\n - org.project.ignore.delete\n - org.project.ignore.edit\n - org.project.monitor\n - org.project.pr_check.edit\n - org.project.remove\n - org.project.settings.delete\n - org.project.settings.edit\n - org.project.stop_monitor\n - org.project.tag.add\n - org.project.tag.remove\n - org.project.test\n - org.request_access_settings.edit\n - org.sast_settings.edit\n - org.service_account.create\n - org.service_account.delete\n - org.service_account.edit\n - org.settings.feature_flag.edit\n - org.target.create\n - org.target.delete\n - org.user.add\n - org.user.invite\n - org.user.invite.accept\n - org.user.invite.revoke\n - org.user.invite_link.accept\n - org.user.invite_link.create\n - org.user.invite_link.revoke\n - org.user.leave\n - org.user.provision.accept\n - org.user.provision.create\n - org.user.provision.delete\n - org.user.remove\n - org.user.role.create\n - org.user.role.delete\n - org.user.role.details.edit\n - org.user.role.edit\n - org.user.role.permissions.edit\n - org.webhook.add\n - org.webhook.delete\n - user.org.notification_settings.edit\n\n#### Required permissions\n\n- `View audit logs (org.audit_log.read)`","operationId":"listOrgAuditLogs","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/OrgId"},{"$ref":"#/components/parameters/Cursor"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/To"},{"$ref":"#/components/parameters/Size"},{"$ref":"#/components/parameters/SortOrder"},{"$ref":"#/components/parameters/UserId"},{"$ref":"#/components/parameters/ProjectId"},{"$ref":"#/components/parameters/Events"},{"$ref":"#/components/parameters/ExcludeEvents"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/AuditLogSearch"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"Organization Audit Logs.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Search Organization audit logs.","tags":["Audit Logs"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-09-11","2024-04-29"],"x-snyk-api-resource":"audit-logs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-04-29","x-stability-level":"stable"}},"/orgs/{org_id}/brokers/connections":{"get":{"description":"List all Broker connections integrated with a given org\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"listBrokerConnectionsForOrg","parameters":[{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ListBrokerConnectionsSummaryResponse"}}},"description":"Returns the list of Broker connections by org ID","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: one or more parameters are invalid. Check the input to match the expected format. See [Snyk API](https://docs.snyk.io/snyk-api)","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token. See [Revoke and regenerate a Snyk API token](https://docs.snyk.io/snyk-api/rest-api/authentication-for-api/revoke-and-regenerate-a-snyk-api-token).","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource you are trying to access could not be found. Review the request and try again.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}}},"summary":"List Broker connections for a given organization","tags":["BrokerConnections"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"connections","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/orgs/{org_id}/cloud/environments":{"get":{"description":"List environments for an organization\n\n#### Required permissions\n\n- `View environments (org.cloud_environments.read)`","operationId":"listEnvironments","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/CreatedAfter"},{"$ref":"#/components/parameters/CreatedBefore"},{"$ref":"#/components/parameters/UpdatedAfter"},{"$ref":"#/components/parameters/UpdatedBefore"},{"$ref":"#/components/parameters/NameInQuery"},{"$ref":"#/components/parameters/KindInQuery"},{"$ref":"#/components/parameters/StatusInQuery"},{"$ref":"#/components/parameters/IdInQuery"},{"description":"Filter environments by project ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"query","name":"project_id","schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"properties":{"attributes":{"$ref":"#/components/schemas/EnvironmentAttributes"},"id":{"description":"Environment ID","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/EnvironmentRelationships"},"type":{"$ref":"#/components/schemas/EnvironmentType"}},"required":["id","type"],"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns a list of environments","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"List Environments (Early Access)","tags":["Cloud"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta","2023-10-19~beta"],"x-snyk-api-resource":"environments","x-snyk-api-stability":"beta","x-snyk-api-version":"2023-10-19~beta","x-stability-level":"beta"},"post":{"description":"Create a new environment and run a scan\n\n#### Required permissions\n\n- `Create environments (org.cloud_environments.create)`","operationId":"createEnvironment","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/EnvironmentCreateAttributes"},"type":{"$ref":"#/components/schemas/EnvironmentType"}},"required":["type"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"Environment resource object","properties":{"attributes":{"$ref":"#/components/schemas/EnvironmentAttributes"},"id":{"description":"Environment ID","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/EnvironmentRelationships"},"type":{"$ref":"#/components/schemas/EnvironmentType"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}}}}},"description":"Created environment successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create New Environment (Early Access)","tags":["Cloud"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta","2023-10-19~beta"],"x-snyk-api-resource":"environments","x-snyk-api-stability":"beta","x-snyk-api-version":"2023-10-19~beta","x-stability-level":"beta"}},"/orgs/{org_id}/cloud/environments/{environment_id}":{"delete":{"description":"Delete an environment\n\n#### Required permissions\n\n- `Delete environments (org.cloud_environments.delete)`","operationId":"deleteEnvironment","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/EnvironmentId"}],"responses":{"204":{"description":"Returns an empty response","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete Environment (Early Access)","tags":["Cloud"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta","2023-10-19~beta"],"x-snyk-api-resource":"environments","x-snyk-api-stability":"beta","x-snyk-api-version":"2023-10-19~beta","x-stability-level":"beta"},"patch":{"description":"Update an environment\n\n#### Required permissions\n\n- `Update environments (org.cloud_environments.edit)`","operationId":"updateEnvironment","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/EnvironmentId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/EnvironmentUpdateAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentType"}},"required":["id","type"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"environment resource object","properties":{"attributes":{"$ref":"#/components/schemas/EnvironmentAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/EnvironmentRelationships"},"type":{"$ref":"#/components/schemas/EnvironmentType"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Updated an environment successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update Environment (Early Access)","tags":["Cloud"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta","2023-10-19~beta"],"x-snyk-api-resource":"environments","x-snyk-api-stability":"beta","x-snyk-api-version":"2023-10-19~beta","x-stability-level":"beta"}},"/orgs/{org_id}/cloud/permissions":{"post":{"description":"Generate IAC template for Snyk to access your cloud resources\n\n#### Required permissions\n\n- `Create environments (org.cloud_environments.create)`","operationId":"getPermissions","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CreatePermissionsAttributes"},"type":{"example":"permission","type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"permissions resource object","properties":{"attributes":{"$ref":"#/components/schemas/PermissionsAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"example":"permission","type":"string"}},"required":["attributes","id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}}}}},"description":"Created permissions successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Generate Cloud Provider Permissions (Early Access)","tags":["Cloud"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta","2023-10-19~beta"],"x-snyk-api-resource":"permissions","x-snyk-api-stability":"beta","x-snyk-api-version":"2023-10-19~beta","x-stability-level":"beta"}},"/orgs/{org_id}/cloud/resources":{"get":{"description":"List resources for an organization\n\n#### Required permissions\n\n- `View resources (org.cloud_resources.read)`","operationId":"listResources","parameters":[{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/EnvironmentIdQuery"},{"$ref":"#/components/parameters/ResourceType"},{"$ref":"#/components/parameters/ResourceId"},{"$ref":"#/components/parameters/NativeId"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/Platform"},{"$ref":"#/components/parameters/Name"},{"$ref":"#/components/parameters/Kind"},{"$ref":"#/components/parameters/Location"},{"$ref":"#/components/parameters/Removed"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"properties":{"attributes":{"$ref":"#/components/schemas/ResourceAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/ResourceRelationships"},"type":{"example":"resource","type":"string"}},"required":["id","type"],"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns a list of resources","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"List Resources (Early Access)","tags":["Cloud"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta","2023-10-19~beta"],"x-snyk-api-resource":"resources","x-snyk-api-stability":"beta","x-snyk-api-version":"2023-10-19~beta","x-stability-level":"beta"}},"/orgs/{org_id}/cloud/scans":{"get":{"description":"List scans for an organization\n\n#### Required permissions\n\n- `View scans (org.cloud_scans.read)`","operationId":"listScan","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"properties":{"attributes":{"$ref":"#/components/schemas/ScanAttributes"},"id":{"description":"Scan ID","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/ScanRelationships"},"type":{"$ref":"#/components/schemas/ScanType"}},"required":["id","type"],"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns a list of scan instances","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"List Scans (Early Access)","tags":["Cloud"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta"],"x-snyk-api-resource":"scans","x-snyk-api-stability":"beta","x-snyk-api-version":"2022-12-21~beta","x-stability-level":"beta"},"post":{"description":"Create and trigger a new scan for an environment\n\n#### Required permissions\n\n- `Create scans (org.cloud_scans.create)`","operationId":"createScan","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ScanCreateAttributes"},"relationships":{"$ref":"#/components/schemas/ScanCreateRelationships"},"type":{"$ref":"#/components/schemas/ScanType"}},"required":["type"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"Scan resource object","properties":{"attributes":{"$ref":"#/components/schemas/ScanAttributes"},"id":{"description":"Scan ID","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/ScanRelationships"},"type":{"$ref":"#/components/schemas/ScanType"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}}}}},"description":"Created scan successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create Scan (Early Access)","tags":["Cloud"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-04-13~experimental","2022-12-21~beta"],"x-snyk-api-resource":"scans","x-snyk-api-stability":"beta","x-snyk-api-version":"2022-12-21~beta","x-stability-level":"beta"}},"/orgs/{org_id}/cloud/scans/{scan_id}":{"get":{"description":"Get a single scan for an organization\n\n#### Required permissions\n\n- `View scans (org.cloud_scans.read)`","operationId":"getScan","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Organization ID","example":"9a46d918-8764-458c-1234-0987abcd6543","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ScanId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"properties":{"attributes":{"$ref":"#/components/schemas/ScanAttributes"},"id":{"description":"Scan ID","example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/ScanRelationships"},"type":{"$ref":"#/components/schemas/ScanType"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns a single scan instance","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get scan (Early Access)","tags":["Cloud"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-12-21~beta"],"x-snyk-api-resource":"scans","x-snyk-api-stability":"beta","x-snyk-api-version":"2022-12-21~beta","x-stability-level":"beta"}},"/orgs/{org_id}/collections":{"get":{"description":"Return a list of organization's collections with issues counts and projects count.\n\n#### Required permissions\n\n- `View Collections (org.collection.read)`\n\n- `View Project history (org.project.snapshot.read)`","operationId":"getCollections","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"Return collections sorted by the specified attributes","in":"query","name":"sort","schema":{"enum":["name","projectsCount","issues"],"type":"string"}},{"description":"Return collections sorted in the specified direction","in":"query","name":"direction","schema":{"default":"DESC","enum":["ASC","DESC"],"type":"string"}},{"allowEmptyValue":true,"description":"Return collections which names include the provided string","in":"query","name":"name","schema":{"maxLength":255,"type":"string"}},{"allowEmptyValue":true,"description":"Return collections where is_generated matches the provided boolean","in":"query","name":"is_generated","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CollectionResponse"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns a list of collections","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get collections","tags":["Collection"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-01~beta","2023-09-12"],"x-snyk-api-resource":"collections","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-12","x-stability-level":"stable"},"post":{"description":"Create a collection\n\n#### Required permissions\n\n- `Create Collections (org.collection.create)`","operationId":"createCollection","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateCollectionRequest"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"collection resource object","properties":{"attributes":{"$ref":"#/components/schemas/CollectionAttributes"},"id":{"format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/CollectionRelationships"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","attributes","relationships"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returned collection","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create a collection","tags":["Collection"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-01~beta","2023-09-12"],"x-snyk-api-resource":"collections","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-12","x-stability-level":"stable"}},"/orgs/{org_id}/collections/{collection_id}":{"delete":{"description":"Delete a collection\n\n#### Required permissions\n\n- `Delete Collections (org.collection.delete)`","operationId":"deleteCollection","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/CollectionId"}],"responses":{"204":{"description":"Collection was deleted successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete a collection","tags":["Collection"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-01~beta","2023-09-12"],"x-snyk-api-resource":"collections","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-12","x-stability-level":"stable"},"get":{"description":"Get a collection\n\n#### Required permissions\n\n- `View Collections (org.collection.read)`","operationId":"getCollection","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/CollectionId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"collection resource object","properties":{"attributes":{"$ref":"#/components/schemas/CollectionAttributes"},"id":{"format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/CollectionRelationships"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","attributes","relationships"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returned collection","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a collection","tags":["Collection"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-01~beta","2023-09-12"],"x-snyk-api-resource":"collections","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-12","x-stability-level":"stable"},"patch":{"description":"Edit a collection\n\n#### Required permissions\n\n- `Edit Collections (org.collection.edit)`","operationId":"updateCollection","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/CollectionId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdateCollectionRequest"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"collection resource object","properties":{"attributes":{"$ref":"#/components/schemas/CollectionAttributes"},"id":{"format":"uuid","type":"string"},"relationships":{"$ref":"#/components/schemas/CollectionRelationships"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","attributes","relationships"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returned collection","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Edit a collection","tags":["Collection"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-01~beta","2023-09-12"],"x-snyk-api-resource":"collections","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-12","x-stability-level":"stable"}},"/orgs/{org_id}/collections/{collection_id}/relationships/projects":{"delete":{"description":"Remove projects from a collection by specifying an array of project ids\n\n#### Required permissions\n\n- `Edit Collections (org.collection.edit)`","operationId":"deleteProjectsCollection","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/CollectionId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/DeleteProjectsFromCollectionRequest"}}}},"responses":{"204":{"description":"successfully removing projects from a collection","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Remove projects from a collection","tags":["Collection"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-01~beta","2023-09-12"],"x-snyk-api-resource":"collections","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-12","x-stability-level":"stable"},"get":{"description":"Return a list of organization's projects that are from the specified collection.\n\n#### Required permissions\n\n- `View Collections (org.collection.read)`\n\n- `View Projects (org.project.read)`\n\n- `View Project history (org.project.snapshot.read)`","operationId":"getProjectsOfCollection","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/CollectionId"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"Return projects sorted by the specified attributes","in":"query","name":"sort","schema":{"enum":["imported","last_tested_at","issues"],"type":"string"}},{"description":"Return projects sorted in the specified direction","in":"query","name":"direction","schema":{"default":"DESC","enum":["ASC","DESC"],"type":"string"}},{"description":"Return projects that belong to the provided targets","in":"query","name":"target_id","schema":{"items":{"format":"uuid","type":"string"},"maxItems":25,"type":"array"}},{"description":"Return projects that are with or without issues","in":"query","name":"show","schema":{"items":{"enum":["vuln-groups","clean-groups"],"type":"string"},"type":"array"}},{"description":"Return projects that match the provided integration types","in":"query","name":"integration","schema":{"items":{"enum":["acr","api","artifactory-cr","aws-lambda","azure-functions","azure-repos","bitbucket-cloud","bitbucket-connect-app","bitbucket-server","cli","cloud-foundry","digitalocean-cr","docker-hub","ecr","gcr","github-cr","github-enterprise","github","gitlab-cr","gitlab","google-artifact-cr","harbor-cr","heroku","ibm-cloud","kubernetes","nexus-cr","pivotal","quay-cr","terraform-cloud"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetProjectsOfCollectionResponse"}}},"description":"Returns a list of projects from the specified collection","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get projects from the specified collection","tags":["Collection"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-01~beta","2023-09-12"],"x-snyk-api-resource":"collections","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-12","x-stability-level":"stable"},"post":{"description":"Add projects to a collection by specifying an array of project ids\n\n#### Required permissions\n\n- `Edit Collections (org.collection.edit)`","operationId":"updateCollectionWithProjects","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/CollectionId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdateCollectionWithProjectsRequest"}}}},"responses":{"204":{"description":"successfully adding projects to a collection","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Add projects to a collection","tags":["Collection"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-01~beta","2023-09-12"],"x-snyk-api-resource":"collections","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-12","x-stability-level":"stable"}},"/orgs/{org_id}/container_images":{"get":{"description":"List instances of container image\n\n#### Required permissions\n\n- `View container images (org.container_image.read)`","operationId":"listContainerImage","parameters":[{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"example":"f59045b3-f093-40c3-871d-a334ae30c568","format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ImageIds"},{"description":"The image Operating System and processor architecture","example":"linux/amd64","in":"query","name":"platform","schema":{"enum":["aix/ppc64","android/386","android/amd64","android/arm","android/arm/v5","android/arm/v6","android/arm/v7","android/arm64","android/arm64/v8","darwin/amd64","darwin/arm","darwin/arm/v5","darwin/arm/v6","darwin/arm/v7","darwin/arm64","darwin/arm64/v8","dragonfly/amd64","freebsd/386","freebsd/amd64","freebsd/arm","freebsd/arm/v5","freebsd/arm/v6","freebsd/arm/v7","illumos/amd64","ios/arm64","ios/arm64/v8","js/wasm","linux/386","linux/amd64","linux/arm","linux/arm/v5","linux/arm/v6","linux/arm/v7","linux/arm64","linux/arm64/v8","linux/loong64","linux/mips","linux/mipsle","linux/mips64","linux/mips64le","linux/ppc64","linux/ppc64le","linux/riscv64","linux/s390x","linux/x86_64","netbsd/386","netbsd/amd64","netbsd/arm","netbsd/arm/v5","netbsd/arm/v6","netbsd/arm/v7","openbsd/386","openbsd/amd64","openbsd/arm","openbsd/arm/v5","openbsd/arm/v6","openbsd/arm/v7","openbsd/arm64","openbsd/arm64/v8","plan9/386","plan9/amd64","plan9/arm","plan9/arm/v5","plan9/arm/v6","plan9/arm/v7","solaris/amd64","windows/386","windows/amd64","windows/arm","windows/arm/v5","windows/arm/v6","windows/arm/v7","windows/arm64","windows/arm64/v8"],"example":"linux/amd64","type":"string"}},{"$ref":"#/components/parameters/Names"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns a list of container image instances","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"List instances of container image","tags":["ContainerImage"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-03-08~beta","2023-08-18~beta","2023-11-02"],"x-snyk-api-resource":"container_images","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-11-02","x-stability-level":"stable"}},"/orgs/{org_id}/container_images/{image_id}":{"get":{"description":"Get instance of container image\n\n#### Required permissions\n\n- `View container images (org.container_image.read)`","operationId":"getContainerImage","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"example":"f59045b3-f093-40c3-871d-a334ae30c568","format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ImageId20231102"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Image"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returns an instance of container image","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get instance of container image","tags":["ContainerImage"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-03-08~beta","2023-11-02"],"x-snyk-api-resource":"container_images","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-11-02","x-stability-level":"stable"}},"/orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs":{"get":{"description":"List instances of image target references for a container image\n\n#### Required permissions\n\n- `View container images (org.container_image.read)`","operationId":"listImageTargetRefs","parameters":[{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"example":"f59045b3-f093-40c3-871d-a334ae30c568","format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ImageId20231102"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ImageTargetRef"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"type":"object"}}},"description":"Returns a list of image target references for a container image","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"List instances of image target references for a container image","tags":["ContainerImage"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-08-18~beta","2023-11-02"],"x-snyk-api-resource":"container_images","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-11-02","x-stability-level":"stable"}},"/orgs/{org_id}/container_import/{integration_id}/policy/dry_run":{"post":{"description":"Dry run a container registry import policy\n\n#### Required permissions\n\n- `Edit integrations (org.integration.edit)`","operationId":"createContainerRegistryImportPolicyDryRun","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Container Registry Integration ID","in":"path","name":"integration_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ContainerRegistryImportPolicyAttributes"},"type":{"enum":["container_registry_import_policy"],"type":"string"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"description":"container registry import policy resource object","properties":{"attributes":{"$ref":"#/components/schemas/TestPolicyResponseAttributes"},"id":{"$ref":"#/components/schemas/IntegrationId"},"type":{"enum":["container_registry_import_policy"],"type":"string"}},"required":["type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Dry ran a container registry import policy successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Dry run a container registry import policy (Early Access)","tags":["ContainerRegistryImportPolicy"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta","2025-09-17~beta"],"x-snyk-api-resource":"import_policy","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-snyk-deprecated-by":"2025-09-17~beta","x-snyk-sunset-eligible":"2025-12-17","x-stability-level":"beta"}},"/orgs/{org_id}/ecosystems/{ecosystem}/packages/{package_name}":{"get":{"description":"Get package metadata for a specific package from an ecosystem.\n\n**Important:** The security section of `package_health` refers to the `latest_version` of the package, not all versions. Since the `overall_rating` is computed from all health sections (including security), it is also influenced by the latest version's security data.\n\n**Supported Ecosystems:** npm, pypi, maven, nuget, golang\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getPackage","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Ecosystem"},{"$ref":"#/components/parameters/PackageName"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"description":"package resource object","properties":{"attributes":{"$ref":"#/components/schemas/PackageAttributes"},"id":{"description":"Package identifier in PURL format","example":"pkg:npm/express","format":"uri","type":"string"},"type":{"description":"Resource type identifier","example":"package","type":"string"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"additionalProperties":false,"properties":{"self":{"example":"https://api.snyk.io/rest/orgs/12345/ecosystems/npm/packages/express?version=2024-10-15","format":"uri","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Returns package metadata","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a package (Early Access)","tags":["Package"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"packages","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/ecosystems/{ecosystem}/packages/{package_name}/versions/{package_version}":{"get":{"description":"Get package version metadata for a specific version of a package from an ecosystem.\n\n**Important:** The security section of `package_health` refers to the **specific version in the request**, not the latest version. Since the `overall_rating` is computed from all health sections (including security), it is also influenced by this version's security data.\n\n**Supported Ecosystems:** npm, pypi, maven, nuget, golang\n\n**Version Format:** Accepts standard semantic versioning formats (e.g., `1.2.3`, `v1.2.3`). **Note:** Golang commit hashes are NOT supported as version identifiers. Use tagged versions only.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getPackageVersion","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Ecosystem"},{"$ref":"#/components/parameters/PackageName"},{"$ref":"#/components/parameters/PackageVersion"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"description":"package version resource object","properties":{"attributes":{"$ref":"#/components/schemas/PackageVersionAttributes"},"id":{"description":"Package version identifier in PURL format (e.g., pkg:npm/express@4.19.2)","example":"pkg:npm/express@4.19.2","format":"uri","type":"string"},"package_version":{"description":"The specific version string of this package","example":"4.19.2","type":"string"},"type":{"description":"Resource type identifier","example":"package_version","type":"string"}},"required":["id","type","package_version"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"additionalProperties":false,"properties":{"self":{"example":"https://api.snyk.io/rest/orgs/12345/ecosystems/npm/packages/express/versions/4.19.2?version=2024-10-15","format":"uri","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Returns package version metadata","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a package version (Early Access)","tags":["Package Version"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"versions","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/export":{"post":{"description":"Create and start an export for an org\n\n#### Required permissions\n\n- `View Organization reports (org.report.read)`","operationId":"createExport","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/orgId"},{"$ref":"#/components/parameters/include_deleted"},{"$ref":"#/components/parameters/include_deactivated"}],"requestBody":{"$ref":"#/components/requestBodies/CreateOrgExport"},"responses":{"202":{"$ref":"#/components/responses/CreateExport"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/500"}},"security":[{"TokenAuth":[]}],"summary":"Start an export","tags":["Export"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15"],"x-snyk-api-resource":"export","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-stability-level":"stable"}},"/orgs/{org_id}/export/{export_id}":{"get":{"description":"Get an export results\n\n#### Required permissions\n\n- `View Organization reports (org.report.read)`","operationId":"getExport","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/orgId"},{"$ref":"#/components/parameters/exportId"}],"responses":{"200":{"$ref":"#/components/responses/GetExport"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"security":[{"TokenAuth":[]}],"summary":"Get export results","tags":["Export"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15"],"x-snyk-api-resource":"export","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-stability-level":"stable"}},"/orgs/{org_id}/inventory/assets":{"get":{"description":"Retrieves a polymorphic list of all asset types for a given organization.\nThe group and tenant are resolved from the org_id.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"listAssetsOrg","parameters":[{"description":"The unique identifier of the organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"$ref":"#/components/parameters/RsqlFilter"},{"description":"Comma-separated sort fields. Prefix with `-` for descending order.","example":"-created_at","in":"query","name":"sort","schema":{"type":"string"}},{"description":"Number of results to return per page","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}},{"$ref":"#/components/parameters/SparseFieldsets"},{"$ref":"#/components/parameters/MetaCount"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AssetListResponse"}}},"description":"Successful response with a polymorphic list of assets","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"summary":"List or search all assets (synchronous) - Org scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"},"patch":{"description":"Partially updates multiple assets within an org context.\nMaximum of 100 assets can be updated per request.\nThe operation is transactional - all updates succeed or all fail.\n\n#### Required permissions\n\n- `Edit Organization (org.edit)`","operationId":"updateAssetsBulkOrg","parameters":[{"description":"The unique identifier of the organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AssetBulkPatchRequestBody"}}},"required":true},"responses":{"204":{"description":"Assets updated successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Bulk update asset attributes - Org scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/inventory/assets/filters":{"get":{"description":"Returns a list of valid field names that can be used for filtering assets using RSQL.\nEach field includes its name, data type, and which asset types it applies to.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getFilterFieldsOrg","parameters":[{"description":"The unique identifier of the organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Comma-separated list of asset types to filter the available filter fields","example":"container_images","in":"query","name":"asset_types","schema":{"type":"string"}},{"description":"Number of results to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/FilterFieldsResponse"}}},"description":"List of available filter fields","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get available filter fields - Org scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/inventory/assets/filters/{filter_id}/values":{"get":{"description":"Returns a list of distinct values for a specific filter field.\nUseful for building autocomplete functionality in filter UIs.\n\nUse the UUID from the filter fields list endpoint to identify which field to query.\n\nFor object filter values, both the keys and values are returned.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getFilterValuesOrg","parameters":[{"description":"The unique identifier of the organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"The UUID of the filter field to get values for (from the filter fields list endpoint)","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","in":"path","name":"filter_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Full text search term to filter the list of values. If keys_only is true, this will filter the keys of the object filter values. If key is provided, this will filter the value for the specific key of the object filter values.","example":"prod","in":"query","name":"q","schema":{"maxLength":100,"type":"string"}},{"description":"Number of results to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}},{"description":"Return only the keys of the object filter values","in":"query","name":"keys_only","schema":{"type":"boolean"}},{"description":"Return only the value for a specific key of the object filter values","in":"query","name":"key","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/FilterValuesResponse"}}},"description":"List of filter values","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get filter value suggestions (autocomplete) - Org scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/inventory/assets/groups":{"get":{"description":"Returns a list of valid group field names that can be used for grouping assets within an org context.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getGroupFieldsOrg","parameters":[{"description":"The unique identifier of the organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Comma-separated list of asset types to filter group fields","in":"query","name":"asset_types","schema":{"type":"string"}},{"description":"Maximum number of results to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for forward pagination","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for backward pagination","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GroupFieldsResponse"}}},"description":"List of available group fields","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get available group fields - Org scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/inventory/assets/groups/{group_field_id}/values":{"get":{"description":"Returns aggregated values for a specific group field id, showing the count of assets\nfor each distinct value.\n\nUse the UUID from the group fields list endpoint to identify which field to query.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getGroupValuesOrg","parameters":[{"description":"The unique identifier of the organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"The UUID of the group field to get values for (from the group fields list endpoint)","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","in":"path","name":"group_field_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Comma-separated list of asset types to filter the aggregation","example":"container_images","in":"query","name":"asset_types","schema":{"type":"string"}},{"$ref":"#/components/parameters/RsqlFilterGroupValues"},{"$ref":"#/components/parameters/SortGroupValues"},{"description":"Maximum number of group values to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for forward pagination","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for backward pagination","in":"query","name":"ending_before","schema":{"type":"string"}},{"$ref":"#/components/parameters/MetaFieldsGroupValues"},{"$ref":"#/components/parameters/AggregateGroupValues"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GroupValuesResponse"}}},"description":"List of group values with aggregated metadata","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get group value aggregation - Org scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/inventory/assets/searches":{"post":{"description":"Initiates an asynchronous search for assets within an org context.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"createAssetSearchOrg","parameters":[{"description":"The unique identifier of the organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateSearchRequestBody"}}}},"responses":{"302":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"jsonapi":{"additionalProperties":false,"properties":{"version":{"type":"string"}},"type":"object"}},"type":"object"}}},"description":"Found - Redirects to search results endpoint","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"description":"URL to retrieve search results","schema":{"format":"uri","type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create an asset search (asynchronous) - Org scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/inventory/assets/searches/{search_id}/results":{"get":{"description":"Gets paginated results for a previously initiated asset search within an org context.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getAssetSearchResultsOrg","parameters":[{"description":"The unique identifier of the organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/SearchId"},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Sort order for results (e.g., -created_at for descending)","in":"query","name":"sort","schema":{"type":"string"}},{"description":"Maximum number of results to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for forward pagination","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for backward pagination","in":"query","name":"ending_before","schema":{"type":"string"}},{"$ref":"#/components/parameters/SparseFieldsets"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AssetListResponse"}}},"description":"Search results retrieved successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Retrieve asset search results (asynchronous) - Org scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/inventory/assets/{asset_id}":{"get":{"description":"Retrieves a single asset by its unique identifier within an org context.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getAssetOrg","parameters":[{"description":"The unique identifier of the organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the asset","in":"path","name":"asset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"$ref":"#/components/parameters/SparseFieldsets"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/PolymorphicAssetData"},"links":{"properties":{"self":{"format":"uri","type":"string"}},"type":"object"}},"required":["data"],"type":"object"}}},"description":"Asset retrieved successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a single asset by ID - Org scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"},"patch":{"description":"Partially updates an asset's attributes within an org context.\nSupports updating class, labels (add/remove), and tags (add/remove).\n\n#### Required permissions\n\n- `Edit Organization (org.edit)`","operationId":"updateAssetOrg","parameters":[{"description":"The unique identifier of the organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the asset","in":"path","name":"asset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AssetPatchRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/PolymorphicAssetData"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"},"links":{"description":"Self-referencing link","properties":{"self":{"description":"Link to the current resource","format":"uri","type":"string"}},"required":["self"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Asset updated successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update asset attributes - Org scope (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/inventory/assets/{asset_id}/relationships/projects":{"get":{"description":"Retrieves a paginated list of Snyk projects linked to this asset with full attributes.\nReturns the `id`, `type`, and `attributes` of each related project.\nScoped to the specified organization.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"listAssetProjectsOrg","parameters":[{"description":"The unique identifier of the organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the asset","in":"path","name":"asset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}},{"description":"Maximum number of results to return per page","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Filter projects by canonical status.\n- `with`: Returns all projects (canonical attribute is populated).\n- `only`: Returns only canonical projects (those used for vulnerability counts).\n- `none`: Returns only non-canonical projects.\nWhen omitted, returns all projects without canonical filtering.\n","in":"query","name":"canonical","schema":{"enum":["with","only","none"],"type":"string"}},{"description":"Filter projects by target ID. When provided, returns only projects that belong to\nthe specified target. When omitted, returns projects from all targets.\n","in":"query","name":"target_id","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ProjectRelationshipListResponse"}}},"description":"Successfully retrieved linked projects","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"List projects for an asset (org scope) (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"project","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/inventory/assets/{asset_id}/relationships/targets":{"get":{"description":"Retrieves a paginated list of Snyk targets linked to this asset with full attributes.\nReturns the `id`, `type`, and `attributes` of each related target.\nScoped to the specified organization.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"listAssetTargetsOrg","parameters":[{"description":"The unique identifier of the organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the asset","in":"path","name":"asset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}},{"description":"Maximum number of results to return per page","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/TargetRelationshipListResponse"}}},"description":"Successfully retrieved linked targets","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"List targets for an asset (org scope) (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"target","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/invites":{"get":{"description":"List pending user invitations to an organization.\n\n#### Required permissions\n\n- `View Organization (org.read)`\n\n- `View users (org.user.read)`","operationId":"listOrgInvitation","parameters":[{"description":"The id of the org the user is being invited to","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/OrgInvitation"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"List of pending invitations to an organization.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"List pending user invitations to an organization.","tags":["Invites"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-11-14"],"x-snyk-api-resource":"org_invitations","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-11-14","x-stability-level":"stable"},"post":{"description":"Invite a user to an organization with a role.\n\n#### Required permissions\n\n- `Invite users (org.user.invite)`","operationId":"createOrgInvitation","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the org the user is being invited to","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/OrgInvitationPostData"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/OrgInvitation20240621"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A new organization invitation has been created","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Invite a user to an organization","tags":["Invites"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-06-01","2023-04-28","2024-06-21"],"x-snyk-api-resource":"org_invitations","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-06-21","x-stability-level":"stable"}},"/orgs/{org_id}/invites/{invite_id}":{"delete":{"description":"Cancel a pending user invitations to an organization.\n\n#### Required permissions\n\n- `Invite users (org.user.invite)`","operationId":"deleteOrgInvitation","parameters":[{"description":"The id of the org the user is being invited to","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the pending invite to cancel","in":"path","name":"invite_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Cancel a pending user invitations to an organization.","tags":["Invites"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-11-14"],"x-snyk-api-resource":"org_invitations","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-11-14","x-stability-level":"stable"}},"/orgs/{org_id}/issues":{"get":{"description":"Get a list of an organization's issues.\n\n#### Required permissions\n\n- `View Organization (org.read)`\n\n- `View Projects (org.project.read)`\n\n- `View Project history (org.project.snapshot.read)`","operationId":"listOrgIssues","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"example":"4a18d42f-0706-4ad0-b127-24078731fbed","format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ScanItemId"},{"$ref":"#/components/parameters/ScanItemType"},{"$ref":"#/components/parameters/Type"},{"description":"A filter to select issues updated before this date.","in":"query","name":"updated_before","schema":{"format":"date-time","type":"string"}},{"description":"A filter to select issues updated after this date.","in":"query","name":"updated_after","schema":{"format":"date-time","type":"string"}},{"description":"A filter to select issues created before this date.","in":"query","name":"created_before","schema":{"format":"date-time","type":"string"}},{"description":"A filter to select issues created after this date.","in":"query","name":"created_after","schema":{"format":"date-time","type":"string"}},{"$ref":"#/components/parameters/EffectiveSeverityLevel"},{"$ref":"#/components/parameters/Status"},{"$ref":"#/components/parameters/Ignored"}],"responses":{"200":{"$ref":"#/components/responses/ListIssues200"},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"403":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Get issues by org ID","tags":["Issues"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-03-10~experimental","2023-09-29~beta","2024-01-23"],"x-snyk-api-resource":"issues","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-01-23","x-stability-level":"stable"}},"/orgs/{org_id}/issues/{issue_id}":{"get":{"description":"Get an issue\n\n#### Required permissions\n\n- `View Organization (org.read)`\n\n- `View Projects (org.project.read)`\n\n- `View Project history (org.project.snapshot.read)`","operationId":"getOrgIssueByIssueID","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"example":"4a18d42f-0706-4ad0-b127-24078731fbed","format":"uuid","type":"string"}},{"$ref":"#/components/parameters/PathIssueId20240123"}],"responses":{"200":{"$ref":"#/components/responses/GetIssue20020240123"},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"403":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token or a token with more permissions.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"409":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Conflict: The requested operation conflicts with the current state of the resource in some way.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","example":"2021-07-01T00:00:00Z","schema":{"format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","schema":{"format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","example":"2021-06-04","schema":{"description":"Requested API version","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","example":"2021-06-04","schema":{"description":"Resolved API version","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Get an issue","tags":["Issues"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-01-23"],"x-snyk-api-resource":"issues","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-01-23","x-stability-level":"stable"}},"/orgs/{org_id}/jobs/export/{export_id}":{"get":{"description":"Get an export job status\n\n#### Required permissions\n\n- `View Organization reports (org.report.read)`","operationId":"getExportJobStatus","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/orgId"},{"$ref":"#/components/parameters/exportId"}],"responses":{"200":{"$ref":"#/components/responses/GetExportJob"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"security":[{"TokenAuth":[]}],"summary":"Get export status","tags":["Export"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15"],"x-snyk-api-resource":"export","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-stability-level":"stable"}},"/orgs/{org_id}/learn/assignments":{"delete":{"deprecated":true,"description":"Allows an admin to delete multiple assignments within their organization.\n\n**Note**: Assignments that are part of a Learning Program cannot be deleted through this endpoint.\n\n#### Required permissions\n\n- `Delete assignments (org.learn_assignment.delete)`","operationId":"deleteOrgAssignments","parameters":[{"description":"The unique identifier of the organization.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ApiVersion"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/DeleteAssignmentsRequest"}}},"required":true},"responses":{"204":{"description":"Assignments were successfully deleted.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Conflict - The assignment cannot be deleted because it is part of a Learning Program.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"500":{"$ref":"#/components/responses/500"}},"summary":"Bulk deletion of assignments in an organization (Early Access)","tags":["Learn assignment"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-13~beta"],"x-snyk-api-resource":"assignments","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-13~beta","x-snyk-deprecated-by":"2024-10-15~beta","x-snyk-documentation":{"category":"learn"},"x-stability-level":"beta"},"get":{"description":"Allows an admin to obtain a comprehensive list of all assignments within their organization.\n\n#### Required permissions\n\n- `View Organization assignments (org.learn_assignment.read)`","operationId":"listOrgAssignments","parameters":[{"description":"The unique identifier of the organization.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ApiVersion"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LessonAssignmentDecoratedResource"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["jsonapi","links","data"],"type":"object"}}},"description":"A list of assignments was successfully retrieved.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Retrieve a list of assignments for an organization (Early Access)","tags":["Learn assignment"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-13~beta"],"x-snyk-api-resource":"assignments","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-13~beta","x-snyk-documentation":{"category":"learn"},"x-stability-level":"beta"},"patch":{"description":"Allows an admin to update the due date for existing assignments within their organization.\n\n#### Required permissions\n\n- `Edit assignments (org.learn_assignment.edit)`","operationId":"updateOrgAssignments","parameters":[{"description":"The unique identifier of the organization.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ApiVersion"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/UpdateAssignmentsPayload"},"id":{"format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}},"required":true},"responses":{"204":{"description":"Assignments due date was successfully updated.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update due date for assignments in an organization. (Early Access)","tags":["Learn assignment"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"assignments","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-snyk-documentation":{"category":"learn"},"x-stability-level":"beta"},"post":{"description":"Allows an admin to create assignments in bulk for all or a subset of users within their organization.\n\n#### Required permissions\n\n- `Create assignments (org.learn_assignment.create)`","operationId":"createOrgAssignments","parameters":[{"description":"The unique identifier of the organization.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ApiVersion"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateAssignmentsPayload"}}},"required":true},"responses":{"204":{"description":"Assignments were successfully created.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Bulk creation of assignments for users in an organization. (Early Access)","tags":["Learn assignment"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-14~experimental","2024-10-15~beta"],"x-snyk-api-resource":"assignments","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-snyk-documentation":{"category":"learn"},"x-stability-level":"beta"}},"/orgs/{org_id}/learn/assignments/bulk_delete":{"post":{"description":"Allows an admin to delete multiple assignments within their organization.\n\n**Note**: Assignments that are part of a Learning Program cannot be deleted through this endpoint.\n\n#### Required permissions\n\n- `Delete assignments (org.learn_assignment.delete)`","operationId":"deleteOrgAssignmentsBulk","parameters":[{"description":"The unique identifier of the organization.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ApiVersion"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/DeleteOrgAssignmentsBulkRequest"}}},"required":true},"responses":{"204":{"description":"Assignments were successfully deleted.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorDocument"}}},"description":"Conflict - The assignment cannot be deleted because it is part of a Learning Program.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"500":{"$ref":"#/components/responses/500"}},"summary":"Bulk deletion of assignments in an organization (Early Access)","tags":["Learn assignment"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"assignments","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-snyk-documentation":{"category":"learn"},"x-stability-level":"beta"}},"/orgs/{org_id}/learn/progress/catalog":{"get":{"description":"Retrieves aggregated counts of users' lesson or learning path statuses (completed, in progress, todo) across all catalog resources for an organization.\n\n#### Required permissions\n\n- `View Organization Snyk Learn Reports (org.learn_report.read)`","operationId":"getCatalogProgress","parameters":[{"description":"The unique identifier of the organization.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ApiVersion"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"Filter by the learn catalog resource type","in":"query","name":"type","schema":{"default":"lesson","enum":["learning_path","lesson"],"type":"string"}},{"$ref":"#/components/parameters/Title"},{"$ref":"#/components/parameters/Cwes"},{"$ref":"#/components/parameters/Cves"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CatalogProgressResponse"}}},"description":"Organization reporting users overview","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get collective learning progress (Early Access)","tags":["Learn progress"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"progress","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-snyk-documentation":{"category":"learn"},"x-stability-level":"beta"}},"/orgs/{org_id}/learn/progress/users":{"get":{"description":"Retrieves detailed learning progress status per user, including completion dates and history for each catalog resource.\n\n#### Required permissions\n\n- `View Organization Snyk Learn Reports (org.learn_report.read)`","operationId":"getUsersProgress","parameters":[{"description":"The unique identifier of the organization.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ApiVersion"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"Filter by the learn catalog resource type","in":"query","name":"type","schema":{"default":"lesson","enum":["learning_path","lesson"],"type":"string"}},{"$ref":"#/components/parameters/Title"},{"$ref":"#/components/parameters/Titles"},{"description":"Filter by progress status of the resources","in":"query","name":"status","schema":{"enum":["completed","inProgress"],"type":"string"}},{"$ref":"#/components/parameters/Emails"},{"$ref":"#/components/parameters/CompletionInterval"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UsersProgressResponse"}}},"description":"Organization reporting users overview","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get individual user learning progress (Early Access)","tags":["Learn progress"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"progress","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-snyk-documentation":{"category":"learn"},"x-stability-level":"beta"}},"/orgs/{org_id}/memberships":{"get":{"description":"Returns all memberships of the org\n\n#### Required permissions\n\n- `View Organization Memberships (org.membership.read)`","operationId":"listOrgMemberships","parameters":[{"description":"The ID of the org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Version"},{"description":"Which column to sort by.","in":"query","name":"sort_by","schema":{"enum":["username","user_display_name","email","login_method","role"],"type":"string"}},{"description":"Order in which results are returned.","example":"ASC","in":"query","name":"sort_order","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}},{"$ref":"#/components/parameters/EmailFilter"},{"$ref":"#/components/parameters/UserIdFilter"},{"$ref":"#/components/parameters/UsernameFilter"},{"$ref":"#/components/parameters/RoleFilter"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OrgMembershipResponseData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"List of org memberships is returned","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get all memberships of the org","tags":["Orgs"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-05-09~experimental","2024-08-25"],"x-snyk-api-resource":"orgs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-08-25","x-stability-level":"stable"},"post":{"description":"Create a org membership for a user with role\n\n#### Required permissions\n\n- `Add Organization Memberships (org.membership.add)`","operationId":"createOrgMembership","parameters":[{"description":"The ID of the org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateOrgMembershipRequestBody20240825"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OrgMembership"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"Membership for the user is created on the org","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create a org membership for a user with role","tags":["Orgs"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-05-09~experimental","2024-08-25"],"x-snyk-api-resource":"orgs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-08-25","x-stability-level":"stable"}},"/orgs/{org_id}/memberships/{membership_id}":{"delete":{"description":"Remove a user's membership of the group.\n\n#### Required permissions\n\n- `Delete Organization Memberships (org.membership.delete)`","operationId":"deleteOrgMembership","parameters":[{"description":"The id of the org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/OrgMembershipId"},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"description":"Org membership for the user was successfully deleted.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Remove user's org membership","tags":["Orgs"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-06-06~experimental","2024-08-25"],"x-snyk-api-resource":"org_memberships","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-08-25","x-stability-level":"stable"},"patch":{"description":"Update a org membership for a user with role\n\n#### Required permissions\n\n- `Edit Organization Memberships (org.membership.edit)`","operationId":"updateOrgMembership","parameters":[{"description":"The id of the org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/OrgMembershipId"},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/UpdateOrgMembershipRequestBody20240825"}},"required":["data"],"type":"object"}}}},"responses":{"204":{"description":"The Membership is updated","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update a org membership for a user with role","tags":["Orgs"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-06-06~experimental","2024-08-25"],"x-snyk-api-resource":"org_memberships","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-08-25","x-stability-level":"stable"}},"/orgs/{org_id}/packages/issues":{"post":{"description":"This endpoint is currently restricted and is not available to all customers. Query issues for a batch of packages identified by Package URL (purl). Only direct vulnerabilities are returned; transitive vulnerabilities (from dependencies) are not included as they can vary depending on the context.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"listIssuesForManyPurls","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Unique identifier for an organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BulkPackageUrlsRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IssuesWithPurlsResponse"}}},"description":"Returns an array of issues with the purl identifier of the package that caused them","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/Location"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"List issues for a given set of packages (Currently not available to all customers)","tags":["Issues"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-01-04~experimental","2023-03-29~beta","2023-04-17","2023-08-21","2024-06-26","2025-11-05"],"x-snyk-api-resource":"issues","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-06-26","x-snyk-deprecated-by":"2025-11-05","x-snyk-sunset-eligible":"2026-05-05","x-stability-level":"stable"}},"/orgs/{org_id}/packages/{purl}/issues":{"get":{"description":"Query issues for a specific package version identified by Package URL (purl). Snyk returns only direct vulnerabilities. Transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"fetchIssuesPerPurl","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/PackageUrl"},{"description":"Unique identifier for an organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Specify the number of results to skip before returning results. Must be greater than or equal to 0. Default is 0.","in":"query","name":"offset","schema":{"type":"number"}},{"description":"Specify the number of results to return. Must be greater than 0 and less than 1000. Default is 1000.","in":"query","name":"limit","schema":{"type":"number"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IssuesResponse"}}},"description":"Returns an array of issues","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"List issues for a package","tags":["Issues"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-06-29~beta","2022-09-15","2024-06-26","2025-11-05"],"x-snyk-api-resource":"issues","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-06-26","x-snyk-deprecated-by":"2025-11-05","x-snyk-sunset-eligible":"2026-05-05","x-stability-level":"stable"}},"/orgs/{org_id}/policies":{"get":{"description":"Get all policies for the requested organisation.\n\n*Org level Policy APIs Access Notice:* Org level Policy APIs are only available \nfor use with Code Consistent Ignores. For information about how to enable Code Consistent Ignores \nsee [this](https://docs.snyk.io/manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code#enable-snyk-code-consistent-ignores) \ndocumentation.\n\n#### Required permissions\n\n- `View Ignores (org.project.ignore.read)`","operationId":"getOrgPolicies","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Search"},{"$ref":"#/components/parameters/OrderBy"},{"$ref":"#/components/parameters/OrderDirection"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Review"},{"description":"Select only policies with an expiry strictly before the given time.","in":"query","name":"expires_before","schema":{"example":"2024-03-16T00:00:00Z","format":"date-time","type":"string"}},{"description":"Select only policies with an expiry strictly past the given time.","in":"query","name":"expires_after","schema":{"example":"2024-03-16T00:00:00Z","format":"date-time","type":"string"}},{"description":"Select only policies that never expire.","in":"query","name":"expires_never","schema":{"example":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/PolicyResponse"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["jsonapi","data"],"type":"object"}}},"description":"The policies for the requested organisation.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"summary":"Get org-level policies","tags":["Policies"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15"],"x-snyk-api-resource":"policies","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-stability-level":"stable"},"post":{"description":"Create a new org-level policy.\n\n*Org level Policy APIs Access Notice:* Org level Policy APIs are only available \nfor use with Code Consistent Ignores. For information about how to enable Code Consistent Ignores \nsee [this](https://docs.snyk.io/manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code#enable-snyk-code-consistent-ignores) \ndocumentation.\n\n#### Required permissions\n\n- `Create Ignores (org.project.ignore.create)`","operationId":"createOrgPolicy","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreatePolicyPayload"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/PolicyResponse"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A single policy is returned if it is successfully created.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create a new org-level policy","tags":["Policies"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15"],"x-snyk-api-resource":"policies","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-stability-level":"stable"}},"/orgs/{org_id}/policies/{policy_id}":{"delete":{"description":"Delete an existing org-level policy.\n\n*Org level Policy APIs Access Notice:* Org level Policy APIs are only available \nfor use with Code Consistent Ignores. For information about how to enable Code Consistent Ignores \nsee [this](https://docs.snyk.io/manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code#enable-snyk-code-consistent-ignores) \ndocumentation.\n\n#### Required permissions\n\n- `Remove Ignores (org.project.ignore.delete)`","operationId":"deleteOrgPolicy","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/PolicyId"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete an org-level policy","tags":["Policies"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15"],"x-snyk-api-resource":"policies","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-stability-level":"stable"},"get":{"description":"Get a specific org-level policy based on its ID.\n\n*Org level Policy APIs Access Notice:* Org level Policy APIs are only available \nfor use with Code Consistent Ignores. For information about how to enable Code Consistent Ignores \nsee [this](https://docs.snyk.io/manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code#enable-snyk-code-consistent-ignores) \ndocumentation.\n\n#### Required permissions\n\n- `View Ignores (org.project.ignore.read)`","operationId":"getOrgPolicy","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/PolicyId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/PolicyResponse"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"The requested policy.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"summary":"Get an org-level policy","tags":["Policies"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15"],"x-snyk-api-resource":"policies","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-stability-level":"stable"},"patch":{"description":"Update the org-level policy. \n\n*Org level Policy APIs Access Notice:* Org level Policy APIs are only available \nfor use with Code Consistent Ignores. For information about how to enable Code Consistent Ignores \nsee [this](https://docs.snyk.io/manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code#enable-snyk-code-consistent-ignores) \ndocumentation.\n\n#### Required permissions\n\n- `Edit Ignores (org.project.ignore.edit)`","operationId":"updateOrgPolicy","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/PolicyId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdatePolicyPayload"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/PolicyResponse"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A single policy is returned if it is successfully updated.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"}},"summary":"Update an org-level policy","tags":["Policies"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15"],"x-snyk-api-resource":"policies","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-stability-level":"stable"}},"/orgs/{org_id}/policies/{policy_id}/events":{"get":{"description":"Retrieve the event history for the given policy.\n\n*Org level Policy APIs Access Notice:* Access to our Org level Policy APIs is currently\nrestricted via \"snykCodeConsistentIgnores\" and \"ignoreApprovalWorkflow\" feature flags\nand will result in a 403 Forbidden error without the flag enabled. Please contact your\naccount representative for eligibility requirements.\n\n#### Required permissions\n\n- `View Ignores (org.project.ignore.read)`","operationId":"getOrgPolicyEvents","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/PolicyId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/PolicyEventResponse"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["jsonapi","data"],"type":"object"}}},"description":"The requested policy.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"summary":"List org policy events (Early Access)","tags":["Policies"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-13~beta"],"x-snyk-api-resource":"policyevents","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-13~beta","x-stability-level":"beta"}},"/orgs/{org_id}/projects":{"get":{"description":"List all Projects for an Org.\n\n#### Required permissions\n\n- `View Projects (org.project.read)`","operationId":"listOrgProjects","parameters":[{"description":"The ID of the org that the projects belong to.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Return projects that belong to the provided targets","in":"query","name":"target_id","schema":{"items":{"format":"uuid","type":"string"},"type":"array"}},{"description":"Return projects that match the provided target reference","in":"query","name":"target_reference","schema":{"type":"string"}},{"description":"Return projects that match the provided target file","in":"query","name":"target_file","schema":{"type":"string"}},{"description":"Return projects that match the provided target runtime","in":"query","name":"target_runtime","schema":{"type":"string"}},{"description":"The collection count.","in":"query","name":"meta_count","schema":{"enum":["only"],"type":"string"}},{"description":"Return projects that match the provided IDs.","explode":false,"in":"query","name":"ids","schema":{"items":{"format":"uuid","type":"string"},"type":"array"},"style":"form"},{"description":"Return projects that match the provided names.","explode":false,"in":"query","name":"names","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Return projects with names starting with the specified prefix.","explode":false,"in":"query","name":"names_start_with","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Return projects that match the provided origins.","explode":false,"in":"query","name":"origins","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Return projects that match the provided types.","explode":false,"in":"query","name":"types","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Expand relationships.","explode":false,"in":"query","name":"expand","schema":{"items":{"enum":["target"],"type":"string"},"type":"array"},"style":"form"},{"description":"Include a summary count for the issues found in the most recent scan of this project","in":"query","name":"meta.latest_issue_counts","schema":{"type":"boolean"}},{"description":"Include the total number of dependencies found in the most recent scan of this project","in":"query","name":"meta.latest_dependency_total","schema":{"type":"boolean"}},{"description":"Filter projects uploaded and monitored before this date (encoded value)","example":"2021-05-29T09:50:54.014Z","in":"query","name":"cli_monitored_before","schema":{"format":"date-time","type":"string"}},{"description":"Filter projects uploaded and monitored after this date (encoded value)","example":"2021-05-29T09:50:54.014Z","in":"query","name":"cli_monitored_after","schema":{"format":"date-time","type":"string"}},{"description":"Return projects that match the provided importing user public ids.","explode":false,"in":"query","name":"importing_user_public_id","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Return projects that match all the provided tags","example":["key1:value1","key2:value2"],"explode":false,"in":"query","name":"tags","schema":{"items":{"pattern":"^[a-zA-Z0-9_-]+:[:/?#@\u0026+=%a-zA-Z0-9_.~-]+$","type":"string"},"type":"array"},"style":"form"},{"description":"Return projects that match all the provided business_criticality value","explode":false,"in":"query","name":"business_criticality","schema":{"items":{"enum":["critical","high","medium","low"],"type":"string"},"type":"array"},"style":"form"},{"description":"Return projects that match all the provided environment values","explode":false,"in":"query","name":"environment","schema":{"items":{"enum":["frontend","backend","internal","external","mobile","saas","onprem","hosted","distributed"],"type":"string"},"type":"array"},"style":"form"},{"description":"Return projects that match all the provided lifecycle values","explode":false,"in":"query","name":"lifecycle","schema":{"items":{"enum":["production","development","sandbox"],"type":"string"},"type":"array"},"style":"form"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ProjectAttributes"},"id":{"description":"Resource ID.","format":"uuid","type":"string"},"meta":{"additionalProperties":false,"properties":{"cli_monitored_at":{"description":"The date that the project was last uploaded and monitored using cli.","example":"2021-05-29T09:50:54.014Z","format":"date-time","nullable":true,"type":"string"},"latest_dependency_total":{"$ref":"#/components/schemas/LatestDependencyTotal"},"latest_issue_counts":{"$ref":"#/components/schemas/LatestIssueCounts"}},"type":"object"},"relationships":{"$ref":"#/components/schemas/ProjectRelationships"},"type":{"description":"The Resource type.","example":"project","type":"string"}},"required":["id","type","attributes"],"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"properties":{"count":{"minimum":0,"type":"number"}},"type":"object"}},"required":["jsonapi","links"],"type":"object"}}},"description":"A list of projects is returned for the targeted org","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"List all Projects for an Org with the given Org ID.","tags":["Projects"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2021-06-04~beta","2022-08-12~experimental","2022-12-21~experimental","2023-02-15","2023-08-28","2023-09-11","2023-11-06","2024-05-31"],"x-snyk-api-resource":"projects","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-31","x-stability-level":"stable"}},"/orgs/{org_id}/projects/{project_id}":{"delete":{"description":"Delete one project in the organization by project ID.\n\n#### Required permissions\n\n- `View Organization (org.read)`\n\n- `View Projects (org.project.read)`\n\n- `Remove Projects (org.project.delete)`","operationId":"deleteOrgProject","parameters":[{"description":"The ID of the org to which the project belongs to.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The ID of the project.","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"description":"The project has been deleted","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete project by project ID.","tags":["Projects"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-11-06","2024-05-31"],"x-snyk-api-resource":"projects","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-31","x-stability-level":"stable"},"get":{"description":"Get one project of the organization by project ID.\n\n#### Required permissions\n\n- `View Projects (org.project.read)`","operationId":"getOrgProject","parameters":[{"description":"The ID of the org to which the project belongs to.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The ID of the project.","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Expand relationships.","explode":false,"in":"query","name":"expand","schema":{"items":{"enum":["target"],"type":"string"},"type":"array"},"style":"form"},{"description":"Include a summary count for the issues found in the most recent scan of this project","in":"query","name":"meta.latest_issue_counts","schema":{"type":"boolean"}},{"description":"Include the total number of dependencies found in the most recent scan of this project","in":"query","name":"meta.latest_dependency_total","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ProjectAttributes"},"id":{"description":"The Resource ID.","format":"uuid","type":"string"},"meta":{"additionalProperties":false,"properties":{"cli_monitored_at":{"description":"The date that the project was last uploaded and monitored using cli.","example":"2021-05-29T09:50:54.014Z","format":"date-time","nullable":true,"type":"string"},"latest_dependency_total":{"$ref":"#/components/schemas/LatestDependencyTotal"},"latest_issue_counts":{"$ref":"#/components/schemas/LatestIssueCounts"}},"type":"object"},"relationships":{"$ref":"#/components/schemas/ProjectRelationships"},"type":{"description":"The Resource type.","example":"project","type":"string"}},"required":["id","type","attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A project is returned for the targeted org","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get project by project ID.","tags":["Projects"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-02-01~experimental","2022-08-12~experimental","2022-12-21~experimental","2023-02-15","2023-08-28","2023-09-11","2023-11-06","2024-05-31"],"x-snyk-api-resource":"projects","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-31","x-stability-level":"stable"},"patch":{"description":"Updates one project of the organization by project ID.\n\n#### Required permissions\n\n- `View Organization (org.read)`\n\n- `View Projects (org.project.read)`\n\n- `Edit Projects (org.project.edit)`","operationId":"updateOrgProject","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The ID of the Org the project belongs to.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The ID of the project to patch.","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Expand relationships.","explode":false,"in":"query","name":"expand","schema":{"items":{"enum":["target"],"type":"string"},"type":"array"},"style":"form"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/PatchProjectRequest"}}},"description":"The project attributes to be updated."},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/ProjectAttributes"},"id":{"description":"The Resource ID.","example":"331ede0a-de94-456f-b788-166caeca58bf","format":"uuid","type":"string"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"additionalProperties":false,"properties":{"cli_monitored_at":{"description":"The date that the project was last uploaded and monitored using cli.","example":"2021-05-29T09:50:54.014Z","format":"date-time","nullable":true,"type":"string"}},"type":"object"},"relationships":{"$ref":"#/components/schemas/ProjectRelationships"},"type":{"description":"The Resource type.","example":"project","type":"string"}},"required":["type","id","attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A project is updated for the targeted org","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Updates project by project ID.","tags":["Projects"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-12-21~experimental","2023-02-15","2023-08-28","2023-09-11","2023-11-06","2024-05-31"],"x-snyk-api-resource":"projects","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-31","x-stability-level":"stable"}},"/orgs/{org_id}/projects/{project_id}/sbom":{"get":{"description":"This endpoint lets you retrieve the SBOM document of a software project.\nIt supports the following formats:\n* CycloneDX version 1.6 in JSON (set `format` to `cyclonedx1.6+json`).\n* CycloneDX version 1.6 in XML (set `format` to `cyclonedx1.6+xml`).\n* CycloneDX version 1.5 in JSON (set `format` to `cyclonedx1.5+json`).\n* CycloneDX version 1.5 in XML (set `format` to `cyclonedx1.5+xml`).\n* CycloneDX version 1.4 in JSON (set `format` to `cyclonedx1.4+json`).\n* CycloneDX version 1.4 in XML (set `format` to `cyclonedx1.4+xml`).\n* SPDX version 2.3 in JSON (set `format` to `spdx2.3+json`).\n\nBy default it will respond with an empty JSON:API response.\n\n#### Required permissions\n\n- `View Project history (org.project.snapshot.read)`","operationId":"getSbom","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Unique identifier for an organization","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Unique identifier for a project","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Format"},{"$ref":"#/components/parameters/Exclude"},{"$ref":"#/components/parameters/GoModuleLevel"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SbomDocument"}},"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SbomResponse"}},"application/vnd.cyclonedx+json":{"schema":{"$ref":"#/components/schemas/SbomDocument"}},"application/vnd.cyclonedx+xml":{"schema":{"$ref":"#/components/schemas/SbomDocument"}}},"description":"Returns the SBOM document of a project","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a project’s SBOM document","tags":["SBOM"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-03-31~experimental","2022-12-06~beta","2023-03-20","2024-03-12~experimental","2024-08-15~beta","2024-08-22"],"x-snyk-api-resource":"sboms","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-08-22","x-stability-level":"stable"}},"/orgs/{org_id}/sbom_tests":{"post":{"description":"Create an SBOM test run by supplying an SBOM document. The components contained in the given document will get analyzed for known vulnerabilities. In order for component identification to be successful, they must have a PackageURL (purl) of a supported purl type assigned. Analysis will be skipped for any component that does not fulfill this requirement.\nSupported SBOM formats: CycloneDX 1.4 JSON, CycloneDX 1.5 JSON, CycloneDX 1.6 JSON, SPDX 2.3 JSON\nSupported purl types: apk, cargo, cocoapods, composer, conan, deb, gem, generic, golang, hex, maven, npm, nuget, pub, pypi, rpm, swift\n\n#### Required permissions\n\n- `Test Projects (org.project.test)`","operationId":"createSbomTestRun","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/SbomTestCreateAttributes"},"type":{"$ref":"#/components/schemas/Types"}},"required":["type"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"SBOM test resource object","properties":{"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"Created SBOM test successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create an SBOM test run (Early Access)","tags":["SBOM"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-02~experimental","2023-08-31~beta","2024-04-22~beta","2024-07-10~beta"],"x-snyk-api-resource":"sbom_tests","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-07-10~beta","x-stability-level":"beta"}},"/orgs/{org_id}/sbom_tests/{job_id}":{"get":{"description":"Get an SBOM test run status\n\n#### Required permissions\n\n- `Test Projects (org.project.test)`","operationId":"getSbomTestStatus","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/JobId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"description":"SBOM test resource object","properties":{"attributes":{"properties":{"status":{"enum":["processing","error","finished"],"type":"string"}},"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type","attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"SBOM test run status","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Gets an SBOM test run status (Early Access)","tags":["SBOM"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-02~experimental","2023-08-31~beta","2024-04-22~beta","2024-07-10~beta"],"x-snyk-api-resource":"sbom_tests","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-07-10~beta","x-stability-level":"beta"}},"/orgs/{org_id}/sbom_tests/{job_id}/results":{"get":{"description":"Get an SBOM test run result\n\n#### Required permissions\n\n- `Test Projects (org.project.test)`","operationId":"getSbomTestResult","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/JobId"},{"$ref":"#/components/parameters/Accept"}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object"}},"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"description":"SBOM test resource object","properties":{"attributes":{"$ref":"#/components/schemas/SbomTestResultsAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"relationships":{"properties":{"affected_packages":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ResourceReference"},"type":"array"}},"type":"object"}},"type":"object"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type"],"type":"object"},"included":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"SBOM test results","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}}},"summary":"Gets an SBOM test run result (Early Access)","tags":["SBOM"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-02~experimental","2023-08-31~beta","2024-04-22~beta","2024-07-10~beta"],"x-snyk-api-resource":"sbom_tests","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-07-10~beta","x-stability-level":"beta"}},"/orgs/{org_id}/service_accounts":{"get":{"description":"Get all service accounts for an organization.\n\n#### Required permissions\n\n- `View service accounts (org.service_account.read)`","operationId":"getManyOrgServiceAccounts","parameters":[{"description":"The ID of the Snyk Organization that owns the service accounts.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/ServiceAccount"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A list of service accounts is returned.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a list of organization service accounts.","tags":["ServiceAccounts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-09-07"],"x-snyk-api-resource":"service_accounts","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-07","x-stability-level":"stable"},"post":{"description":"Create a service account for an organization. The service account can be used to access the Snyk API.\n\n#### Required permissions\n\n- `Create service accounts (org.service_account.create)`","operationId":"createOrgServiceAccount","parameters":[{"description":"The ID of the Snyk Organization that is creating and will own the service account.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"access_token_expires_at":{"description":"The expiry date of the access token. Required only when auth_type is access_token.","example":"2025-08-16T00:00:00Z","format":"date-time","type":"string"},"access_token_ttl_seconds":{"description":"The time, in seconds, that a generated oauth access token will be valid for. Defaults to 1 hour if unset. Only used when auth_type is one of the oauth_* variants.","maximum":86400,"minimum":3600,"type":"number"},"auth_type":{"description":"The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an oauth access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out in OIDC Connect Core 1.0, section 9.\n * access_token - Access tokens are long-lived, can be used more than once for increased flexibility, and have expiries for enhanced security.","enum":["api_key","oauth_client_secret","oauth_private_key_jwt","access_token"],"type":"string"},"jwks_url":{"description":"A JWKs URL hosting your public keys, used to verify signed JWT requests. Must be https. Required only when auth_type is oauth_private_key_jwt.","type":"string"},"name":{"description":"A human-friendly name for the service account.","type":"string"},"role_id":{"description":"The ID of the role which the created service account should use. Obtained in the Snyk UI, via \"Group Page\" -\u003e \"Settings\" -\u003e \"Member Roles\" -\u003e \"Create new Role\". Can be shared among multiple accounts.","format":"uuid","type":"string"}},"required":["name","role_id","auth_type"],"type":"object"},"type":{"description":"The Resource type.","enum":["service_account"],"type":"string"}},"required":["attributes"],"type":"object"}},"required":["data"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/ServiceAccount"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A new service account has been created","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create a service account for an organization.","tags":["ServiceAccounts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-09-07"],"x-snyk-api-resource":"service_accounts","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-07","x-stability-level":"stable"}},"/orgs/{org_id}/service_accounts/{serviceaccount_id}":{"delete":{"description":"Delete a service account in an organization.\n\n#### Required permissions\n\n- `Remove service accounts (org.service_account.delete)`","operationId":"deleteServiceAccount","parameters":[{"description":"The ID of org to which the service account belongs.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The ID of the service account.","in":"path","name":"serviceaccount_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"description":"The service account has been deleted.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete a service account in an organization.","tags":["ServiceAccounts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-09-07"],"x-snyk-api-resource":"service_accounts","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-07","x-stability-level":"stable"},"get":{"description":"Get an organization-level service account by its ID.\n\n#### Required permissions\n\n- `View service accounts (org.service_account.read)`","operationId":"getOneOrgServiceAccount","parameters":[{"description":"The ID of the Snyk Organization that owns the service account.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The ID of the service account.","in":"path","name":"serviceaccount_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/ServiceAccount"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"Service account is returned.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get an organization service account.","tags":["ServiceAccounts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-09-07"],"x-snyk-api-resource":"service_accounts","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-07","x-stability-level":"stable"},"patch":{"description":"Update the name of an organization-level service account by its ID.\n\n#### Required permissions\n\n- `Edit service accounts (org.service_account.edit)`","operationId":"updateOrgServiceAccount","parameters":[{"description":"The ID of the Snyk Organization that owns the service account.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The ID of the service account.","in":"path","name":"serviceaccount_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"name":{"description":"A human-friendly name for the service account. Must be unique within the organization.","type":"string"}},"required":["name"],"type":"object"},"id":{"description":"The ID of the service account. Must match the id in the url path.","format":"uuid","type":"string"},"type":{"description":"The Resource type.","enum":["service_account"],"type":"string"}},"required":["type","id","attributes"],"type":"object"}},"required":["data"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/ServiceAccount"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"Service account is returned.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update an organization service account.","tags":["ServiceAccounts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-09-07"],"x-snyk-api-resource":"service_accounts","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-07","x-stability-level":"stable"}},"/orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets":{"post":{"description":"Manage the client secret of an organization service account by the service account ID.\n\n#### Required permissions\n\n- `Edit service accounts (org.service_account.edit)`","operationId":"updateOrgServiceAccountSecret","parameters":[{"description":"The ID of the Snyk Organization that owns the service account.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The ID of the service account.","in":"path","name":"serviceaccount_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"mode":{"description":"Operation to perform:\n * `replace` - Replace existing secrets with a new generated secret.\n * `create` - Add a new secret, preserving existing secrets. A maximum of to two secrets can exist at a time.\n * `delete` - Remove an existing secret by value. At least one secret must remain per service account.\n","enum":["replace","create","delete"],"type":"string"},"secret":{"description":"Secret to delete when using `delete` mode","type":"string"}},"required":["mode"],"type":"object"},"type":{"description":"The Resource type.","enum":["service_account"],"type":"string"}},"required":["attributes","type"],"type":"object"}},"required":["data"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/ServiceAccount"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"Service account client secret has been updated.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Manage an organization service account's client secret.","tags":["ServiceAccounts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-09-07"],"x-snyk-api-resource":"service_accounts","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-07","x-stability-level":"stable"}},"/orgs/{org_id}/settings/iac":{"get":{"description":"Get the Infrastructure as Code Settings for an org.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getIacSettingsForOrg","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the org whose Infrastructure as Code settings are requested.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/OrgIacSettingsResponse"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"The Infrastructure as Code Settings of the org.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get the Infrastructure as Code Settings for an org.","tags":["IacSettings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2021-12-09"],"x-snyk-api-resource":"iac_settings","x-snyk-api-stability":"ga","x-snyk-api-version":"2021-12-09","x-stability-level":"stable"},"patch":{"description":"Update the Infrastructure as Code Settings for an org.\n\n#### Required permissions\n\n- `Edit Organization (org.edit)`","operationId":"updateIacSettingsForOrg","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the org whose Infrastructure as Code settings are getting updated","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/OrgIacSettingsRequest"}},"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/OrgIacSettingsResponse"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"The Infrastructure as Code Settings of the org were updated.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update the Infrastructure as Code Settings for an org","tags":["IacSettings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2021-12-09"],"x-snyk-api-resource":"iac_settings","x-snyk-api-stability":"ga","x-snyk-api-version":"2021-12-09","x-stability-level":"stable"}},"/orgs/{org_id}/settings/opensource":{"get":{"description":"Returns settings for your Org which may also be controlled at the Group level.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getOpenSourceSettingsForOrg","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the org.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"description":"The Open Source settings for an Org.","properties":{"attributes":{"properties":{"reachability":{"description":"The reachability setting for Org.","properties":{"enabled":{"description":"When enabled projects in this Org will be scanned for reachable vulnerabilities.","example":true,"type":"boolean"}},"type":"object"}},"type":"object"},"id":{"description":"ID","example":"ea536a06-0566-40ca-b96b-155568aa2027","format":"uuid","type":"string"},"type":{"description":"Content type","example":"opensource_settings","type":"string"}},"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"The Open Source Settings for given Org.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get the Open Source Settings for an Org. (Early Access)","tags":["OpenSourceSettings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"open_source","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/settings/sast":{"get":{"description":"Retrieves the SAST settings for an org\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getSastSettings","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the org for which we want to retrieve the SAST settings","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/SastEnablement"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"The SAST settings for the org are being retrieved","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Retrieves the SAST settings for an org","tags":["SastSettings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-22"],"x-snyk-api-resource":"sast_settings","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-06-22","x-stability-level":"stable"},"patch":{"description":"Enable/Disable the Snyk Code settings for an org\n\n#### Required permissions\n\n- `View Organization (org.read)`\n\n- `Edit Organization (org.edit)`","operationId":"updateOrgSastSettings","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the org for which we want to update the Snyk Code setting","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"additionalProperties":false,"properties":{"sast_enabled":{"description":"The value of the updated settings for sastEnabled setting","type":"boolean"}},"required":["sast_enabled"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"type":"string"}},"required":["id","type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/SastEnablement"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"The SAST settings for the org are being updated","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Enable/Disable the Snyk Code settings for an org","tags":["SastSettings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-08-24~experimental","2023-09-11"],"x-snyk-api-resource":"sast_settings","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-09-11","x-stability-level":"stable"}},"/orgs/{org_id}/slack_app/{bot_id}":{"delete":{"description":"Remove the given Slack App integration\n\n#### Required permissions\n\n- `Install Apps (org.app.install)`","operationId":"deleteSlackDefaultNotificationSettings","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/BotId"}],"responses":{"204":{"description":"Slack App integration successfully removed","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Remove the given Slack App integration","tags":["SlackSettings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-11-07~experimental","2022-12-14"],"x-snyk-api-resource":"settings","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-12-14","x-stability-level":"stable"},"get":{"description":"Get Slack integration default notification settings for the provided tenant ID and bot ID.\n\n#### Required permissions\n\n- `Install Apps (org.app.install)`","operationId":"getSlackDefaultNotificationSettings","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/BotId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/SlackDefaultSettingsData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Default settings created successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get Slack integration default notification settings.","tags":["SlackSettings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-11-07~experimental","2022-12-14"],"x-snyk-api-resource":"settings","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-12-14","x-stability-level":"stable"},"post":{"description":"Create new Slack notification default settings for a given tenant.\n\n#### Required permissions\n\n- `Install Apps (org.app.install)`","operationId":"createSlackDefaultNotificationSettings","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/BotId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SettingsRequest"}}},"description":"Create new Slack notification default settings for a tenant."},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/SlackDefaultSettingsData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Default settings created successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create new Slack notification default settings.","tags":["SlackSettings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-11-07~experimental","2022-12-14"],"x-snyk-api-resource":"settings","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-12-14","x-stability-level":"stable"}},"/orgs/{org_id}/slack_app/{bot_id}/projects":{"get":{"description":"Slack notification settings overrides for projects. These settings overrides the default settings configured for the tenant.\n\n#### Required permissions\n\n- `Install Apps (org.app.install)`","operationId":"getSlackProjectNotificationSettingsCollection","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/BotId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetProjectSettingsCollection"}}},"description":"Return default settings for a tenant","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Slack notification settings overrides for projects","tags":["SlackSettings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-11-07~experimental","2022-12-14"],"x-snyk-api-resource":"settings","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-12-14","x-stability-level":"stable"}},"/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}":{"delete":{"description":"Remove Slack settings override for a project.\n\n#### Required permissions\n\n- `Install Apps (org.app.install)`","operationId":"deleteSlackProjectNotificationSettings","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Project ID","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/BotId"}],"responses":{"204":{"description":"Slack settings override for the project removed successfully.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Remove Slack settings override for a project.","tags":["SlackSettings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-11-07~experimental","2022-12-14"],"x-snyk-api-resource":"settings","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-12-14","x-stability-level":"stable"},"patch":{"description":"Update Slack notification settings for a project.\n\n#### Required permissions\n\n- `Install Apps (org.app.install)`","operationId":"updateSlackProjectNotificationSettings","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/BotId"},{"description":"Project ID","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ProjectSettingsPatchRequest"}}},"description":"Update existing project specific settings for a project."},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/ProjectSettingsData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Slack notification settings for a project updated successfully.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update Slack notification settings for a project.","tags":["SlackSettings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-11-07~experimental","2022-12-14"],"x-snyk-api-resource":"settings","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-12-14","x-stability-level":"stable"},"post":{"description":"Create Slack settings override for a project.\n\n#### Required permissions\n\n- `Install Apps (org.app.install)`","operationId":"createSlackProjectNotificationSettings","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Project ID","in":"path","name":"project_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/BotId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SettingsRequest"}}},"description":"Create new Slack notification default settings for a tenant."},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/ProjectSettingsData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Project settings created successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create a new Slack settings override for a given project.","tags":["SlackSettings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-11-07~experimental","2022-12-14"],"x-snyk-api-resource":"settings","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-12-14","x-stability-level":"stable"}},"/orgs/{org_id}/slack_app/{tenant_id}/channels":{"get":{"description":"Requires the Snyk Slack App to be set up for this org, will retrieve a list of channels the Snyk Slack App can access. Note that it is currently only possible to page forwards through this collection, no prev links will be generated and the ending_before parameter will not function.\n\n#### Required permissions\n\n- `Install Apps (org.app.install)`","operationId":"listChannels","parameters":[{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/ChannelLimit"},{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/TenantId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/SlackChannel"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"List of Slack channels","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a list of Slack channels","tags":["Slack"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-11-07"],"x-snyk-api-resource":"channels","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-11-07","x-stability-level":"stable"}},"/orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id}":{"get":{"description":"Requires the Snyk Slack App to be set up for this org. It will return the Slack channel name for the provided Slack channel ID.\n\n#### Required permissions\n\n- `Install Apps (org.app.install)`","operationId":"getChannelNameById","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/ChannelId"},{"$ref":"#/components/parameters/TenantId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/SlackChannel"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"List of Slack channels","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get Slack Channel name by Slack Channel ID.","tags":["Slack"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-11-07"],"x-snyk-api-resource":"channels","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-11-07","x-stability-level":"stable"}},"/orgs/{org_id}/targets":{"get":{"description":"Get a list of an organization's targets.\n\n#### Required permissions\n\n- `View Projects (org.project.read)`","operationId":"getOrgsTargets","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"description":"Calculate total amount of filtered results","in":"query","name":"count","schema":{"type":"boolean"}},{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"The id of the org to return a list of targets","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Return targets that match the provided value of is_private","in":"query","name":"is_private","schema":{"type":"boolean"}},{"description":"Return only the targets that has projects","in":"query","name":"exclude_empty","schema":{"default":true,"type":"boolean"}},{"description":"Return targets that match the provided remote_url.","in":"query","name":"url","schema":{"type":"string"}},{"description":"Return targets that match the provided source_types","explode":false,"in":"query","name":"source_types","schema":{"items":{"enum":["bitbucket-server","gitlab","github-enterprise","bitbucket-cloud","bitbucket-connect-app","azure-repos","github","github-cloud-app","github-server-app","cli","docker-hub","in-memory-fs","acr","ecr","gcr","artifactory-cr","harbor-cr","quay-cr","github-cr","nexus-cr","nexus-private-repo","digitalocean-cr","gitlab-cr","google-artifact-cr","heroku","kubernetes","api","aws-lambda","azure-functions","cloud-foundry","pivotal","ibm-cloud","terraform-cloud"],"type":"string"},"type":"array"},"style":"form"},{"description":"Return targets with display names starting with the provided string","in":"query","name":"display_name","schema":{"type":"string"}},{"description":"Return only targets which have been created at or after the specified date.\n","example":"2022-01-01T16:00:00Z","in":"query","name":"created_gte","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/PublicTarget"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"additionalProperties":false,"example":{"count":3},"properties":{"count":{"type":"number"}},"type":"object"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A list of targets is returned for the targeted org","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get targets by org ID","tags":["Targets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2021-08-20~beta","2024-02-21"],"x-snyk-api-resource":"targets","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-02-21","x-stability-level":"stable"}},"/orgs/{org_id}/targets/{target_id}":{"delete":{"description":"Delete the specified target.\n\n#### Required permissions\n\n- `Remove Projects (org.project.delete)`","operationId":"deleteOrgsTarget","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the org to delete","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the target to delete","in":"path","name":"target_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":"The target is deleted with all projects, if it is found in the specified org.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete target by target ID","tags":["Targets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2021-09-29~beta","2023-06-23~beta","2024-02-21"],"x-snyk-api-resource":"targets","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-02-21","x-stability-level":"stable"},"get":{"description":"Get a specified target for an organization.\n\n#### Required permissions\n\n- `View Projects (org.project.read)`","operationId":"getOrgsTarget","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"The id of the org to return the target from","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the target to return","in":"path","name":"target_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/PublicTarget"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data"],"type":"object"}}},"description":"A single target is returned if it is found in the specified org","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get target by target ID","tags":["Targets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2021-08-20~beta","2024-02-21"],"x-snyk-api-resource":"targets","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-02-21","x-stability-level":"stable"}},"/orgs/{org_id}/test_jobs/{job_id}":{"get":{"description":"Get a test job.\n\nThe Test API is Asynchronous, and Tests begun through the API\nare assigned a Job ID which references the in-progress Test. The\nJob ID is provided in a successful response from the CreateTest\nendpoint.\n\nThis endpoint is used to poll for the status of a Test using its\nassociated Job ID.\n\nWhen the Job is Finished and the Test is ready for consumption,\nthe Related link will be populated in the response with a link\nto the finished Test entity.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getJob","parameters":[{"$ref":"#/components/parameters/io.snyk.api.request.SnykApiRequest.request_id"},{"$ref":"#/components/parameters/io.snyk.api.request.SnykApiRequest.interaction_id"},{"$ref":"#/components/parameters/io.snyk.api.request.SnykApiRequest.version"},{"description":"Snyk Org ID under which to run or query information\nabout a Job or Test.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Job ID returned from the Test API to query.","in":"path","name":"job_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"description":"JobData represents a Job resource object.","properties":{"attributes":{"description":"JobAttributes represents the attributes of a Job resource","properties":{"created_at":{"description":"Creation time of the job resource","format":"date-time","type":"string"},"status":{"allOf":[{"enum":["pending","started","finished","errored"],"type":"string"}],"description":"State of the test, whether it is pending, running, complete or errored."}},"required":["status","created_at"],"type":"object"},"id":{"format":"uuid","type":"string"},"relationships":{"properties":{"test":{"allOf":[{"properties":{"data":{"properties":{"id":{"format":"uuid","type":"string"},"type":{"enum":["tests"],"type":"string"}},"required":["id","type"],"type":"object"}},"required":["data"],"type":"object"}],"description":"Test resource associated with the finished Job."}},"required":["test"],"type":"object"},"type":{"enum":["test_jobs"],"type":"string"}},"required":["id","attributes","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/io.snyk.api.common.JsonApi"},"links":{"additionalProperties":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"},"properties":{"related":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"},"self":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"}},"type":"object"},"meta":{"$ref":"#/components/schemas/io.snyk.api.common.Meta"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"Successful API response with a single resource","headers":{"deprecation":{"schema":{"type":"string"}},"snyk-request-id":{"schema":{"type":"string"}},"snyk-version-lifecycle-stage":{"schema":{"type":"string"}},"snyk-version-requested":{"schema":{"type":"string"}},"snyk-version-served":{"schema":{"type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"303":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"description":"JobData represents a Job resource object.","properties":{"attributes":{"description":"JobAttributes represents the attributes of a Job resource","properties":{"created_at":{"description":"Creation time of the job resource","format":"date-time","type":"string"},"status":{"allOf":[{"enum":["pending","started","finished","errored"],"type":"string"}],"description":"State of the test, whether it is pending, running, complete or errored."}},"required":["status","created_at"],"type":"object"},"id":{"format":"uuid","type":"string"},"relationships":{"properties":{"test":{"allOf":[{"properties":{"data":{"properties":{"id":{"format":"uuid","type":"string"},"type":{"enum":["tests"],"type":"string"}},"required":["id","type"],"type":"object"}},"required":["data"],"type":"object"}],"description":"Test resource associated with the finished Job."}},"required":["test"],"type":"object"},"type":{"enum":["test_jobs"],"type":"string"}},"required":["id","attributes","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/io.snyk.api.common.JsonApi"},"links":{"additionalProperties":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"},"properties":{"related":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"},"self":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"}},"type":"object"},"meta":{"$ref":"#/components/schemas/io.snyk.api.common.Meta"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"Redirect to another resource after async processing.","headers":{"deprecation":{"schema":{"type":"string"}},"location":{"required":true,"schema":{"type":"string"}},"snyk-request-id":{"schema":{"type":"string"}},"snyk-version-lifecycle-stage":{"schema":{"type":"string"}},"snyk-version-requested":{"schema":{"type":"string"}},"snyk-version-served":{"schema":{"type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/io.snyk.api.common.ErrorDocument"}}},"description":"Invalid input","headers":{"deprecation":{"schema":{"type":"string"}},"snyk-request-id":{"schema":{"type":"string"}},"snyk-version-lifecycle-stage":{"schema":{"type":"string"}},"snyk-version-requested":{"schema":{"type":"string"}},"snyk-version-served":{"schema":{"type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Get a test job. (Early Access)","tags":["Tests"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"tests","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/tests":{"post":{"description":"Create a new test.\n\nProvide the items to be tested by Snyk as well as any configuration\nparameters for the test to be run.\n\nCurrently, scans using the Open Source (SCA) and Code Analysis (SAST)\nscanners can be run using the Test API.\n\nTests begun through the Test API yield lists of Findings when\nfinished. These Findings can be retrieved using the ListFindings endpoint.\n\nSuccessfully creating a new Test will yield a Job ID that can be used\nto poll for the Test's completion via the GetJob endpoint.\n\n#### Required permissions\n\n- `View Organization (org.read)`\n\n- `Test packages (org.package.test)`","operationId":"createTest","parameters":[{"$ref":"#/components/parameters/io.snyk.api.request.SnykApiRequest.request_id"},{"$ref":"#/components/parameters/io.snyk.api.request.SnykApiRequest.interaction_id"},{"$ref":"#/components/parameters/io.snyk.api.request.SnykApiRequest.version"},{"description":"Snyk Org ID under which to run or query information\nabout a Job or Test.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/TestRequestBody"}}},"required":true},"responses":{"202":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"properties":{"attributes":{"description":"JobAttributes represents the attributes of a Job resource","properties":{"created_at":{"description":"Creation time of the job resource","format":"date-time","type":"string"},"status":{"allOf":[{"enum":["pending","started","finished","errored"],"type":"string"}],"description":"State of the test, whether it is pending, running, complete or errored."}},"required":["status","created_at"],"type":"object"},"id":{"format":"uuid","type":"string"},"type":{"enum":["test_jobs"],"type":"string"}},"required":["type","id","attributes"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/io.snyk.api.common.JsonApi"},"links":{"additionalProperties":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"},"properties":{"related":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"},"self":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"}},"type":"object"},"meta":{"$ref":"#/components/schemas/io.snyk.api.common.Meta"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"The request has been accepted for processing, but processing has not yet completed.","headers":{"content-location":{"description":"A pointer to the newly created Test resource","required":true,"schema":{"format":"string","type":"string"}},"deprecation":{"schema":{"type":"string"}},"snyk-request-id":{"schema":{"type":"string"}},"snyk-version-lifecycle-stage":{"schema":{"type":"string"}},"snyk-version-requested":{"schema":{"type":"string"}},"snyk-version-served":{"schema":{"type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/io.snyk.api.common.ErrorDocument"}}},"description":"Invalid input","headers":{"deprecation":{"schema":{"type":"string"}},"snyk-request-id":{"schema":{"type":"string"}},"snyk-version-lifecycle-stage":{"schema":{"type":"string"}},"snyk-version-requested":{"schema":{"type":"string"}},"snyk-version-served":{"schema":{"type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Create a new test. (Early Access)","tags":["Tests"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"tests","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/tests/{test_id}":{"get":{"description":"Get a test.\n\nA Test returned through this endpoint is intended to\nbe a completed Test with results. The data returned through\nthis endpoint does not contain the Findings for the Test, but\na description of the Test that was run and its status.\n\nTests that completed successfully are marked with an appropriate\noutcome according to the configured Thresholds.\n\nFacts about the Test (e.g. how many dependencies were present in\na Tested SBOM) are attached to this response as well as a summary\nof the Findings uncovered during the Test.\n\nAny Errors or Warnings that occurred during the Test will be present in the\nresponse from this endpoint.\n\nThe response will also contain a link to the first page of the Test's\nFindings.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"getTest","parameters":[{"$ref":"#/components/parameters/io.snyk.api.request.SnykApiRequest.request_id"},{"$ref":"#/components/parameters/io.snyk.api.request.SnykApiRequest.interaction_id"},{"$ref":"#/components/parameters/io.snyk.api.request.SnykApiRequest.version"},{"description":"Snyk Org ID under which to run or query information\nabout a Job or Test.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/TestIdParam"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/TestData"},"jsonapi":{"$ref":"#/components/schemas/io.snyk.api.common.JsonApi"},"links":{"additionalProperties":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"},"properties":{"related":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"},"self":{"$ref":"#/components/schemas/io.snyk.api.common.LinkProperty"}},"type":"object"},"meta":{"$ref":"#/components/schemas/io.snyk.api.common.Meta"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"Successful API response with a single resource","headers":{"deprecation":{"schema":{"type":"string"}},"snyk-request-id":{"schema":{"type":"string"}},"snyk-version-lifecycle-stage":{"schema":{"type":"string"}},"snyk-version-requested":{"schema":{"type":"string"}},"snyk-version-served":{"schema":{"type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/io.snyk.api.common.ErrorDocument"}}},"description":"Invalid input","headers":{"deprecation":{"schema":{"type":"string"}},"snyk-request-id":{"schema":{"type":"string"}},"snyk-version-lifecycle-stage":{"schema":{"type":"string"}},"snyk-version-requested":{"schema":{"type":"string"}},"snyk-version-served":{"schema":{"type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"Get a test. (Early Access)","tags":["Tests"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"tests","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/tests/{test_id}/findings":{"get":{"description":"List findings for a test.\n\nTest Findings are scanner-agnostic representations of\nvulnerabilities and organization-level policy breaches.\nWhen Snyk runs a Test, the results of that Test are\nformatted into Findings.\n\nThis endpoint returns pages of Findings associated with\na given Test ID. Findings are returned in sorted order by\nID, with page size equal to the provided Limit query parameter.\nPage size is 10 Findings by default if no parameter is provided.\n\nNote that the Findings returned from this endpoint are only the\nFindings that are _not_ suppressed by policy and are _not_\nin violation of a set Test threshold (like Severity or Risk Score).\n\nTo retrieve the next (or previous) page of Findings, utilize the\nNext and Prev links returned in the response.\n\n#### Required permissions\n\n- `View Organization (org.read)`","operationId":"listFindings","parameters":[{"$ref":"#/components/parameters/io.snyk.api.request.SnykApiRequest.request_id"},{"$ref":"#/components/parameters/io.snyk.api.request.SnykApiRequest.interaction_id"},{"$ref":"#/components/parameters/io.snyk.api.request.SnykApiRequest.version"},{"$ref":"#/components/parameters/io.snyk.api.request.PaginatedRequest.starting_after"},{"$ref":"#/components/parameters/io.snyk.api.request.PaginatedRequest.ending_before"},{"$ref":"#/components/parameters/io.snyk.api.request.PaginatedRequest.limit"},{"description":"Snyk Org ID under which to run or query information\nabout a Job or Test.","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/TestIdParam"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FindingData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/io.snyk.api.common.JsonApi"},"links":{"$ref":"#/components/schemas/io.snyk.api.common.PaginatedLinks"},"meta":{"$ref":"#/components/schemas/io.snyk.api.common.Meta"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"Successful API response for a paginated collection.","headers":{"deprecation":{"schema":{"type":"string"}},"snyk-request-id":{"schema":{"type":"string"}},"snyk-version-lifecycle-stage":{"schema":{"type":"string"}},"snyk-version-requested":{"schema":{"type":"string"}},"snyk-version-served":{"schema":{"type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/io.snyk.api.common.ErrorDocument"}}},"description":"Invalid input","headers":{"deprecation":{"schema":{"type":"string"}},"snyk-request-id":{"schema":{"type":"string"}},"snyk-version-lifecycle-stage":{"schema":{"type":"string"}},"snyk-version-requested":{"schema":{"type":"string"}},"snyk-version-served":{"schema":{"type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"format":"date","type":"string"}}}}},"summary":"List findings for a test. (Early Access)","tags":["Findings"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"tests","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/orgs/{org_id}/users/{id}":{"get":{"description":"Get a summary of user.\n\nNote that Service Accounts are not returned by this endpoint. Please use the Service Accounts endpoints.\n\n#### Required permissions\n\n- `View users (org.user.read)`","operationId":"getUser","parameters":[{"description":"The id of the org","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The id of the user","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/User"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"}},"required":["jsonapi","data"],"type":"object"}}},"description":"User details","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get user by ID (Early Access)","tags":["Users"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2021-09-13~beta"],"x-snyk-api-resource":"users","x-snyk-api-stability":"beta","x-snyk-api-version":"2021-09-13~beta","x-stability-level":"beta"}},"/self":{"get":{"description":"Retrieves information about the the user making the request.","operationId":"getSelf","parameters":[{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Principal20240422"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"Current user is returned","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"My User Details","tags":["Users"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-03-01~experimental","2022-09-14~experimental","2024-04-22"],"x-snyk-api-resource":"self","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-04-22","x-stability-level":"stable"}},"/self/access_requests":{"get":{"description":"Get a list of user's access requests","operationId":"getAccessRequests","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/OrgIdFilter"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/AccessRequest"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"required":["jsonapi","data","links"],"type":"object"}}},"description":"A list of access requests are returned","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get access requests (Early Access)","tags":["AccessRequests"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-12-01~experimental","2023-12-21~beta"],"x-snyk-api-resource":"self","x-snyk-api-stability":"beta","x-snyk-api-version":"2023-12-21~beta","x-stability-level":"beta"}},"/self/apps":{"get":{"description":"Get a list of Snyk Apps that can act on your behalf","operationId":"getUserInstalledApps","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/PublicApp"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"A list of apps install that can act on your behalf","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Get a list of Snyk Apps that can act on your behalf","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-03-11"],"x-snyk-api-resource":"user_app_installs","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-03-11","x-stability-level":"stable"}},"/self/apps/installs":{"get":{"description":"Get a list of Snyk Apps installed for a user","operationId":"getAppInstallsForUser","parameters":[{"description":"Expand relationships.","explode":false,"in":"query","name":"expand","schema":{"items":{"enum":["app"],"type":"string"},"type":"array"},"style":"form"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/AppInstallData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"A list of apps installed for the specified organization.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Get a list of Snyk Apps installed for a user","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03","2024-05-23"],"x-snyk-api-resource":"app_installs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-23","x-stability-level":"stable"}},"/self/apps/installs/{install_id}":{"delete":{"description":"Revoke a Snyk App by install ID","operationId":"deleteUserAppInstallById","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/InstallId"}],"responses":{"204":{"description":"The Snyk App install is revoked, with no content (no errors).","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Revoke a Snyk App by install ID","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-06-19~experimental","2023-11-03","2024-05-23"],"x-snyk-api-resource":"app_installs","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-05-23","x-stability-level":"stable"}},"/self/apps/{app_id}":{"delete":{"description":"Revoke access for an app by app id","operationId":"revokeUserInstalledApp","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/AppId"}],"responses":{"204":{"description":"Access to the Snyk App is revoked, with no content (no errors).","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Revoke a Snyk App by app ID","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2022-03-11"],"x-snyk-api-resource":"user_app_installs","x-snyk-api-stability":"ga","x-snyk-api-version":"2022-03-11","x-stability-level":"stable"}},"/self/apps/{app_id}/sessions":{"get":{"description":"Get a list of active OAuth sessions by app ID","operationId":"getUserAppSessions","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/AppId"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/SessionData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi"],"type":"object"}}},"description":"Attributes identifying the active OAuth sessions.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Get a list of active OAuth sessions by app ID","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-03-30~experimental","2023-11-03"],"x-snyk-api-resource":"sessions","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-11-03","x-stability-level":"stable"}},"/self/apps/{app_id}/sessions/{session_id}":{"delete":{"description":"Revoke the Snyk App session of an active user","operationId":"revokeUserAppSession","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/AppId"},{"description":"Session ID","in":"path","name":"session_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":"The user app sessions has been revoked.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400__0"},"401":{"$ref":"#/components/responses/401__0"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404__0"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500__0"}},"summary":"Revoke the Snyk App session of an active user","tags":["Apps"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2023-03-30~experimental","2023-11-03"],"x-snyk-api-resource":"sessions","x-snyk-api-stability":"ga","x-snyk-api-version":"2023-11-03","x-stability-level":"stable"}},"/self/personal_access_tokens":{"get":{"description":"List personal access tokens","operationId":"listPersonalAccessToken","parameters":[{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/Version"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"additionalProperties":false,"properties":{"attributes":{"properties":{"created_at":{"$ref":"#/components/schemas/PersonalAccessTokenCreatedAt"},"expires_at":{"$ref":"#/components/schemas/PersonalAccessTokenExpiresAt"},"label":{"$ref":"#/components/schemas/PersonalAccessTokenLabel"},"tenant_id":{"$ref":"#/components/schemas/PatTenantId"}},"required":["created_at","expires_at","label"],"type":"object"},"id":{"$ref":"#/components/schemas/PersonalAccessTokenId"},"type":{"$ref":"#/components/schemas/PersonalAccessTokenType"}},"required":["id","attributes","type"],"type":"object"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"},"meta":{"properties":{"max_active_tokens":{"type":"integer"},"max_expiry_days":{"type":"integer"}},"required":["max_active_tokens","max_expiry_days"],"type":"object"}},"required":["data","meta"],"type":"object"}}},"description":"Return the personal access tokens associated with the calling principal","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"List personal access tokens","tags":["PersonalAccessToken"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-03-19"],"x-snyk-api-resource":"pats","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-03-19","x-stability-level":"stable"}},"/self/personal_access_tokens/{personal_access_token_id}":{"delete":{"description":"Delete a personal access token","operationId":"deletePersonalAccessToken","parameters":[{"$ref":"#/components/parameters/PersonalAccessTokenId"},{"$ref":"#/components/parameters/Version"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Deletes a personal access token","tags":["PersonalAccessToken"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-03-19"],"x-snyk-api-resource":"pats","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-03-19","x-stability-level":"stable"}},"/tenants":{"get":{"description":"Get a list of all Tenants which the calling user is a member of","operationId":"listTenants","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/TenantResponseData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"Returns a list of tenants.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a list of all accessible Tenants","tags":["Tenants"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-04-11~experimental","2024-10-15"],"x-snyk-api-resource":"tenants","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-stability-level":"stable"}},"/tenants/{tenant_id}":{"get":{"description":"Get the full details of a Tenant.\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"getTenant","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/TenantId20240411"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/TenantResponseData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returns an instance of a tenant.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a single Tenant by ID","tags":["Tenants"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-04-11~experimental","2024-10-15"],"x-snyk-api-resource":"tenants","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-stability-level":"stable"},"patch":{"description":"Update the details of a tenant\n\n#### Required permissions\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"updateTenant","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/TenantId20240411"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/TenantUpdateAttributes"},"id":{"format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"description":"tenant resource object","properties":{"attributes":{"$ref":"#/components/schemas/TenantAttributes"},"id":{"example":"d5b640e5-d88c-4c17-9bf0-93597b7a1ce2","format":"uuid","type":"string"},"type":{"$ref":"#/components/schemas/Types"}},"required":["id","type"],"type":"object"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Instance of tenant is updated","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update tenant","tags":["Tenants"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-04-11~experimental","2024-10-15"],"x-snyk-api-resource":"tenants","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/connections/{connection_id}/integrations":{"get":{"description":"Get all integrations using the Broker connection\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"getBrokerConnectionIntegrations","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/ConnectionId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerConnectionIntegrationsResponse"}}},"description":"Returns a list of Integration IDs","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: one or more parameters are invalid. Check the input to match the expected format. See [Snyk API](https://docs.snyk.io/snyk-api)","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource you are trying to access could not be found. Review the request and try again.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}}},"summary":"Get Integrations using the current Broker connection","tags":["BrokerConnections"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"connections","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integration":{"post":{"description":"Configures integrations to use the Broker connection for an deployment\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"createBrokerConnectionIntegration","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/ConnectionId"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateBrokerConnectionIntegration"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerConnectionIntegrationResponse"}}},"description":"Configured integrations to use broker connection successfully","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: one or more parameters are invalid. Check the input to match the expected format. See [Snyk API](https://docs.snyk.io/snyk-api)","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"403":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Forbidden: the request requires an authentication token with more or different permissions. Review token permissions and try again. See [PAT permissions](https://support.snyk.io/hc/en-us/articles/4410967220765-How-to-check-if-a-personal-access-token-has-the-correct-permissions).","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource you are trying to access could not be found. Review the request and try again.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}}},"summary":"Creates Broker connection Integration Configuration","tags":["BrokerConnections"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"connections","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/connections/{connection_id}/orgs/{org_id}/integrations/{integration_id}":{"delete":{"description":"Deletes an existing Broker connection for an deployment\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"deleteBrokerConnectionIntegration","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/ConnectionId"},{"description":"Org ID","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/IntegrationId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"204":{"description":"Broker connection integration was deleted","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: one or more parameters are invalid. Check the input to match the expected format. See [Snyk API](https://docs.snyk.io/snyk-api)","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"403":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Forbidden: the request requires an authentication token with more or different permissions. Review token permissions and try again. See [PAT permissions](https://support.snyk.io/hc/en-us/articles/4410967220765-How-to-check-if-a-personal-access-token-has-the-correct-permissions).","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource you are trying to access could not be found. Review the request and try again.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}}},"summary":"Deletes an Integration for a Broker connection","tags":["BrokerConnections"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"connections","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/deployments":{"get":{"description":"List Broker deployments for the tenant\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"listBrokerDeploymentsForTenant","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ListBrokerDeploymentsResponse"}}},"description":"Returns the list of Broker deployments by install ID","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"List Broker deployments for tenant","tags":["BrokerDeployments"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"deployments","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/installs/{install_id}/connections/{connection_id}/contexts":{"get":{"description":"List Broker contexts for a given broker connection ID\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"listConnectionContexts","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/ConnectionId"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ListBrokerContextsResponse"}}},"description":"Returns the list of broker contexts by connection ID","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"List Connection contexts","tags":["BrokerContexts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"contexts","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}":{"delete":{"description":"Deletes an existing broker context\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"deleteBrokerContext","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/ContextId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"204":{"description":"Broker context was deleted","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Deletes broker context","tags":["BrokerContexts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"contexts","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"},"get":{"description":"List Broker context for a given broker context ID\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"getConnectionContext","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/ContextId"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerContextResponse"}}},"description":"Returns the broker context by context ID","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"List Connection context","tags":["BrokerContexts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"contexts","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"},"patch":{"description":"Updates a Broker Context for an deployment\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"updateBrokerContext","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/ContextId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdateBrokerContextRequest"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerContextResponse"}}},"description":"Updates an existing Broker Context","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Updates Broker Context","tags":["BrokerContexts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"contexts","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}/integration":{"patch":{"description":"Updates an integration to be associated with a Broker context\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"updateBrokerContextIntegration","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/ContextId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdateBrokerConnectionIntegrationWithContext"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdateBrokerConnectionIntegrationWithContextResponse"}}},"description":"Broker context assocation with a connection integration was created","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Updates an integration to be associated with a Broker context","tags":["BrokerContexts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"contexts","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}/integrations/{integration_id}":{"delete":{"description":"Deletes an existing Broker context association for an integration\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"deleteBrokerContextIntegration","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/ContextId"},{"$ref":"#/components/parameters/IntegrationId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"204":{"description":"Broker context assocation with a connection integration was deleted","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Deletes the Broker context association with an Integration","tags":["BrokerContexts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"contexts","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/installs/{install_id}/deployments":{"get":{"description":"List Broker deployments for a given install ID\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"listBrokerDeployments","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ListBrokerDeploymentsResponse"}}},"description":"Returns the list of Broker deployments by install ID","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"List Broker deployments","tags":["BrokerDeployments"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"deployments","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"},"post":{"description":"Creates a new Broker Deployment for an installation\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"createBrokerDeployment","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateBrokerDeploymentRequest"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerDeploymentResponse"}}},"description":"Created broker deployment successfully","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Creates Broker Deployment","tags":["BrokerDeployments"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"deployments","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}":{"delete":{"description":"Delete a Broker deployment for a given install ID\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"deleteBrokerDeployment","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"204":{"description":"Returns an empty response","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Deletes Broker deployment","tags":["BrokerDeployments"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"deployments","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"},"patch":{"description":"Updates a Broker deployment for a given install ID\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"updateBrokerDeployment","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdateBrokerDeploymentRequest"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerDeploymentResponse"}}},"description":"Updates an existing Broker deployment by install ID","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Updates Broker deployment","tags":["BrokerDeployments"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"deployments","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections":{"delete":{"description":"Deletes all existing Broker connections for an deployment\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"deleteBrokerConnections","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"204":{"description":"All Broker connections were deleted","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: one or more parameters are invalid. Check the input to match the expected format. See [Snyk API](https://docs.snyk.io/snyk-api)","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token. See [Revoke and regenerate a Snyk API token](https://docs.snyk.io/snyk-api/rest-api/authentication-for-api/revoke-and-regenerate-a-snyk-api-token).","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource you are trying to access could not be found. Review the request and try again.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}}},"summary":"Deletes Broker connections","tags":["BrokerConnections"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"connections","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"},"get":{"description":"List all Broker connections for a given deployment\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"listBrokerConnections","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ListBrokerConnectionsResponse"}}},"description":"Returns the list of Broker connections by deployment ID","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: one or more parameters are invalid. Check the input to match the expected format. See [Snyk API](https://docs.snyk.io/snyk-api)","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token. See [Revoke and regenerate a Snyk API token](https://docs.snyk.io/snyk-api/rest-api/authentication-for-api/revoke-and-regenerate-a-snyk-api-token).","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource you are trying to access could not be found. Review the request and try again.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}}},"summary":"List Broker connections","tags":["BrokerConnections"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"connections","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"},"post":{"description":"Creates a new Broker connection for an deployment\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"createBrokerConnection","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateBrokerConnectionRequest"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerConnectionResponse"}}},"description":"Created broker connection successfully","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: one or more parameters are invalid. Check the input to match the expected format. See [Snyk API](https://docs.snyk.io/snyk-api)","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token. See [Revoke and regenerate a Snyk API token](https://docs.snyk.io/snyk-api/rest-api/authentication-for-api/revoke-and-regenerate-a-snyk-api-token).","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource you are trying to access could not be found. Review the request and try again.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}}},"summary":"Creates Broker connection","tags":["BrokerConnections"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"connections","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}":{"delete":{"description":"Deletes an existing Broker connection for an deployment\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"deleteBrokerConnection","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/ConnectionId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"204":{"description":"Broker connection was deleted","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: one or more parameters are invalid. Check the input to match the expected format. See [Snyk API](https://docs.snyk.io/snyk-api)","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token. See [Revoke and regenerate a Snyk API token](https://docs.snyk.io/snyk-api/rest-api/authentication-for-api/revoke-and-regenerate-a-snyk-api-token).","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource you are trying to access could not be found. Review the request and try again.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}}},"summary":"Deletes Broker connection","tags":["BrokerConnections"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"connections","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"},"get":{"description":"Get all Broker connection data for an deployment\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"getBrokerConnection","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/ConnectionId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerConnectionResponse"}}},"description":"Returns a Broker connection","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: one or more parameters are invalid. Check the input to match the expected format. See [Snyk API](https://docs.snyk.io/snyk-api)","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token. See [Revoke and regenerate a Snyk API token](https://docs.snyk.io/snyk-api/rest-api/authentication-for-api/revoke-and-regenerate-a-snyk-api-token).","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource you are trying to access could not be found. Review the request and try again.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}}},"summary":"Get Broker connection","tags":["BrokerConnections"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"connections","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"},"patch":{"description":"Updates a Broker connection for an deployment\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"updateBrokerConnection","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/ConnectionId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdateBrokerConnectionRequest"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerConnectionResponse"}}},"description":"Updates an existing Broker connection for an deployment","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: one or more parameters are invalid. Check the input to match the expected format. See [Snyk API](https://docs.snyk.io/snyk-api)","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token. See [Revoke and regenerate a Snyk API token](https://docs.snyk.io/snyk-api/rest-api/authentication-for-api/revoke-and-regenerate-a-snyk-api-token).","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource you are trying to access could not be found. Review the request and try again.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}}},"summary":"Updates Broker connection","tags":["BrokerConnections"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"connections","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/connections/{connection_id}/bulk_migration":{"get":{"description":"Lists organization IDs associated with a connection type to be bulk migrated to universal broker\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"listBrokerOrgsForBulkMigration","parameters":[{"$ref":"#/components/parameters/ConnectionId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/TenantId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerOrganizationsForBulkMigrationResponse"}}},"description":"Returns a list of organization IDs for the bulk migration","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: one or more parameters are invalid. Check the input to match the expected format. See [Snyk API](https://docs.snyk.io/snyk-api)","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource you are trying to access could not be found. Review the request and try again.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}}},"summary":"List organizations for bulk migration","tags":["BrokerConnections"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15"],"x-snyk-api-resource":"connections","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"},"post":{"description":"Performs bulk migration for integrations from legacy to universal broker\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"createBrokerOrgsForBulkMigration","parameters":[{"$ref":"#/components/parameters/ConnectionId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/TenantId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateBulkMigrationRequest"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BulkMigrationCreateResponse"}}},"description":"The bulk migration process was started","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: one or more parameters are invalid. Check the input to match the expected format. See [Snyk API](https://docs.snyk.io/snyk-api)","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource you are trying to access could not be found. Review the request and try again.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An unexpected error was encountered while attempting to process the request. Try again. If the error still occurs, contact support.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02","format":"date","type":"string"}}}}},"summary":"Performs bulk migration integrations to universal broker","tags":["BrokerConnections"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15"],"x-snyk-api-resource":"connections","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/contexts":{"get":{"description":"List Deployment contexts for a given deployment ID\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"listDeploymentContexts","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ListBrokerContextsResponse"}}},"description":"Returns the list of broker contexts by deployment ID","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"List Deployment contexts","tags":["BrokerContexts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"contexts","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"},"post":{"description":"Creates a new Broker Context\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"createBrokerContext","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateBrokerContextRequest"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetBrokerContextResponse"}}},"description":"Created Broker Context successfully","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Create broker Context","tags":["BrokerContexts"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"contexts","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials":{"get":{"description":"List Deployment credentials for a given deployment ID\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"listDeploymentCredentials","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ListDeploymentCredentialsResponse"}}},"description":"Returns the list of deployment credentials by ID","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"List Deployment credentials","tags":["DeploymentCredentials"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"credentials","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"},"post":{"description":"Creates a new Deployment credential\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"createDeploymentCredential","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateDeploymentCredentialRequest"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ListDeploymentCredentialsResponse"}}},"description":"Created Deployment credential successfully","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Create deployment credential","tags":["DeploymentCredentials"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"credentials","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id}":{"delete":{"description":"Deletes an existing Deployment credential for an deployment\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"deleteDeploymentCredential","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/CredentialId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"responses":{"204":{"description":"Deployment credential was deleted","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Deletes Deployment credential","tags":["DeploymentCredentials"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"credentials","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"},"get":{"description":"Get all Deployment credential data for an deployment\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"getDeploymentCredential","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/CredentialId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/StartingAfter"},{"description":"Number of results to return per page","example":10,"in":"query","name":"limit","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetDeploymentCredentialResponse"}}},"description":"Returns a Deployment credential","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Get Deployment credential","tags":["DeploymentCredentials"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"credentials","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"},"patch":{"description":"Updates a Deployment credential for an deployment\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"updateDeploymentCredential","parameters":[{"$ref":"#/components/parameters/TenantId"},{"$ref":"#/components/parameters/InstallId"},{"$ref":"#/components/parameters/DeploymentId"},{"$ref":"#/components/parameters/CredentialId"},{"description":"The requested version of the endpoint to process the request","example":"2021-06-04","in":"query","name":"version","required":true,"schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UpdateDeploymentCredentialRequest"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetDeploymentCredentialResponse"}}},"description":"Updates an existing Deployment credential for an deployment","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"400":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Bad Request: A parameter provided as a part of the request was invalid.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"401":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Unauthorized: the request requires an authentication token.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"404":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Not Found: The resource being operated on could not be found.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}},"500":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"example":{"errors":[{"detail":"Permission denied for this resource","status":"403"}],"jsonapi":{"version":"1.0"}},"properties":{"errors":{"example":[{"detail":"Permission denied for this resource","status":"403"}],"items":{"additionalProperties":false,"example":{"detail":"Not Found","status":"404"},"properties":{"code":{"description":"An application-specific error code, expressed as a string value.","example":"entity-not-found","type":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","example":"The request was missing these required fields: ...","type":"string"},"id":{"description":"A unique identifier for this particular occurrence of the problem.","example":"f16c31b5-6129-4571-add8-d589da9be524","format":"uuid","type":"string"},"links":{"additionalProperties":false,"description":"A link that leads to further details about this particular occurrance of the problem.","example":{"about":"https://example.com/about_this_error"},"properties":{"about":{"example":"https://example.com/api/resource","oneOf":[{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},{"additionalProperties":false,"example":{"href":"https://example.com/api/resource"},"properties":{"href":{"description":"A string containing the link’s URL.","example":"https://example.com/api/resource","type":"string"},"meta":{"additionalProperties":true,"description":"Free-form object that may contain non-standard information.","example":{"key1":"value1","key2":{"sub_key":"sub_value"},"key3":["array_value1","array_value2"]},"type":"object"}},"required":["href"],"type":"object"}]}},"type":"object"},"meta":{"additionalProperties":true,"example":{"key":"value"},"type":"object"},"source":{"additionalProperties":false,"example":{"pointer":"/data/attributes"},"properties":{"parameter":{"description":"A string indicating which URI query parameter caused the error.","example":"param1","type":"string"},"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document.","example":"/data/attributes","type":"string"}},"type":"object"},"status":{"description":"The HTTP status code applicable to this problem, expressed as a string value.","example":"400","pattern":"^[45]\\d\\d$","type":"string"},"title":{"description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","example":"Bad request","type":"string"}},"required":["status","detail"],"type":"object"},"minItems":1,"type":"array"},"jsonapi":{"additionalProperties":false,"example":{"version":"1.0"},"properties":{"version":{"description":"Version of the JSON API specification this server supports.","example":"1.0","pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$","type":"string"}},"required":["version"],"type":"object"}},"required":["jsonapi","errors"],"type":"object"}}},"description":"Internal Server Error: An error was encountered while attempting to process the request.","headers":{"deprecation":{"description":"The deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n","schema":{"example":"2021-07-01T00:00:00Z","format":"date-time","type":"string"}},"snyk-request-id":{"description":"A unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n","schema":{"example":"4b58e274-ec62-4fab-917b-1d2c48d6bdef","format":"uuid","type":"string"}},"snyk-version-lifecycle-stage":{"description":"The version stage of the endpoint. This stage describes the guarantees Snyk provides surrounding stability of the endpoint.\n","schema":{"enum":["wip","experimental","beta","ga","deprecated","sunset"],"example":"ga","type":"string"}},"snyk-version-requested":{"description":"The version of the endpoint requested by the caller.","schema":{"description":"Requested API version","example":"2021-06-04","pattern":"^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$","type":"string"}},"snyk-version-served":{"description":"The version of the endpoint that was served by the API.","schema":{"description":"Resolved API version","example":"2021-06-04","pattern":"^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$","type":"string"}},"sunset":{"description":"A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. For information purposes only. Returned as a date in the format: YYYY-MM-DD","example":"2021-08-02","schema":{"example":"2021-08-02T00:00:00Z","format":"date","type":"string"}}}}},"summary":"Updates Deployment credential","tags":["DeploymentCredentials"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-02-08~experimental","2024-10-15"],"x-snyk-api-resource":"credentials","x-snyk-api-stability":"ga","x-snyk-api-version":"2024-10-15","x-snyk-documentation":{"category":"Universal Broker"},"x-stability-level":"stable"}},"/tenants/{tenant_id}/inventory/assets":{"get":{"description":"Retrieves a polymorphic list of all asset types for a given tenant.\nThe response includes different asset types (containers, container images, etc.)\nin a single unified response following the JSON:API specification.\n\nThis endpoint supports both simple listing and synchronous search with filtering,\nsorting, and cursor-based pagination through query parameters.\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"listAssetsTenant","parameters":[{"description":"The unique identifier of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"$ref":"#/components/parameters/RsqlFilter"},{"description":"Comma-separated sort fields. Prefix with `-` for descending order.\n\n**Supported fields:**\n- `created_at` - Asset creation timestamp\n- `updated_at` - Asset last update timestamp\n- `type` - Asset type (container_images)\n- `class` - Asset class\n- `risk_score` - Asset risk score (max across project sources)\n- `issues` - Issue counts by severity (critical, high, medium, low)\n- `built_at` - Image build timestamp (container images only)\n- `last_scan` - Last scan timestamp\n","example":"-created_at","in":"query","name":"sort","schema":{"type":"string"}},{"description":"Number of results to return per page","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for fetching the next page of results","example":"v1.MTIzNDU2Nzg5MHxhYmNkZWY=","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","example":"v1.MTIzNDU2Nzg5MHxhYmNkZWY=","in":"query","name":"ending_before","schema":{"type":"string"}},{"$ref":"#/components/parameters/SparseFieldsets"},{"$ref":"#/components/parameters/MetaCount"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AssetListResponse"}}},"description":"Successful response with a polymorphic list of assets","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"summary":"List or search all assets (synchronous) (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"},"patch":{"description":"Partially updates multiple assets in a single request. \nMaximum of 100 assets can be updated per request.\nThe operation is transactional - all updates succeed or all fail.\nSupports updating class, labels (add/remove), and tags (add/remove).\n\n#### Required permissions\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"updateAssetsBulkTenant","parameters":[{"description":"The unique identifier of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AssetBulkPatchRequestBody"}}},"required":true},"responses":{"204":{"description":"Assets updated successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Bulk update asset attributes (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/tenants/{tenant_id}/inventory/assets/filters":{"get":{"description":"Returns a list of valid field names that can be used for filtering assets using RSQL.\nEach field includes its name, data type, and which asset types it applies to.\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"getFilterFieldsTenant","parameters":[{"description":"The unique identifier of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Comma-separated list of asset types to filter the available filter fields","example":"container_images","in":"query","name":"asset_types","schema":{"type":"string"}},{"description":"Number of results to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/FilterFieldsResponse"}}},"description":"List of available filter fields","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get available filter fields (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/tenants/{tenant_id}/inventory/assets/filters/{filter_id}/values":{"get":{"description":"Returns a list of distinct values for a specific filter field.\nUseful for building autocomplete functionality in filter UIs.\n\nUse the UUID from the filter fields list endpoint to identify which field to query.\n\nFor object filter values, both the keys and values are returned.\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"getFilterValuesTenant","parameters":[{"description":"The unique identifier of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"The UUID of the filter field to get values for (from the filter fields list endpoint)","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","in":"path","name":"filter_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Full text search term to filter the list of values. If keys_only is true, this will filter the keys of the object filter values. If key is provided, this will filter the value for the specific key of the object filter values.","example":"prod","in":"query","name":"q","schema":{"maxLength":100,"type":"string"}},{"description":"Number of results to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}},{"description":"Return only the keys of the object filter values","in":"query","name":"keys_only","schema":{"type":"boolean"}},{"description":"Return only the value for a specific key of the object filter values","in":"query","name":"key","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/FilterValuesResponse"}}},"description":"List of filter values","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get filter value suggestions (autocomplete) (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/tenants/{tenant_id}/inventory/assets/groups":{"get":{"description":"Returns a list of valid group field names that can be used for grouping assets.\nEach field includes its name, data type, and which asset types it applies to.\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"getGroupFieldsTenant","parameters":[{"description":"The unique identifier of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Comma-separated list of asset types to filter the available group fields","example":"container_images","in":"query","name":"asset_types","schema":{"type":"string"}},{"description":"Number of results to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GroupFieldsResponse"}}},"description":"List of available group fields","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get available group fields (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/tenants/{tenant_id}/inventory/assets/groups/{group_field_id}/values":{"get":{"description":"Returns aggregated values for a specific group field id, showing the count of assets\nfor each distinct value.\n\nUse the UUID from the group fields list endpoint to identify which field to query.\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"getGroupValuesTenant","parameters":[{"description":"The unique identifier of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"The UUID of the group field to get values for (from the group fields list endpoint)","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","in":"path","name":"group_field_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Comma-separated list of asset types to filter the aggregation","example":"container_images","in":"query","name":"asset_types","schema":{"type":"string"}},{"$ref":"#/components/parameters/RsqlFilterGroupValues"},{"$ref":"#/components/parameters/SortGroupValues"},{"description":"Number of results to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}},{"$ref":"#/components/parameters/MetaFieldsGroupValues"},{"$ref":"#/components/parameters/AggregateGroupValues"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GroupValuesResponse"}}},"description":"List of group values with aggregated metadata","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get group value aggregation (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/tenants/{tenant_id}/inventory/assets/searches":{"post":{"description":"Initiates an asynchronous search for assets and returns a redirect to the search results endpoint\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"createAssetSearchTenant","parameters":[{"description":"The unique identifier of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CreateSearchRequestBody"}}}},"responses":{"302":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"jsonapi":{"additionalProperties":false,"properties":{"version":{"type":"string"}},"type":"object"}},"type":"object"}}},"description":"Found - Redirects to search results endpoint","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"description":"URL to retrieve search results","schema":{"format":"uri","type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create an asset search (asynchronous) (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/tenants/{tenant_id}/inventory/assets/searches/{search_id}/results":{"get":{"description":"Gets paginated results for a previously initiated asset search\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"getAssetSearchResultsTenant","parameters":[{"description":"The unique identifier of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/SearchId"},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Comma-separated sort fields. Prefix with `-` for descending order.\n\n**Supported fields:**\n- `created_at` - Asset creation timestamp\n- `updated_at` - Asset last update timestamp\n- `type` - Asset type (container_images)\n- `class` - Asset class\n- `risk_score` - Asset risk score (max across project sources)\n- `issues` - Issue counts by severity (critical, high, medium, low)\n- `built_at` - Image build timestamp (container images only)\n- `last_scan` - Last scan timestamp\n","in":"query","name":"sort","schema":{"example":"-created_at","type":"string"}},{"description":"Number of results to return","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Cursor for next page","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for previous page","in":"query","name":"ending_before","schema":{"type":"string"}},{"$ref":"#/components/parameters/SparseFieldsets"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AssetListResponse"}}},"description":"Search results retrieved successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Retrieve asset search results (asynchronous) (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/tenants/{tenant_id}/inventory/assets/{asset_id}":{"get":{"description":"Retrieves a single asset by its unique identifier.\nThe response includes the asset's details in JSON:API format.\nThe asset type is determined from the database and the appropriate\ndetails are returned polymorphically.\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"getAssetTenant","parameters":[{"description":"The unique identifier of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the asset","in":"path","name":"asset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"$ref":"#/components/parameters/SparseFieldsets"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/PolymorphicAssetData"},"links":{"properties":{"self":{"description":"Link to the current document","format":"uri","type":"string"}},"type":"object"}},"required":["data"],"type":"object"}}},"description":"Asset retrieved successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get a single asset by ID (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"},"patch":{"description":"Partially updates an asset's attributes.\nSupports updating class, labels (add/remove), and tags (add/remove).\nAt least one attribute must be provided in the request.\n\n#### Required permissions\n\n- `Edit Tenant Details (tenant.edit)`","operationId":"updateAssetTenant","parameters":[{"description":"The unique identifier of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the asset","in":"path","name":"asset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AssetPatchRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/PolymorphicAssetData"},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"},"links":{"description":"Self-referencing link","properties":{"self":{"description":"Link to the current resource","format":"uri","type":"string"}},"required":["self"],"type":"object"}},"required":["data"],"type":"object"}}},"description":"Asset updated successfully","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update asset attributes (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"asset","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/tenants/{tenant_id}/inventory/assets/{asset_id}/relationships/projects":{"get":{"description":"Retrieves a paginated list of Snyk projects linked to this asset with full attributes.\nReturns the `id`, `type`, and `attributes` of each related project.\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"listAssetProjectsTenant","parameters":[{"description":"The unique identifier of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the asset","in":"path","name":"asset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}},{"description":"Maximum number of results to return per page","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}},{"description":"Filter projects by canonical status.\n- `with`: Returns all projects (canonical attribute is populated).\n- `only`: Returns only canonical projects (those used for vulnerability counts).\n- `none`: Returns only non-canonical projects.\nWhen omitted, returns all projects without canonical filtering.\n","in":"query","name":"canonical","schema":{"enum":["with","only","none"],"type":"string"}},{"description":"Filter projects by target ID. When provided, returns only projects that belong to\nthe specified target. When omitted, returns projects from all targets.\n","in":"query","name":"target_id","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ProjectRelationshipListResponse"}}},"description":"Successfully retrieved linked projects","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"List projects for an asset (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"project","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/tenants/{tenant_id}/inventory/assets/{asset_id}/relationships/targets":{"get":{"description":"Retrieves a paginated list of Snyk targets linked to this asset with full attributes.\nReturns the `id`, `type`, and `attributes` of each related target.\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`","operationId":"listAssetTargetsTenant","parameters":[{"description":"The unique identifier of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier of the asset","in":"path","name":"asset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The requested API version","in":"query","name":"version","schema":{"example":"2024-10-15","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"description":"Cursor for fetching the next page of results","in":"query","name":"starting_after","schema":{"type":"string"}},{"description":"Cursor for fetching the previous page of results","in":"query","name":"ending_before","schema":{"type":"string"}},{"description":"Maximum number of results to return per page","in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":10,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/TargetRelationshipListResponse"}}},"description":"Successfully retrieved linked targets","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"List targets for an asset (Early Access)","tags":["Inventory Assets"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"target","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/tenants/{tenant_id}/memberships":{"get":{"description":"Returns all memberships of the tenant\n\n#### Required permissions\n\n- `View Tenant Memberships (tenant.membership.read)`","operationId":"getTenantMemberships","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/TenantId__0"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortBy"},{"description":"Order in which results are returned.","example":"ASC","in":"query","name":"sort_order","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}},{"$ref":"#/components/parameters/EmailFilter"},{"$ref":"#/components/parameters/UserIdSearchFilter"},{"$ref":"#/components/parameters/NameFilter"},{"$ref":"#/components/parameters/UsernameFilter"},{"$ref":"#/components/parameters/ConnectionTypeFilter"},{"$ref":"#/components/parameters/RoleFilter"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ListTenantMembershipResponseData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object"}}},"description":"List of tenant memberships is returned","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"summary":"Get all memberships of the tenant (Early Access)","tags":["Tenants"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-05-09~experimental","2024-09-03~beta"],"x-snyk-api-resource":"memberships","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-09-03~beta","x-stability-level":"beta"}},"/tenants/{tenant_id}/memberships/{membership_id}":{"delete":{"description":"Delete an individual tenant membership for a single user.\n\n#### Required permissions\n\n- `View Tenant Memberships (tenant.membership.read)`\n\n- `Delete Tenant Memberships (tenant.membership.delete)`","operationId":"deleteTenantMembership","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/MembershipId"},{"$ref":"#/components/parameters/TenantId__0"}],"responses":{"204":{"description":"successfully deleting an individual membership for a single user","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"$ref":"#/components/headers/LocationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete an individual tenant membership for a single user. (Early Access)","tags":["Tenants"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-06-04~experimental","2024-09-03~beta"],"x-snyk-api-resource":"memberships","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-09-03~beta","x-stability-level":"beta"},"patch":{"description":"Update the tenant membership with the new role\n\n#### Required permissions\n\n- `View Tenant Details (tenant.read)`\n\n- `View Tenant Memberships (tenant.membership.read)`\n\n- `Edit Tenant Memberships (tenant.membership.edit)`","operationId":"updateTenantMembership","parameters":[{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/TenantId__0"},{"$ref":"#/components/parameters/MembershipId"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/UpdateTenantMembershipRequestData"}},"required":["data"],"type":"object"}}}},"responses":{"204":{"description":"successfully updated the tenant membership","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update tenant membership (Early Access)","tags":["Tenants"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-06-09~experimental","2024-09-03~beta"],"x-snyk-api-resource":"memberships","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-09-03~beta","x-stability-level":"beta"}},"/tenants/{tenant_id}/roles":{"get":{"description":"List all available roles for a given tenant.\n\n#### Required permissions\n\n- `View Tenant Roles (tenant.roles.read)`","operationId":"listTenantRoles","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Unique identifier of the tenant.","in":"path","name":"tenant_id","required":true,"schema":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}},{"description":"Role name filter.","in":"query","name":"name","schema":{"example":"examplename","type":"string"}},{"$ref":"#/components/parameters/Custom"},{"$ref":"#/components/parameters/AssignableByMe"},{"$ref":"#/components/parameters/ExpandPermissions"},{"$ref":"#/components/parameters/StartingAfter"},{"$ref":"#/components/parameters/EndingBefore"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/TenantRoleResponseData"},"type":"array"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/PaginatedLinks"},"meta":{"$ref":"#/components/schemas/TenantRolesExternalMeta"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"Returns an array of roles that are the roles on a Tenant.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"List all available roles for a given tenant (Early Access)","tags":["TenantRole"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"tenant_roles","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"},"post":{"description":"Create a custom tenant role for a given tenant.\n\n#### Required permissions\n\n- `View Tenant Roles (tenant.roles.read)`\n\n- `Create Tenant Roles (tenant.roles.create)`","operationId":"createTenantRole","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Unique identifier of the tenant.","in":"path","name":"tenant_id","required":true,"schema":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/CreateTenantRoleRequestAttributes"},"type":{"$ref":"#/components/schemas/TenantRoleType20241015"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"201":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/TenantRoleResponseData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"required":["data","jsonapi","links"],"type":"object"}}},"description":"Tenant role successfully created.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"location":{"schema":{"type":"string"}},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Create a custom tenant role for a given tenant (Early Access)","tags":["TenantRole"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"tenant_roles","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}},"/tenants/{tenant_id}/roles/{role_id}":{"delete":{"description":"Delete a custom tenant role in a given tenant\n\n#### Required permissions\n\n- `View Tenant Roles (tenant.roles.read)`\n\n- `Delete Tenant Roles (tenant.roles.delete)`","operationId":"deleteTenantRole","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Unique identifier of the tenant.","in":"path","name":"tenant_id","required":true,"schema":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}},{"$ref":"#/components/parameters/RoleId"}],"responses":{"204":{"description":"Tenant role successfully deleted.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Delete a specific tenant role by its id and its tenant id. (Early Access)","tags":["TenantRole"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"tenant_roles","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"},"get":{"description":"Return a role from a tenant by the tenant and role id with its details and permissions.\n\n#### Required permissions\n\n- `View Tenant Roles (tenant.roles.read)`","operationId":"getTenantRole","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Unique identifier of the tenant.","in":"path","name":"tenant_id","required":true,"schema":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}},{"$ref":"#/components/parameters/RoleId"},{"$ref":"#/components/parameters/HasUsersAssigned"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/TenantRoleResponseData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returns the requested role.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Return a specific role by its id and its tenant id. (Early Access)","tags":["TenantRole"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"tenant_roles","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"},"patch":{"description":"Update attributes of a custom tenant role in a given tenant\n\n#### Required permissions\n\n- `View Tenant Roles (tenant.roles.read)`\n\n- `Edit Tenant Roles (tenant.roles.edit)`","operationId":"updateTenantRole","parameters":[{"$ref":"#/components/parameters/Version"},{"description":"Unique identifier of the tenant.","in":"path","name":"tenant_id","required":true,"schema":{"example":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}},{"$ref":"#/components/parameters/RoleId"},{"$ref":"#/components/parameters/ForceUpdate"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"additionalProperties":false,"properties":{"attributes":{"$ref":"#/components/schemas/UpdateTenantRoleRequestAttributes"},"id":{"$ref":"#/components/schemas/RoleId"},"type":{"$ref":"#/components/schemas/TenantRoleType20241015"}},"required":["type","attributes"],"type":"object"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/TenantRoleResponseData"},"jsonapi":{"$ref":"#/components/schemas/JsonApi"},"links":{"$ref":"#/components/schemas/SelfLink"}},"type":"object"}}},"description":"Returns the updated role.","headers":{"deprecation":{"$ref":"#/components/headers/DeprecationHeader"},"snyk-request-id":{"$ref":"#/components/headers/RequestIdResponseHeader"},"snyk-version-lifecycle-stage":{"$ref":"#/components/headers/VersionStageResponseHeader"},"snyk-version-requested":{"$ref":"#/components/headers/VersionRequestedResponseHeader"},"snyk-version-served":{"$ref":"#/components/headers/VersionServedResponseHeader"},"sunset":{"$ref":"#/components/headers/SunsetHeader"}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}},"summary":"Update a specific tenant role by its id and its tenant id. (Early Access)","tags":["TenantRole"],"x-snyk-api-lifecycle":"released","x-snyk-api-releases":["2024-10-15~beta"],"x-snyk-api-resource":"tenant_roles","x-snyk-api-stability":"beta","x-snyk-api-version":"2024-10-15~beta","x-stability-level":"beta"}}},"security":[{"APIToken":[]},{"BearerAuth":[]}],"servers":[{"description":"Snyk REST API","url":"https://api.snyk.io/rest"}],"tags":[{"description":"Asset management operations","name":"Assets"},{"description":"The OpenAPI specification for pat-service.","name":"OpenAPI"}],"x-snyk-api-version":"2024-10-15"}