Capability library / Application package

Snyk package v1.0.0

Snyk: read projects, issues and suppression records; update project settings; suppress or reveal findings; and delete monitored projects.

Review state: Reviewed · Distributable: yes, digest matches the release manifest

This page describes AAES Govern’s controls. AAES Operate has private-work permissions, operational reviews and recorded-spend limits; it does not include Govern. About AAES Govern

Before you enable this package

The endpoint host 'snyk-api.invalid' is a reserved .invalid placeholder that fails closed until you substitute the real host in both the endpoint URLs and the egress allowlist.

Read each action's effects and exclusions below. Before installation, also read the complete package requirements, including credential issuance, scope, expiry, and provider permissions. These are deployment prerequisites, not capabilities this package supplies.

Capabilities (7)

Each capability below is one registered operation. The complete package JSON includes its exact network destination allowlist. The repository stores it at packs/snyk.json and embeds a copy in the release binary.

Risk tiers. R0 is the minimum for reads. R2 is the minimum for write, create, update, execute, and invoke. R3 is the minimum for delete, send, pay, deploy, approve, share, and transfer. Operators can raise these levels. A minimum tier does not measure the operation's business or confidentiality risk.

On supported execution paths routed through AAES Govern, the R3 actions listed below require approval by an authorized person. Bypass paths and observation-only registrations are outside that guarantee. A provider's restoration feature does not remove this approval requirement. A provider-side approval, such as approving a GitLab merge request, is also separate from AAES Govern human approval. The capability matrix shows which execution paths are implemented, restricted to lab use, or refused at startup. Live compatibility must be tested in your environment.

Field guide. Endpoint is the service address and request method. Connector is the adapter that makes the call. Custody describes how the credential is held; the credential reference identifies the value to resolve. Data class sets handling requirements: pii means personal data, financial means financial records, and internal means internal organizational data.

snyk.projects.read v1.0.0R0

Kind
tool
Action
read
Endpoint
GET https://snyk-api.invalid/rest/orgs/ORG_ID/projects?version=2024-10-15
Connector
http
Custody
customer_vault
Credential ref
secret-ref-snyk-service-account-token
Data class
internal

Read projects.

List the projects in one Snyk organization via the versioned REST API — a collection read of project names, origins, types and issue counts, cursor-paginated per Snyk's REST pagination. The ?version=2024-10-15 query parameter is part of the registered endpoint: Snyk versions each REST endpoint by date and recommends pinning one. ORG_ID is a placeholder to bind before enabling; the host is a reserved placeholder to substitute with the tenant's regional base URL.

snyk.project.issues.read v1.0.0R0

Kind
tool
Action
read
Endpoint
POST https://snyk-api.invalid/v1/org/ORG_ID/project/PROJECT_ID/aggregated-issues
Connector
http
Custody
customer_vault
Credential ref
secret-ref-snyk-service-account-token
Data class
internal

Read project issues.

Aggregate a project's issues (vulnerabilities and license issues) via the v1 API. This is a POST-with-query-body endpoint used read-only: the request body carries filters and the includeDescription/includeIntroducedThrough flags, and the operation mutates nothing, so it registers as read at the minimum R0 tier. Responses include severity, CVE/CWE identifiers, exploit maturity and ignore status — security posture data classified as internal data. ORG_ID and PROJECT_ID are placeholders to bind before enabling.

snyk.ignores.read v1.0.0R0

Kind
tool
Action
read
Endpoint
GET https://snyk-api.invalid/v1/org/ORG_ID/project/PROJECT_ID/ignores
Connector
http
Custody
customer_vault
Credential ref
secret-ref-snyk-service-account-token
Data class
pii

Read ignores.

List the ignores on one project — a collection read of which findings are suppressed, with reason and expiry, and of BY WHOM each ignore was set: the returned creator identifiers are personal data, so the capability is classified as pii (personal data). Snyk's reference notes that ignores from .snyk policy files and from org policies are NOT included in this listing, so this read is not a complete suppression audit on its own. ORG_ID and PROJECT_ID are placeholders to bind before enabling.

snyk.ignore.create v1.0.0R2

Kind
tool
Action
create
Endpoint
POST https://snyk-api.invalid/v1/org/ORG_ID/project/PROJECT_ID/ignore/ISSUE_ID
Connector
http
Custody
customer_vault
Credential ref
secret-ref-snyk-service-account-token
Data class
internal

Create ignore.

Suppress a vulnerability or license issue by creating an ignore. The body accepts ignorePath, reason, reasonType, disregardIfFixable, and optional expires. Without expires, suppression is permanent; the registration does not restrict the body.

