Get organization entitlements

Get all entitlements for an organization

get
http://entitlements-api.entitlements.svc.cluster.local:8080/v2/internal/entitlements

Response

application/json

A list of all entitlements for the organization

OrgEntitlements

billing_and_meteringobjectrequired
Show Child Parameters
kong_identityobjectrequired
Show Child Parameters
developer_portalobjectrequired
Show Child Parameters
catalogobjectrequired
Show Child Parameters
event_gatewayobjectrequired
Show Child Parameters
advanced_analyticsobjectrequired
Show Child Parameters
ai_gatewayobjectrequired
Show Child Parameters
dedicated_cloud_gatewayobjectrequired
Show Child Parameters
meshobjectrequired
Show Child Parameters
self_managed_gatewayobjectrequired
Show Child Parameters
serverless_gatewayobjectrequired
Show Child Parameters
kic_gatewayobjectrequired
Show Child Parameters
payload_captureobjectrequired
Show Child Parameters
get/internal/entitlements
 
application/json

Get default entitlements

Get all the default entitlements

get
http://entitlements-api.entitlements.svc.cluster.local:8080/v2/internal/entitlements/default

Response

application/json

A list of all entitlements for the organization

OrgEntitlements

billing_and_meteringobjectrequired
Show Child Parameters
kong_identityobjectrequired
Show Child Parameters
developer_portalobjectrequired
Show Child Parameters
catalogobjectrequired
Show Child Parameters
event_gatewayobjectrequired
Show Child Parameters
advanced_analyticsobjectrequired
Show Child Parameters
ai_gatewayobjectrequired
Show Child Parameters
dedicated_cloud_gatewayobjectrequired
Show Child Parameters
meshobjectrequired
Show Child Parameters
self_managed_gatewayobjectrequired
Show Child Parameters
serverless_gatewayobjectrequired
Show Child Parameters
kic_gatewayobjectrequired
Show Child Parameters
payload_captureobjectrequired
Show Child Parameters
get/internal/entitlements/default
 
application/json

Update default entitlements

Update default entitlements for new organizations

patch
http://entitlements-api.entitlements.svc.cluster.local:8080/v2/internal/entitlements/default

Body

application/json

Request body for updating entitlements

PartialOrgEntitlements

billing_and_meteringobject | null
Show Child Parameters
kong_identityobject | null
Show Child Parameters
developer_portalobject | null
Show Child Parameters
catalogobject | null
Show Child Parameters
event_gatewayobject | null
Show Child Parameters
advanced_analyticsobject | null
Show Child Parameters
ai_gatewayobject | null
Show Child Parameters
dedicated_cloud_gatewayobject | null
Show Child Parameters
meshobject | null
Show Child Parameters
self_managed_gatewayobject | null
Show Child Parameters
serverless_gatewayobject | null
Show Child Parameters
kic_gatewayobject | null
Show Child Parameters
payload_captureobject | null
Show Child Parameters

Response

application/json

A list of all entitlements for the organization

OrgEntitlements

billing_and_meteringobjectrequired
Show Child Parameters
kong_identityobjectrequired
Show Child Parameters
developer_portalobjectrequired
Show Child Parameters
catalogobjectrequired
Show Child Parameters
event_gatewayobjectrequired
Show Child Parameters
advanced_analyticsobjectrequired
Show Child Parameters
ai_gatewayobjectrequired
Show Child Parameters
dedicated_cloud_gatewayobjectrequired
Show Child Parameters
meshobjectrequired
Show Child Parameters
self_managed_gatewayobjectrequired
Show Child Parameters
serverless_gatewayobjectrequired
Show Child Parameters
kic_gatewayobjectrequired
Show Child Parameters
payload_captureobjectrequired
Show Child Parameters
patch/internal/entitlements/default

Body

