You are here

Home » API reference » Fastly 8.3

fastly.schema.yml in Fastly 8.3

config/schema/fastly.schema.yml

File

config/schema/fastly.schema.yml
View source 
  1. fastly.settings:

  2.   type: config_object

  3.   label: 'Fastly Settings'

  4.   mapping:

  5.     api_key:

  6.       type: string

  7.       label: 'Fastly API key'

  8.     cache_tag_hash_length:

  9.       type: integer

  10.       label: 'Cache tag hash length'

  11.     image_optimization:

  12.       type: boolean

  13.       label: 'Enable image optimization'

  14.     jpeg_quality:

  15.       type: integer

  16.       label: 'Default JPEG quality'

  17.     jpeg_type:

  18.       type: string

  19.       label: 'Default JPEG format'

  20.     optimize:

  21.       type: string

  22.       label: 'Optimal quality compression'

  23.     site_id:

  24.       type: string

  25.       label: 'Fastly Site ID'

  26.     service_id:

  27.       type: string

  28.       label: 'Fastly Service ID'

  29.     purge_logging:

  30.       type: boolean

  31.       label: 'Fastly purge logging'

  32.     purge_method:

  33.       type: string

  34.       label: 'Fastly Purge Method'

  35.     resize_filter:

  36.       type: string

  37.       label: 'Resize filter'

  38.     stale_while_revalidate:

  39.        type: boolean

  40.        label: 'Fastly stale while revalidate'

  41.     stale_while_revalidate_value:

  42.       type: integer

  43.       label: 'Fastly stale while revalidation value'

  44.     stale_if_error:

  45.       type: boolean

  46.       label: 'Fastly stale if error'

  47.     stale_if_error_value:

  48.       type: integer

  49.       label: 'Fastly stale if error value'

  50.     upscale:

  51.       type: boolean

  52.       label: 'Allow upscaling'

  53.     webhook_notifications:

  54.       type: array

  55.       label: 'Webhook notifications'

  56.     webhook_enabled:

  57.       type: boolean

  58.       label: 'Webhook enabled'

  59.     webhook_url:

  60.       type: string

  61.       label: 'Webhook URL'

  62.     webp:

  63.       type: boolean

  64.       label: 'Auto WebP'

  65.     webp_quality:

  66.       type: integer

  67.       label: 'Default WebP (lossy) quality'

  68. 

  69. fastly.edge_modules.blackfire_integration:

  70.   type: config_object

  71.   label: 'Blackfire integration'

  72.   mapping:

  73.     acl:

  74.       type: string

  75.       label: 'ACL'

  76. 

  77. fastly.edge_modules.cors_headers:

  78.   type: config_object

  79.   label: 'Fastly Core Headers'

  80.   mapping:

  81.     origin:

  82.       type: string

  83.       label: 'Origins allowed'

  84.     cors_allowed_methods:

  85.       type: string

  86.       label: 'Allowed HTTP methods'

  87.     cors_allowed_origins_regex:

  88.       type: string

  89.       label: 'Regex matching origins'

  90. 

  91. fastly.edge_modules.countryblock:

  92.   type: config_object

  93.   label: 'Fastly Country Block'

  94.   mapping:

  95.     countries:

  96.       type: string

  97.       label: 'Countries to block'

  98. 

  99. fastly.edge_modules.datadome_integration:

  100.   type: config_object

  101.   label: 'Fastly Datadome Integration'

  102.   mapping:

  103.     datadome_api_key:

  104.       type: string

  105.       label: 'API Key'

  106.     datadome_exclusion_ext:

  107.       type: string

  108.       label: 'Exclusion regex'

  109.     datadome_connect_timeout:

  110.       type: integer

  111.       label: 'Connection timeout'

  112.     datadome_first_byte_timeout:

  113.       type: integer

  114.       label: 'First byte timeout'

  115.     datadome_between_bytes_timeout:

  116.       type: integer

  117.       label: 'Between bytes timeout'

  118.     logging_endpoint:

  119.       type: string

  120.       label: 'Logging Endpoint for Debugging'

  121. 

  122. fastly.edge_modules.disable_cache:

  123.   type: config_object

  124.   label: 'Disable caching'

  125.   mapping:

  126.     rules:

  127.       type: sequence

  128.       label: 'Disable caching for'

  129.       sequence:

  130.         type: mapping

  131.         mapping:

  132.           pattern:

  133.             type: string

  134.             label: 'Path pattern'

  135.           mode:

  136.             type: string

  137.             label: 'Where to disable caching'

  138. 

  139. fastly.edge_modules.force_cache_miss_on_hard_reload_for_admins:

  140.   type: config_object

  141.   label: 'Hard Reload cache bypass for set of admin IPs'

  142.   mapping:

  143.     acl:

  144.       type: string

  145.       label: 'ACL'

  146. 

  147. fastly.edge_modules.increase_timeouts_long_jobs:

  148.   type: config_object

  149.   label: 'Increase timeouts for long running jobs'

  150.   mapping:

  151.     rules:

  152.      type: sequence

  153.      label: 'Timeout override rules'

  154.      sequence:

  155.        type: mapping

  156.        mapping:

  157.          pattern:

  158.            type: string

  159.            label: 'Path pattern'

  160.          timeout:

  161.            type: integer

  162.            label: 'Timeout in seconds'

  163. 

  164. fastly.edge_modules.netacea_integration:

  165.   type: config_object

  166.   label: 'Fastly Netacea Integration'

  167.   mapping:

  168.     api_key:

  169.       type: string

  170.       label: 'Netacea API Key'

  171.     secret:

  172.       type: string

  173.       label: 'Netacea Secret'

  174. 

  175. fastly.edge_modules.other_cms_integration:

  176.   type: config_object

  177.   label: 'Other CMS/backend integration'

  178.   mapping:

  179.     urls_dict:

  180.       type: string

  181.       label: 'URL prefixes Dictionary'

  182.     override_backend_hostname:

  183.       type: string

  184.       label: 'Override Backend Hostname'

  185. 

  186. fastly.edge_modules.redirect_hosts:

  187.   type: config_object

  188.   label: 'Redirect one domain to another'

  189.   mapping:

  190.     rules:

  191.       type: sequence

  192.       label: 'Rules'

  193.       sequence:

  194.         type: mapping

  195.         mapping:

  196.           source:

  197.             type: string

  198.             label: 'Incoming Domain/Host'

  199.           destination:

  200.             type: string

  201.             label: 'Destination domain/host'

  202.           ignore_path:

  203.             type: boolean

  204.             label: 'Ignore path'

  205. 

  206. fastly.edge_modules.url_rewrites:

  207.   type: config_object

  208.   label: 'URL rewrites'

  209.   mapping:

  210.     rules:

  211.       type: sequence

  212.       label: 'Rules'

  213.       sequence:

  214.         type: mapping

  215.         mapping:

  216.           source:

  217.             type: string

  218.             label: 'Source path'

  219.           destination:

  220.             type: string

  221.             label: 'Destination path'