Entitlements (v1)

This document uses the v1 API. For more details, see the v1 API.

List all entitlements

Required permissions

• View Organization

• View Entitlements

get

/org/{orgId}/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

Header parameters

Content-Typestring · enumrequired

Example: application/json

Options: application/json

Responses

application/json; charset=utf-8

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.snyk.io/v1/org/{orgId}/entitlements' \
  --header 'Content-Type: application/json'

200

200

{
  "licenses": true,
  "reports": true,
  "fullVulnDB": false
}

Get an organization's entitlement value

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

Required permissions

• View Organization

• View Entitlements

get

/org/{orgId}/entitlement/{entitlementKey}

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.

Header parameters

Content-Typestring · enumrequired

Example: application/json

Options: application/json

Responses

application/json; charset=utf-8

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.snyk.io/v1/org/{orgId}/entitlement/{entitlementKey}' \
  --header 'Content-Type: application/json'

200

200

true