{ "billing_and_metering": { "enabled": true, "resources": { "data_retention_yrs": 2, "api_rate_limit_rps": 1000 } }, "kong_identity": { "enabled": false }, "developer_portal": { "enabled": true }, "catalog": { "enabled": true }, "event_gateway": { "resources": { "virtual_clusters_count": 10 } }, "advanced_analytics": { "enabled": true }, "ai_gateway": { "enabled": false }, "dedicated_cloud_gateway": { "enabled": true }, "mesh": { "enabled": true }, "self_managed_gateway": { "enabled": true, "resources": { "gateway_service_count": 2 } }, "serverless_gateway": { "enabled": false, "resources": { "control_plane_count": 10 } }, "kic_gateway": { "enabled": true }, "payload_capture": { "enabled": false } }
 
application/json

Get organization billing entitlements

Get billing entitlements for an organization

get
http://entitlements-api.entitlements.svc.cluster.local:8080/v2/internal/entitlements/{organizationId}/billing

Path Parameters

organizationIdstringrequired

ID of the organization.

Response

application/json

A list of partial entitlements for the organization

PartialOrgEntitlements

billing_and_meteringobject | null
Show Child Parameters
kong_identityobject | null
Show Child Parameters
developer_portalobject | null
Show Child Parameters
catalogobject | null
Show Child Parameters
event_gatewayobject | null
Show Child Parameters
advanced_analyticsobject | null
Show Child Parameters
ai_gatewayobject | null
Show Child Parameters
dedicated_cloud_gatewayobject | null
Show Child Parameters
meshobject | null
Show Child Parameters
self_managed_gatewayobject | null
Show Child Parameters
serverless_gatewayobject | null
Show Child Parameters
kic_gatewayobject | null
Show Child Parameters
payload_captureobject | null
Show Child Parameters
get/internal/entitlements/{organizationId}/billing
 
application/json

Update organization billing entitlements

Update billing entitlements for an organization

patch
http://entitlements-api.entitlements.svc.cluster.local:8080/v2/internal/entitlements/{organizationId}/billing

Path Parameters

organizationIdstringrequired

ID of the organization.

Body

application/json

Request body for updating entitlements

PartialOrgEntitlements

billing_and_meteringobject | null
Show Child Parameters
kong_identityobject | null
Show Child Parameters
developer_portalobject | null
Show Child Parameters
catalogobject | null
Show Child Parameters
event_gatewayobject | null
Show Child Parameters
advanced_analyticsobject | null
Show Child Parameters
ai_gatewayobject | null
Show Child Parameters
dedicated_cloud_gatewayobject | null
Show Child Parameters
meshobject | null
Show Child Parameters
self_managed_gatewayobject | null
Show Child Parameters
serverless_gatewayobject | null
Show Child Parameters
kic_gatewayobject | null
Show Child Parameters
payload_captureobject | null
Show Child Parameters

Response

application/json

A list of partial entitlements for the organization

PartialOrgEntitlements

billing_and_meteringobject | null
Show Child Parameters
kong_identityobject | null
Show Child Parameters
developer_portalobject | null
Show Child Parameters
catalogobject | null
Show Child Parameters
event_gatewayobject | null
Show Child Parameters
advanced_analyticsobject | null
Show Child Parameters
ai_gatewayobject | null
Show Child Parameters
dedicated_cloud_gatewayobject | null
Show Child Parameters
meshobject | null
Show Child Parameters
self_managed_gatewayobject | null
Show Child Parameters
serverless_gatewayobject | null
Show Child Parameters
kic_gatewayobject | null
Show Child Parameters
payload_captureobject | null
Show Child Parameters
patch/internal/entitlements/{organizationId}/billing

Body

{ "billing_and_metering": { "enabled": true, "resources": { "data_retention_yrs": 2, "api_rate_limit_rps": 1000 } }, "kong_identity": { "enabled": false }, "developer_portal": { "enabled": true }, "catalog": { "enabled": true }, "event_gateway": { "resources": { "virtual_clusters_count": 10 } }, "advanced_analytics": { "enabled": true }, "ai_gateway": { "enabled": false }, "dedicated_cloud_gateway": { "enabled": true }, "mesh": { "enabled": true }, "self_managed_gateway": { "enabled": true, "resources": { "gateway_service_count": 2 } }, "serverless_gateway": { "enabled": false, "resources": { "control_plane_count": 10 } }, "kic_gateway": { "enabled": true }, "payload_capture": { "enabled": false } }
 
application/json