---
title: "Update default entitlements"
url: "https://nov18-dev.movespot.fyi/apis/internal-konnect-entitlements-v2-dev-2/versions/8ac3a2ff-729e-4b5c-8bc8-fdd7c238114d/operations/update-default-entitlements-internal"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-konnect-entitlements-v2-dev-2/versions/8ac3a2ff-729e-4b5c-8bc8-fdd7c238114d.md

# Update default entitlements

`PATCH` `/internal/entitlements/default`

Operation ID: `update-default-entitlements-internal`

Update default entitlements for new organizations

## Request body (required)

Content types: `application/json`

## Responses

- `200` - A list of all entitlements for the organization
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal Konnect Entitlements V2
  version: 2.0.5
servers:
  - url: http://entitlements-api.entitlements.svc.cluster.local:8080/v2
    description: Entitlements API server
paths:
  /internal/entitlements/default:
    patch:
      operationId: update-default-entitlements-internal
      summary: Update default entitlements
      description: Update default entitlements for new organizations
      requestBody:
        $ref: "#/components/requestBodies/OrgEntitlementsRequest"
      responses:
        "200":
          $ref: "#/components/responses/OrgEntitlementsResponse"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Entitlements
security:
  - systemAccountAccessToken: []
  - personalAccessToken: []
  - konnectAccessToken: []
