Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://www.fastly.com/documentation/reference/api/)
# @param string $service_id Alphanumeric string identifying the service. (required)
# @param int $version_id Integer identifying a service version. (required)
# @param string $address A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend. (optional)
# @param boolean $auto_loadbalance Whether or not this backend should be automatically load balanced. If true, all backends with this setting that don't have a `request_condition` will be selected based on their `weight`. (optional)
# @param int $between_bytes_timeout Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. (optional)
# @param string $client_cert Unused. (optional)
# @param string $comment A freeform descriptive note. (optional)
# @param int $connect_timeout Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. (optional)
# @param int $first_byte_timeout Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. (optional)
# @param string $healthcheck The name of the healthcheck to use with this backend. (optional)
# @param string $hostname The hostname of the backend. May be used as an alternative to `address` to set the backend location. (optional)
# @param string $ipv4 IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. (optional)
# @param string $ipv6 IPv6 address of the backend. May be used as an alternative to `address` to set the backend location. (optional)
# @param int $keepalive_time How long in seconds to keep a persistent connection to the backend between requests. By default, Varnish keeps connections open as long as it can. (optional)
# @param int $max_conn Maximum number of concurrent connections this backend will accept. (optional)
# @param string $max_tls_version Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. (optional)
# @param string $min_tls_version Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. (optional)
# @param string $name The name of the backend. (optional)
# @param string $override_host If set, will replace the client-supplied HTTP `Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL. (optional)
# @param int $port Port on which the backend server is listening for connections from Fastly. Setting `port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request. (optional)
# @param string $request_condition Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any `auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests. (optional)
# @param string $share_key Value that when shared across backends will enable those backends to share the same health check. (optional)
# @param string $ssl_ca_cert CA certificate attached to origin. (optional)
# @param string $ssl_cert_hostname Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. (optional)
# @param boolean $ssl_check_cert Be strict on checking SSL certs. (optional, default to true)
# @param string $ssl_ciphers List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. (optional)
# @param string $ssl_client_cert Client certificate attached to origin. (optional)
# @param string $ssl_client_key Client key attached to origin. (optional)
# @param string $ssl_hostname Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. (optional)
# @param string $ssl_sni_hostname Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. (optional)
# @param boolean $tcp_keepalive_enable Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. (optional)
# @param int $tcp_keepalive_interval Interval in seconds between subsequent keepalive probes. (optional)
# @param int $tcp_keepalive_probes Number of unacknowledged probes to send before considering the connection dead. (optional)
# @param int $tcp_keepalive_time Interval in seconds between the last data packet sent and the first keepalive probe. (optional)
# @param boolean $use_ssl Whether or not to require TLS for connections to this backend. (optional)
# @param int $weight Weight used to load balance this backend against others. May be any positive integer. If `auto_loadbalance` is true, the chance of this backend being selected is equal to its own weight over the sum of all weights for backends that have `auto_loadbalance` set to true. (optional)
{
my$params= {
'service_id'=> {
data_type=> 'string',
description=> 'Alphanumeric string identifying the service.',
required=> '1',
},
'version_id'=> {
data_type=> 'int',
description=> 'Integer identifying a service version.',
required=> '1',
},
'address'=> {
data_type=> 'string',
description=> 'A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend.',
required=> '0',
},
'auto_loadbalance'=> {
data_type=> 'boolean',
description=> 'Whether or not this backend should be automatically load balanced. If true, all backends with this setting that don't have a `request_condition` will be selected based on their `weight`.',
required=> '0',
},
'between_bytes_timeout'=> {
data_type=> 'int',
description=> 'Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`.',
required=> '0',
},
'client_cert'=> {
data_type=> 'string',
description=> 'Unused.',
required=> '0',
},
'comment'=> {
data_type=> 'string',
description=> 'A freeform descriptive note.',
required=> '0',
},
'connect_timeout'=> {
data_type=> 'int',
description=> 'Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.',
required=> '0',
},
'first_byte_timeout'=> {
data_type=> 'int',
description=> 'Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.',
required=> '0',
},
'healthcheck'=> {
data_type=> 'string',
description=> 'The name of the healthcheck to use with this backend.',
required=> '0',
},
'hostname'=> {
data_type=> 'string',
description=> 'The hostname of the backend. May be used as an alternative to `address` to set the backend location.',
required=> '0',
},
'ipv4'=> {
data_type=> 'string',
description=> 'IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.',
required=> '0',
},
'ipv6'=> {
data_type=> 'string',
description=> 'IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.',
required=> '0',
},
'keepalive_time'=> {
data_type=> 'int',
description=> 'How long in seconds to keep a persistent connection to the backend between requests. By default, Varnish keeps connections open as long as it can.',
required=> '0',
},
'max_conn'=> {
data_type=> 'int',
description=> 'Maximum number of concurrent connections this backend will accept.',
required=> '0',
},
'max_tls_version'=> {
data_type=> 'string',
description=> 'Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.',
required=> '0',
},
'min_tls_version'=> {
data_type=> 'string',
description=> 'Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.',
required=> '0',
},
'name'=> {
data_type=> 'string',
description=> 'The name of the backend.',
required=> '0',
},
'override_host'=> {
data_type=> 'string',
description=> 'If set, will replace the client-supplied HTTP `Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL.',
required=> '0',
},
'port'=> {
data_type=> 'int',
description=> 'Port on which the backend server is listening for connections from Fastly. Setting `port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request.',
required=> '0',
},
'request_condition'=> {
data_type=> 'string',
description=> 'Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any `auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests.',
required=> '0',
},
'share_key'=> {
data_type=> 'string',
description=> 'Value that when shared across backends will enable those backends to share the same health check.',
description=> 'CA certificate attached to origin.',
required=> '0',
},
'ssl_cert_hostname'=> {
data_type=> 'string',
description=> 'Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.',
required=> '0',
},
'ssl_check_cert'=> {
data_type=> 'boolean',
description=> 'Be strict on checking SSL certs.',
required=> '0',
},
'ssl_ciphers'=> {
data_type=> 'string',
description=> 'List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.',
required=> '0',
},
'ssl_client_cert'=> {
data_type=> 'string',
description=> 'Client certificate attached to origin.',
required=> '0',
},
'ssl_client_key'=> {
data_type=> 'string',
description=> 'Client key attached to origin.',
required=> '0',
},
'ssl_hostname'=> {
data_type=> 'string',
description=> 'Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.',
required=> '0',
},
'ssl_sni_hostname'=> {
data_type=> 'string',
description=> 'Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all.',
required=> '0',
},
'tcp_keepalive_enable'=> {
data_type=> 'boolean',
description=> 'Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified.',
required=> '0',
},
'tcp_keepalive_interval'=> {
data_type=> 'int',
description=> 'Interval in seconds between subsequent keepalive probes.',
required=> '0',
},
'tcp_keepalive_probes'=> {
data_type=> 'int',
description=> 'Number of unacknowledged probes to send before considering the connection dead.',
required=> '0',
},
'tcp_keepalive_time'=> {
data_type=> 'int',
description=> 'Interval in seconds between the last data packet sent and the first keepalive probe.',
required=> '0',
},
'use_ssl'=> {
data_type=> 'boolean',
description=> 'Whether or not to require TLS for connections to this backend.',
required=> '0',
},
'weight'=> {
data_type=> 'int',
description=> 'Weight used to load balance this backend against others. May be any positive integer. If `auto_loadbalance` is true, the chance of this backend being selected is equal to its own weight over the sum of all weights for backends that have `auto_loadbalance` set to true.',
# @param string $service_id Alphanumeric string identifying the service. (required)
# @param int $version_id Integer identifying a service version. (required)
# @param string $backend_name The name of the backend. (required)
# @param string $address A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend. (optional)
# @param boolean $auto_loadbalance Whether or not this backend should be automatically load balanced. If true, all backends with this setting that don't have a `request_condition` will be selected based on their `weight`. (optional)
# @param int $between_bytes_timeout Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. (optional)
# @param string $client_cert Unused. (optional)
# @param string $comment A freeform descriptive note. (optional)
# @param int $connect_timeout Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. (optional)
# @param int $first_byte_timeout Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`. (optional)
# @param string $healthcheck The name of the healthcheck to use with this backend. (optional)
# @param string $hostname The hostname of the backend. May be used as an alternative to `address` to set the backend location. (optional)
# @param string $ipv4 IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. (optional)
# @param string $ipv6 IPv6 address of the backend. May be used as an alternative to `address` to set the backend location. (optional)
# @param int $keepalive_time How long in seconds to keep a persistent connection to the backend between requests. By default, Varnish keeps connections open as long as it can. (optional)
# @param int $max_conn Maximum number of concurrent connections this backend will accept. (optional)
# @param string $max_tls_version Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. (optional)
# @param string $min_tls_version Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. (optional)
# @param string $name The name of the backend. (optional)
# @param string $override_host If set, will replace the client-supplied HTTP `Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL. (optional)
# @param int $port Port on which the backend server is listening for connections from Fastly. Setting `port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request. (optional)
# @param string $request_condition Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any `auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests. (optional)
# @param string $share_key Value that when shared across backends will enable those backends to share the same health check. (optional)
# @param string $ssl_ca_cert CA certificate attached to origin. (optional)
# @param string $ssl_cert_hostname Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. (optional)
# @param boolean $ssl_check_cert Be strict on checking SSL certs. (optional, default to true)
# @param string $ssl_ciphers List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. (optional)
# @param string $ssl_client_cert Client certificate attached to origin. (optional)
# @param string $ssl_client_key Client key attached to origin. (optional)
# @param string $ssl_hostname Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. (optional)
# @param string $ssl_sni_hostname Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. (optional)
# @param boolean $tcp_keepalive_enable Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. (optional)
# @param int $tcp_keepalive_interval Interval in seconds between subsequent keepalive probes. (optional)
# @param int $tcp_keepalive_probes Number of unacknowledged probes to send before considering the connection dead. (optional)
# @param int $tcp_keepalive_time Interval in seconds between the last data packet sent and the first keepalive probe. (optional)
# @param boolean $use_ssl Whether or not to require TLS for connections to this backend. (optional)
# @param int $weight Weight used to load balance this backend against others. May be any positive integer. If `auto_loadbalance` is true, the chance of this backend being selected is equal to its own weight over the sum of all weights for backends that have `auto_loadbalance` set to true. (optional)
{
my$params= {
'service_id'=> {
data_type=> 'string',
description=> 'Alphanumeric string identifying the service.',
required=> '1',
},
'version_id'=> {
data_type=> 'int',
description=> 'Integer identifying a service version.',
required=> '1',
},
'backend_name'=> {
data_type=> 'string',
description=> 'The name of the backend.',
required=> '1',
},
'address'=> {
data_type=> 'string',
description=> 'A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend.',
required=> '0',
},
'auto_loadbalance'=> {
data_type=> 'boolean',
description=> 'Whether or not this backend should be automatically load balanced. If true, all backends with this setting that don't have a `request_condition` will be selected based on their `weight`.',
required=> '0',
},
'between_bytes_timeout'=> {
data_type=> 'int',
description=> 'Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`.',
required=> '0',
},
'client_cert'=> {
data_type=> 'string',
description=> 'Unused.',
required=> '0',
},
'comment'=> {
data_type=> 'string',
description=> 'A freeform descriptive note.',
required=> '0',
},
'connect_timeout'=> {
data_type=> 'int',
description=> 'Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.',
required=> '0',
},
'first_byte_timeout'=> {
data_type=> 'int',
description=> 'Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.',
required=> '0',
},
'healthcheck'=> {
data_type=> 'string',
description=> 'The name of the healthcheck to use with this backend.',
required=> '0',
},
'hostname'=> {
data_type=> 'string',
description=> 'The hostname of the backend. May be used as an alternative to `address` to set the backend location.',
required=> '0',
},
'ipv4'=> {
data_type=> 'string',
description=> 'IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.',
required=> '0',
},
'ipv6'=> {
data_type=> 'string',
description=> 'IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.',
required=> '0',
},
'keepalive_time'=> {
data_type=> 'int',
description=> 'How long in seconds to keep a persistent connection to the backend between requests. By default, Varnish keeps connections open as long as it can.',
required=> '0',
},
'max_conn'=> {
data_type=> 'int',
description=> 'Maximum number of concurrent connections this backend will accept.',
required=> '0',
},
'max_tls_version'=> {
data_type=> 'string',
description=> 'Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.',
required=> '0',
},
'min_tls_version'=> {
data_type=> 'string',
description=> 'Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.',
required=> '0',
},
'name'=> {
data_type=> 'string',
description=> 'The name of the backend.',
required=> '0',
},
'override_host'=> {
data_type=> 'string',
description=> 'If set, will replace the client-supplied HTTP `Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL.',
required=> '0',
},
'port'=> {
data_type=> 'int',
description=> 'Port on which the backend server is listening for connections from Fastly. Setting `port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request.',
required=> '0',
},
'request_condition'=> {
data_type=> 'string',
description=> 'Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any `auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests.',
required=> '0',
},
'share_key'=> {
data_type=> 'string',
description=> 'Value that when shared across backends will enable those backends to share the same health check.',
description=> 'CA certificate attached to origin.',
required=> '0',
},
'ssl_cert_hostname'=> {
data_type=> 'string',
description=> 'Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.',
required=> '0',
},
'ssl_check_cert'=> {
data_type=> 'boolean',
description=> 'Be strict on checking SSL certs.',
required=> '0',
},
'ssl_ciphers'=> {
data_type=> 'string',
description=> 'List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.',
required=> '0',
},
'ssl_client_cert'=> {
data_type=> 'string',
description=> 'Client certificate attached to origin.',
required=> '0',
},
'ssl_client_key'=> {
data_type=> 'string',
description=> 'Client key attached to origin.',
required=> '0',
},
'ssl_hostname'=> {
data_type=> 'string',
description=> 'Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.',
required=> '0',
},
'ssl_sni_hostname'=> {
data_type=> 'string',
description=> 'Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all.',
required=> '0',
},
'tcp_keepalive_enable'=> {
data_type=> 'boolean',
description=> 'Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified.',
required=> '0',
},
'tcp_keepalive_interval'=> {
data_type=> 'int',
description=> 'Interval in seconds between subsequent keepalive probes.',
required=> '0',
},
'tcp_keepalive_probes'=> {
data_type=> 'int',
description=> 'Number of unacknowledged probes to send before considering the connection dead.',
required=> '0',
},
'tcp_keepalive_time'=> {
data_type=> 'int',
description=> 'Interval in seconds between the last data packet sent and the first keepalive probe.',
required=> '0',
},
'use_ssl'=> {
data_type=> 'boolean',
description=> 'Whether or not to require TLS for connections to this backend.',
required=> '0',
},
'weight'=> {
data_type=> 'int',
description=> 'Weight used to load balance this backend against others. May be any positive integer. If `auto_loadbalance` is true, the chance of this backend being selected is equal to its own weight over the sum of all weights for backends that have `auto_loadbalance` set to true.',