The ignore can later be removed, so create is registered at R2. Suppression removes a finding from reporting and gate review while it is active. Require a person to review the operation and limit policy to named actors and projects.

Bind ORG_ID, PROJECT_ID, and ISSUE_ID before enabling.

snyk.ignore.delete v1.0.0R3

Kind
tool
Action
delete
Endpoint
DELETE https://snyk-api.invalid/v1/org/ORG_ID/project/PROJECT_ID/ignore/ISSUE_ID
Connector
http
Custody
customer_vault
Credential ref
secret-ref-snyk-service-account-token
Data class
internal

Delete ignore.

Remove an ignore and make its suppressed security finding visible again. This deletes the ignore record; restoring suppression requires creating a new record.

Registered as delete at R3, even though exposing a finding is generally the safer security outcome. AAES approval classification is separate from whether the provider offers a later way to restore suppression. Policy cannot lower the minimum tier.

Bind ORG_ID, PROJECT_ID, and ISSUE_ID before enabling.

snyk.project.update v1.0.0R2

Kind
tool
Action
update
Endpoint
PATCH https://snyk-api.invalid/rest/orgs/ORG_ID/projects/PROJECT_ID?version=2024-10-15
Connector
http
Custody
customer_vault
Credential ref
secret-ref-snyk-service-account-token
Data class
internal

Update project.

Update a project via the versioned REST API (JSON:API PATCH, Content-Type application/vnd.api+json): tags, business criticality, environment, lifecycle, owner and test frequency. Registered as update at the minimum R2 tier.

Request limits: this registration does not restrict which attributes the PATCH document changes — lowering test frequency or criticality alters the project's security cadence and reporting, so policy should scope the capability and require review for cadence changes. ORG_ID and PROJECT_ID are placeholders; the pinned ?version=2024-10-15 is part of the registered endpoint.

snyk.project.delete v1.0.0R3

Kind
tool
Action
delete
Endpoint
DELETE https://snyk-api.invalid/rest/orgs/ORG_ID/projects/PROJECT_ID?version=2024-10-15
Connector
http
Custody
customer_vault
Credential ref
secret-ref-snyk-service-account-token
Data class
internal

Delete project.

Delete a project from the Snyk organization via the versioned REST API, removing the monitored project and its issue history from Snyk (the underlying repository is untouched; re-importing creates a NEW project, not a restoration). Registered as delete at the minimum R3 tier: delete is one of the designated actions requiring human approval.

On supported execution paths mediated by AAES Govern, irreversible actions require approval by an authorized person; this does not prevent calls through bypass or observation-only paths. ORG_ID and PROJECT_ID are placeholders; the pinned ?version=2024-10-15 is part of the registered endpoint.

Credential reference

The credential field names a reference rather than containing credential material. Packs are designed not to contain secrets; the format checks cover only known credential formats and cannot prove that arbitrary text contains no secrets. Installing a package registers its capabilities. Configure the provider credentials, endpoints, and network access, then test the integration in your environment before enabling it.

Reference
secret-ref-snyk-service-account-token
Custody
customer_vault
Injection
header (Authorization)

Configure the value and injection format specified in the package. Assign responsibility for credential rotation and revocation, restrict provider permissions, and keep credential material out of logs and responses.

Complete credential requirements

A Snyk service account API token, held in the client's own secret manager. Token issuance is external: an administrator creates a service account for the org (or group) in Snyk's settings and stores the API token under this reference; personal user API tokens also work but bind the integration to an individual's account and permissions — prefer a service account. The stored material must be the complete Authorization header value: the scheme 'token', one separating space, then the API token — 'token <API token>'.

Per the retrieved Snyk authentication page, direct API calls authenticate with an 'Authorization: token <API_TOKEN>' header (the 'bearer' scheme is for Snyk Apps OAuth access tokens, not this credential); the REST reference's placeholder 'Authorization: YOUR_API_KEY' example is not the scheme. Expiry and revocation behavior: Snyk API tokens do not carry a caller-chosen TTL — a token remains valid until it is rotated or the owning service account is deleted/disabled, and rotating a token invalidates the previous value; there is no session expiry to rely on, so rotation cadence is the custody job's responsibility and a leaked value must be rotated explicitly.

Note the gap: changing the service account's role narrows FUTURE authorization decisions but does not invalidate the token value itself.

Least privilege: give the service account an org role with only the permissions the enabled capabilities need (View Organization, View Project, View Project Ignores, plus — according to the reviewed ignores-v1 reference, which lists required permissions per operation — 'Create new project ignores' only if ignore creation is enabled and 'Remove Project Ignores' only if ignore removal is enabled; 'Edit Project Ignores' covers the PUT modify operation this pack does not register); for project deletion, grant the narrowest documented project-delete permission rather than blanket Organization Admin — the retrieved REST projects reference rendered the DELETE operation but no required-permissions list for it during the documented review, so the exact minimum role for deletion must be confirmed against Snyk's permission documentation before the delete capability is enabled — and never a group-admin token.