components:
  requestBodies:
    OrgEntitlementsRequest:
      description: Request body for updating entitlements
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PartialOrgEntitlements"
          examples:
            OrgEntitlementsRequest:
              $ref: "#/components/examples/PartialOrgEntitlements"
  responses:
    OrgEntitlementsResponse:
      description: A list of all entitlements for the organization
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OrgEntitlements"
          examples:
            OrgEntitlementsResponse:
              $ref: "#/components/examples/OrgEntitlements"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    PartialOrgEntitlements:
      type: object
      properties:
        billing_and_metering:
          $ref: "#/components/schemas/PartialBillingAndMeteringConfig"
        kong_identity:
          $ref: "#/components/schemas/PartialKongIdentityConfig"
        developer_portal:
          $ref: "#/components/schemas/PartialDeveloperPortalConfig"
        catalog:
          $ref: "#/components/schemas/PartialCatalogConfig"
        event_gateway:
          $ref: "#/components/schemas/PartialEventGatewayConfig"
        advanced_analytics:
          $ref: "#/components/schemas/PartialAdvancedAnalyticsConfig"
        ai_gateway:
          $ref: "#/components/schemas/PartialAIGatewayConfig"
        dedicated_cloud_gateway:
          $ref: "#/components/schemas/PartialDedicatedCloudGatewayConfig"
        mesh:
          $ref: "#/components/schemas/PartialMeshConfig"
        self_managed_gateway:
          $ref: "#/components/schemas/PartialSelfManagedGatewayConfig"
        serverless_gateway:
          $ref: "#/components/schemas/PartialServerlessGatewayConfig"
        kic_gateway:
          $ref: "#/components/schemas/PartialKICGatewayConfig"
        payload_capture:
          $ref: "#/components/schemas/PartialPayloadCaptureConfig"
      minProperties: 1
    OrgEntitlements:
      type: object
      properties:
        billing_and_metering:
          $ref: "#/components/schemas/BillingAndMeteringConfig"
        kong_identity:
          $ref: "#/components/schemas/KongIdentityConfig"
        developer_portal:
          $ref: "#/components/schemas/DeveloperPortalConfig"
        catalog:
          $ref: "#/components/schemas/CatalogConfig"
        event_gateway:
          $ref: "#/components/schemas/EventGatewayConfig"
        advanced_analytics:
          $ref: "#/components/schemas/AdvancedAnalyticsConfig"
        ai_gateway:
          $ref: "#/components/schemas/AIGatewayConfig"
        dedicated_cloud_gateway:
          $ref: "#/components/schemas/DedicatedCloudGatewayConfig"
        mesh:
          $ref: "#/components/schemas/MeshConfig"
        self_managed_gateway:
          $ref: "#/components/schemas/SelfManagedGatewayConfig"
        serverless_gateway:
          $ref: "#/components/schemas/ServerlessGatewayConfig"
        kic_gateway:
          $ref: "#/components/schemas/KICGatewayConfig"
        payload_capture:
          $ref: "#/components/schemas/PayloadCaptureConfig"
      required:
        - billing_and_metering
        - kong_identity
        - developer_portal
        - catalog
        - event_gateway
        - advanced_analytics
        - ai_gateway
        - dedicated_cloud_gateway
        - mesh
        - self_managed_gateway
        - serverless_gateway
        - kic_gateway
        - payload_capture
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    PartialBillingAndMeteringConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable billing and metering feature
          type: boolean
          nullable: true
        resources:
          $ref: "#/components/schemas/PartialBillingAndMeteringResources"
      minProperties: 1
      nullable: true
    PartialKongIdentityConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Kong Identity feature
          type: boolean
          nullable: true
      minProperties: 1
      nullable: true
    PartialDeveloperPortalConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Developer Portal feature
          type: boolean
          nullable: true
        resources:
          $ref: "#/components/schemas/PartialDeveloperPortalResources"
      minProperties: 1
      nullable: true
    PartialCatalogConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Catalog feature
          type: boolean
          nullable: true
        resources:
          $ref: "#/components/schemas/PartialCatalogResources"
      minProperties: 1
      nullable: true
    PartialEventGatewayConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Event Gateway feature
          type: boolean
          nullable: true
        resources:
          $ref: "#/components/schemas/PartialEventGatewayResources"
      minProperties: 1
      nullable: true
    PartialAdvancedAnalyticsConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Advanced Analytics feature
          type: boolean
          nullable: true
      minProperties: 1
      nullable: true
    PartialAIGatewayConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable AI Gateway feature
          type: boolean
          nullable: true
      minProperties: 1
      nullable: true
    PartialDedicatedCloudGatewayConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Dedicated Cloud Gateway feature
          type: boolean
          nullable: true
      minProperties: 1
      nullable: true
    PartialMeshConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Mesh feature
          type: boolean
          nullable: true
        resources:
          $ref: "#/components/schemas/PartialMeshResources"
      minProperties: 1
      nullable: true
    PartialSelfManagedGatewayConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Self-Managed Gateway feature
          type: boolean
          nullable: true
        resources:
          $ref: "#/components/schemas/PartialSelfManagedGatewayResources"
      minProperties: 1
      nullable: true
    PartialServerlessGatewayConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Serverless Gateway feature
          type: boolean
          nullable: true
        resources:
          $ref: "#/components/schemas/PartialServerlessGatewayResources"
      minProperties: 1
      nullable: true
    PartialKICGatewayConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable KIC Gateway feature
          type: boolean
          nullable: true
        resources:
          $ref: "#/components/schemas/PartialKICGatewayResources"
      minProperties: 1
      nullable: true
    PartialPayloadCaptureConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Payload Capture feature
          type: boolean
          nullable: true
      minProperties: 1
      nullable: true
    BillingAndMeteringConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable billing and metering feature
          type: boolean
        resources:
          $ref: "#/components/schemas/BillingAndMeteringResources"
      required:
        - enabled
        - resources
    KongIdentityConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Kong Identity feature
          type: boolean
      required:
        - enabled
    DeveloperPortalConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Developer Portal feature
          type: boolean
        resources:
          $ref: "#/components/schemas/DeveloperPortalResources"
      required:
        - enabled
        - resources
    CatalogConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Catalog feature
          type: boolean
        resources:
          $ref: "#/components/schemas/CatalogResources"
      required:
        - enabled
        - resources
    EventGatewayConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Event Gateway feature
          type: boolean
        resources:
          $ref: "#/components/schemas/EventGatewayResources"
      required:
        - enabled
        - resources
    AdvancedAnalyticsConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Advanced Analytics feature
          type: boolean
      required:
        - enabled
    AIGatewayConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable AI Gateway feature
          type: boolean
      required:
        - enabled
    DedicatedCloudGatewayConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Dedicated Cloud Gateway feature
          type: boolean
      required:
        - enabled
    MeshConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Mesh feature
          type: boolean
        resources:
          $ref: "#/components/schemas/MeshResources"
      required:
        - enabled
        - resources
    SelfManagedGatewayConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Self-Managed Gateway feature
          type: boolean
        resources:
          $ref: "#/components/schemas/SelfManagedGatewayResources"
      required:
        - enabled
        - resources
    ServerlessGatewayConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Serverless Gateway feature
          type: boolean
        resources:
          $ref: "#/components/schemas/ServerlessGatewayResources"
      required:
        - enabled
        - resources
    KICGatewayConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable KIC Gateway feature
          type: boolean
        resources:
          $ref: "#/components/schemas/KICGatewayResources"
      required:
        - enabled
        - resources
    PayloadCaptureConfig:
      type: object
      properties:
        enabled:
          description: Enable or disable Payload Capture feature
          type: boolean
      required:
        - enabled
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    PartialBillingAndMeteringResources:
      type: object
      properties:
        data_retention_yrs:
          description: Data retention period in years
          type: integer
          nullable: true
        event_deduplication_window_hrs:
          description: Event deduplication window in hours
          type: integer
          nullable: true
        api_rate_limit_rps:
          description: API rate limit in requests per second
          type: integer
          nullable: true
      minProperties: 1
      nullable: true
    PartialDeveloperPortalResources:
      type: object
      properties:
        portal_count:
          description: Number of developer portals
          type: integer
          nullable: true
        published_api_count:
          description: Number of published APIs
          type: integer
          nullable: true
      minProperties: 1
      nullable: true
    PartialCatalogResources:
      type: object
      properties:
        governed_service_count:
          description: Number of governed services
          type: integer
          nullable: true
      minProperties: 1
      nullable: true
    PartialEventGatewayResources:
      type: object
      properties:
        virtual_clusters_count:
          description: Number of virtual clusters
          type: integer
          nullable: true
      minProperties: 1
      nullable: true
    PartialMeshResources:
      type: object
      properties:
        zone_count:
          description: Number of mesh zones
          type: integer
          nullable: true
      minProperties: 1
      nullable: true
    PartialSelfManagedGatewayResources:
      type: object
      properties:
        gateway_service_count:
          description: Number of self-managed gateway services
          type: integer
          nullable: true
      minProperties: 1
      nullable: true
    PartialServerlessGatewayResources:
      type: object
      properties:
        control_plane_count:
          description: Number of serverless gateway control planes
          type: integer
          nullable: true
      minProperties: 1
      nullable: true
    PartialKICGatewayResources:
      type: object
      properties:
        gateway_service_count:
          description: Number of KIC gateway services
          type: integer
          nullable: true
      minProperties: 1
      nullable: true
    BillingAndMeteringResources:
      type: object
      properties:
        data_retention_yrs:
          description: Data retention period in years
          type: integer
        event_deduplication_window_hrs:
          description: Event deduplication window in hours
          type: integer
        api_rate_limit_rps:
          description: API rate limit in requests per second
          type: integer
      required:
        - data_retention_yrs
        - event_deduplication_window_hrs
        - api_rate_limit_rps
    DeveloperPortalResources:
      type: object
      properties:
        portal_count:
          description: Number of developer portals
          type: integer
        published_api_count:
          description: Number of published APIs
          type: integer
      required:
        - portal_count
        - published_api_count
    CatalogResources:
      type: object
      properties:
        governed_service_count:
          description: Number of governed services
          type: integer
      required:
        - governed_service_count
    EventGatewayResources:
      type: object
      properties:
        virtual_clusters_count:
          description: Number of virtual clusters
          type: integer
      required:
        - virtual_clusters_count
    MeshResources:
      type: object
      properties:
        zone_count:
          description: Number of mesh zones
          type: integer
      required:
        - zone_count
    SelfManagedGatewayResources:
      type: object
      properties:
        gateway_service_count:
          description: Number of self-managed gateway services
          type: integer
      required:
        - gateway_service_count
    ServerlessGatewayResources:
      type: object
      properties:
        control_plane_count:
          description: Number of serverless gateway control planes
          type: integer
      required:
        - control_plane_count
    KICGatewayResources:
      type: object
      properties:
        gateway_service_count:
          description: Number of KIC gateway services
          type: integer
      required:
        - gateway_service_count
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    PartialOrgEntitlements:
      summary: Default entitlements request body
      value:
        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
    OrgEntitlements:
      summary: Default entitlements for an organization
      value:
        billing_and_metering:
          enabled: true
          resources:
            data_retention_yrs: 2
            event_deduplication_window_hrs: 24
            api_rate_limit_rps: 1000
        kong_identity:
          enabled: false
        developer_portal:
          enabled: true
          resources:
            portal_count: 3
            published_api_count: 10
        catalog:
          enabled: true
          resources:
            governed_service_count: 5
        event_gateway:
          enabled: false
          resources:
            virtual_clusters_count: 10
        advanced_analytics:
          enabled: true
        ai_gateway:
          enabled: false
        dedicated_cloud_gateway:
          enabled: true
        mesh:
          enabled: true
          resources:
            zone_count: 4
        self_managed_gateway:
          enabled: true
          resources:
            gateway_service_count: 2
        serverless_gateway:
          enabled: false
          resources:
            control_plane_count: 10
        kic_gateway:
          enabled: true
          resources:
            gateway_service_count: 3
        payload_capture:
          enabled: false
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
```
