Entitlements (v1)
Required permissions
-
View Organization
-
View Entitlements
Path parameters
orgIdstringRequiredExample:
The organization ID to list entitlements for. The API_KEY
must have access to this organization.
4a18d42f-0706-4ad0-b127-24078731fbed
Header parameters
Content-Typestring · enumRequiredExample:
application/json
Possible values: Responses
200Success
application/json; charset=utf-8
Responseall of
and
anyOptionalExample:
{"licenses":true,"reports":true,"fullVulnDB":false}
get
GET /v1/org/{orgId}/entitlements HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
200Success
{
"licenses": true,
"reports": true,
"fullVulnDB": false
}
It is possible to query an organization for a specific entitlement, getting its value
Required permissions
-
View Organization
-
View Entitlements
Path parameters
orgIdstringRequiredExample:
The organization ID to query the entitlement for. The API_KEY
must have access to this organization.
4a18d42f-0706-4ad0-b127-24078731fbed
entitlementKeyall ofRequired
The entitlement to query.
string · enumOptionalPossible values:
anyOptionalExample:
The entitlement to query.
reports
Header parameters
Content-Typestring · enumRequiredExample:
application/json
Possible values: Responses
200Success
application/json; charset=utf-8
ResponsestringExample:
true
get
GET /v1/org/{orgId}/entitlement/{entitlementKey} HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
200Success
true
Last updated
Was this helpful?