Snyk rate-limits to 1620 requests per minute per API key; an over-limit call returns 429 and is retried later, not retried in a tight loop.

Executor hygiene: the value must live only in executor memory for the lifetime of a call, must never be written to logs, traces or diagnostics, and must not appear in crash dumps; a deployment that cannot meet that bar must not enable the pack.

Resources

  • snyk-org (api, pii): https://snyk-api.invalid/rest/orgs/ORG_ID

Technical package and review record

Complete provider requirements and exclusions

The endpoint host 'snyk-api.invalid' is a reserved non-production placeholder (an RFC 2606 reserved TLD): substitute the regional base URL for the customer's Snyk tenant before enabling — Snyk documents api.snyk.io/rest, api.us.snyk.io/rest, api.eu.snyk.io/rest and api.au.snyk.io/rest per region, and the API is HTTPS-only. Substitute in every endpoint, in the resource locator and in every egress allowlist entry; the allowlist matches exactly, so all three move together, and substitution is a required deployment step. ORG_ID, PROJECT_ID and ISSUE_ID in the endpoint paths are placeholders to bind to concrete ids before enabling.

This pack mixes two documented surfaces, project management and project listing register the versioned REST API (JSON:API; every REST endpoint below pins the ?version=2024-10-15 query parameter in the registered endpoint, per Snyk's versioning guidance that integrations send a dated version), while ignore management and issue aggregation register the v1 API, which Snyk's own reference states will eventually be deprecated in favor of the REST API — re-review on pack version bump as those operations move.

Approval classification: collection reads and the POST-with-query-body issue aggregation (a read-only POST whose body carries filters and includeDescription/includeIntroducedThrough flags — it mutates nothing) sit at the minimum R0 tier. Project update is a JSON:API PATCH registered as update at the minimum R2 tier; Consequential effects: the PATCH body can also alter tags, business criticality, environment, lifecycle and test frequency, and this registration does not restrict which attributes a caller changes — test-frequency or criticality changes alter security cadence and reporting, so policy should scope the capability.

Creating an issue ignore is registered as create at the minimum R2 tier because the ignore can be removed again — but an ignore SUPPRESSES a vulnerability or license finding from reporting, and a permanent ignore (no expires attribute) suppresses it indefinitely: the minimum R2 tier is a minimum and policy should require a person and scope this to named actors. Removing an ignore is an HTTP DELETE registered at the minimum R3 tier under the action minimum; its effect is re-exposure of the finding, not suppression.

Project deletion sits at the minimum R3 tier: delete is one of the designated actions requiring human approval and removes the project and its scan history from Snyk.

Documented exclusions: this pack does not register organization deletion (DELETE /v1/org/{orgId}), member and role management and user provisioning/invitation (access-granting operations needing their own review), importing new targets from source control (POST /v1/org/{orgId}/integrations/.../import — reaches into the connected repository), moving a project to another organization, webhook CRUD, service account administration, and Snyk's reporting/groups endpoints. Source note: the Snyk authentication page was retrieved during the documented review and establishes the 'token <API token>' Authorization scheme for direct API calls (the 'bearer' scheme belongs to Snyk Apps OAuth tokens); the registered REST operations were verified against the fetched projects reference, whose request examples render the pinned dated version parameter.

Download the complete package JSON for exact network allowlists, credential requirements, exclusions, and setup notes. Read these requirements before installation.

The full documentation review record is supplied in the evaluation package. The evaluation package runs in your environment and comes only with the paid design partnership. This page reproduces the source links and review block; the full record is available for evaluation. Discuss a design partnership to inspect it before installation.

Review block

This section reproduces the review block recorded in the pack file. The evidence and approval record is separate: for a reviewed pack, it is in the evaluation materials and in the release binary's embedded assets.

Review completed: 2026-09-22

5 sources, retrieved 2026-09-21

Current documentation links are navigation aids. They do not change the package, its historical sources or its review date. Review dates describe a documentation review, not a live integration test. No package is provider-endorsed or yet tested against a live provider tenant.

Release identity

SHA-256 of the pack file bytes: e24303512b1e075c09a77b66427af4bf3e49ecaf1a3a064913a53c1e56c7f060

Distributable: yes, digest matches the release manifest. Editing a package changes its release identity. A deployment plan checks its own file digests; it does not restore reviewed status or authenticate approval.