---
title: "Update a plan"
method: PATCH
path: "/plans/{id}"
tags: ["plans"]
---

# Update a plan

`PATCH /plans/{id}`

Update one or more attributes of a plan

## Path parameters

- `id` string, required

## Request body

- PlanConfiguration — The configurable attribute of a plan
  - `id` string — Unique identifier to identify the plan.
  - `name` string — Name of the plan.
  - `attrs` object — Attribtues of a plan
    - `adcpools` number[] — An array of number for the available adcpools
    - `application_testing_allocated_users` number — Allocated application testing users
    - `application_testing_allocated_virtual_user_minutes` number — Allocated application testing virtual user minutes
    - `application_testing_virtual_user_minute_price` number — Price of virtual user minute
    - `data_transfer_allowance` number — Data transfer allowance
    - `data_transfer_allowance_period` number — Data transfer allowance period
    - `enable_application_testing` boolean — When enabled, application testing feature is enabled
    - `enable_app_shielding` boolean — When enabled, app shielding feature is enabled
    - `enable_autoscaler` boolean — When enabled, autoscaler feature is enabled
    - `enable_cdn` boolean — When enabled, CDN feature is enabled
    - `enable_custom_logs` boolean — When enabled, custom logs feature is enabled
    - `enable_geolocation` boolean — When enabled, geolocation feature is enabled
    - `enable_logs` boolean — When enabled, logs are enabled
    - `enable_optimization` boolean — When enabled, optimization feature is enabled
    - `enable_page_control_actions` string[] — An array of string for the available webcontrol actions
    - `enable_page_control_conditions` string[] — An array of string for the available webcontrol conditions
    - `enable_ranges` string[] — An array of string for the specified ranges
    - `enable_security_monitoring` boolean — When enabled, security monitoring feature is enabled
    - `enable_site_cache` boolean — When enabled, site cache feature is enabled
    - `enable_rate_limit` boolean — When enabled, rate limit feature is enabled
    - `site_cache_max_metadata_entries` number — Maximum site cache metadata entries
    - `enable_threats_portlet` boolean — When enabled, threats portlet feature is enabled
    - `enable_views` string[] — An array of string for different available views
    - `hosting_allowance` object[] — An array of string for different available views
      - `category` string, required — Category of hosting allowance
      - `count` number, required — Count of resources for the given category
      - `type` string[], required — Array of image types
    - `log_retention` object[] — An array of log retention plan configuration objects
      - `type` 'default' | 'cdn' | 'csp-reports' | 'pageviews' | 'proxy-logs' | 'events' | 'custom', required — Type of log retention
      - `online_days` number — Number of online days
      - `archive_days` number — Number of archive days
      - `online_space_allowance` number — Allowance for online space
      - `archive_space_allowance` number — Allowance for archive space
    - `maintenance_mode` boolean — When enabled, maintenance mode is enabled
    - `max_adc_count` number — Total number of ADCs
    - `alias_count` number — The number of aliases per an application
    - `monitoring_available` string[] — An array of string for the different available monitoring types
    - `monthly_bill` number — Total monthly bill
    - `monthly_data_transfer_limit` number — Total limit of the monthly data transfer
    - `num_page_controls` number — Number of page controls
    - `primary` boolean — When enabled, primary feature is enabled
    - `protections_available` string[] — An array of string for the available protection types
    - `site_cache_space` number — Available site cache space
    - `target_adc_count` number — Number of target ADC count
    - `shared_data_planes` string[] — An array of shared dataplane references
    - `dedicated_data_plane_count` number — Count of dedicated dataplane
  - `subject_type` string — The subject of the plan

## Response `200`

The plan was successfully updated

- Plan — State values for plan
  - `href` string — A reference to this plan
  - `id` string — Unique identifier to identify the plan.
  - `name` string — Name of the plan.
  - `attrs` object — Attribtues of a plan
    - `adcpools` number[] — An array of number for the available adcpools
    - `application_testing_allocated_users` number — Allocated application testing users
    - `application_testing_allocated_virtual_user_minutes` number — Allocated application testing virtual user minutes
    - `application_testing_virtual_user_minute_price` number — Price of virtual user minute
    - `data_transfer_allowance` number — Data transfer allowance
    - `data_transfer_allowance_period` number — Data transfer allowance period
    - `enable_application_testing` boolean — When enabled, application testing feature is enabled
    - `enable_app_shielding` boolean — When enabled, app shielding feature is enabled
    - `enable_autoscaler` boolean — When enabled, autoscaler feature is enabled
    - `enable_cdn` boolean — When enabled, CDN feature is enabled
    - `enable_custom_logs` boolean — When enabled, custom logs feature is enabled
    - `enable_geolocation` boolean — When enabled, geolocation feature is enabled
    - `enable_logs` boolean — When enabled, logs are enabled
    - `enable_optimization` boolean — When enabled, optimization feature is enabled
    - `enable_page_control_actions` string[] — An array of string for the available webcontrol actions
    - `enable_page_control_conditions` string[] — An array of string for the available webcontrol conditions
    - `enable_ranges` string[] — An array of string for the specified ranges
    - `enable_security_monitoring` boolean — When enabled, security monitoring feature is enabled
    - `enable_site_cache` boolean — When enabled, site cache feature is enabled
    - `enable_rate_limit` boolean — When enabled, rate limit feature is enabled
    - `site_cache_max_metadata_entries` number — Maximum site cache metadata entries
    - `enable_threats_portlet` boolean — When enabled, threats portlet feature is enabled
    - `enable_views` string[] — An array of string for different available views
    - `hosting_allowance` object[] — An array of string for different available views
      - `category` string, required — Category of hosting allowance
      - `count` number, required — Count of resources for the given category
      - `type` string[], required — Array of image types
    - `log_retention` object[] — An array of log retention plan configuration objects
      - `type` 'default' | 'cdn' | 'csp-reports' | 'pageviews' | 'proxy-logs' | 'events' | 'custom', required — Type of log retention
      - `online_days` number — Number of online days
      - `archive_days` number — Number of archive days
      - `online_space_allowance` number — Allowance for online space
      - `archive_space_allowance` number — Allowance for archive space
    - `maintenance_mode` boolean — When enabled, maintenance mode is enabled
    - `max_adc_count` number — Total number of ADCs
    - `alias_count` number — The number of aliases per an application
    - `monitoring_available` string[] — An array of string for the different available monitoring types
    - `monthly_bill` number — Total monthly bill
    - `monthly_data_transfer_limit` number — Total limit of the monthly data transfer
    - `num_page_controls` number — Number of page controls
    - `primary` boolean — When enabled, primary feature is enabled
    - `protections_available` string[] — An array of string for the available protection types
    - `site_cache_space` number — Available site cache space
    - `target_adc_count` number — Number of target ADC count
    - `shared_data_planes` string[] — An array of shared dataplane references
    - `dedicated_data_plane_count` number — Count of dedicated dataplane
  - `subject_type` string — The subject of the plan
  - `created` string — An iso8601 formatted timestamp
  - `created_by` integer — Reference to the user that created this plan
  - `updated` string — An iso8601 formatted timestamp
  - `updated_by` integer — Reference to the user that updated this plan

---

[API](https://skmtc.dev/webscale/apis/webscale-apis.md) · [All operations](https://skmtc.dev/webscale/apis/webscale-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/webscale/webscale-apis/revisions/c98d872b50cb/schema)