Entitlements (v1)

This document uses the v1 API, which will eventually be deprecated, as further Snyk developments are now focused on the REST API. For more details, see the v1 API.

List all entitlements

get

Required permissions

  • View Organization

  • View Entitlements

Path parameters
orgIdstringRequired

The organization ID to list entitlements for. The API_KEY must have access to this organization.

Example: 4a18d42f-0706-4ad0-b127-24078731fbed
Responses
Responseall of
and
anyOptionalExample: {"licenses":true,"reports":true,"fullVulnDB":false}
get
GET /v1/org/{orgId}/entitlements HTTP/1.1
Host: api.snyk.io
Accept: */*
200Success
{
  "licenses": true,
  "reports": true,
  "fullVulnDB": false
}

Get an organization's entitlement value

get

It is possible to query an organization for a specific entitlement, getting its value

Required permissions

  • View Organization

  • View Entitlements

Path parameters
orgIdstringRequired

The organization ID to query the entitlement for. The API_KEY must have access to this organization.

Example: 4a18d42f-0706-4ad0-b127-24078731fbed
entitlementKeyall ofRequired

The entitlement to query.

string · enumOptionalPossible values:
and
anyOptional

The entitlement to query.

Example: reports
Responses
ResponsestringExample: true
get
GET /v1/org/{orgId}/entitlement/{entitlementKey} HTTP/1.1
Host: api.snyk.io
Accept: */*
200Success
true

Last updated

Was this helpful?