Entitlements (v1)

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

List all entitlements

Required permissions

• View Organization

• View Entitlements

GEThttps://api.snyk.io/v1/org/{orgId}/entitlements

Path parameters

orgId*string

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

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

Header parameters

Response

200

Body

application/json; charset=utf-8

licenses*boolean

reports*boolean

fullVulnDB*boolean

any

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.snyk.io/v1/org/{orgId}/entitlements', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

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

GEThttps://api.snyk.io/v1/org/{orgId}/entitlement/{entitlementKey}

Path parameters

orgId*string

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

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

entitlementKey*all of

The entitlement to query.

Header parameters

Response

200

Body

application/json; charset=utf-8

string

Example: "true"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.snyk.io/v1/org/{orgId}/entitlement/{entitlementKey}', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

true