Class: Fastly::BackendApi

#create_backend(opts = {}) ⇒ `BackendResponse`

Create a backend Create a backend for a particular service and version.

Parameters:

opts (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (opts):

:service_id (String) —

Alphanumeric string identifying the service. (required)
:version_id (Integer) —

Integer identifying a service version. (required)
:address (String) —

A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend.
:auto_loadbalance (Boolean) —

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`.
:between_bytes_timeout (Integer) —

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`.
:client_cert (String) —

Unused.
:comment (String) —

A freeform descriptive note.
:connect_timeout (Integer) —

Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.
:first_byte_timeout (Integer) —

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 synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.
:healthcheck (String) —

The name of the healthcheck to use with this backend.
:hostname (String) —

The hostname of the backend. May be used as an alternative to `address` to set the backend location.
:ipv4 (String) —

IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.
:ipv6 (String) —

IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.
:keepalive_time (Integer) —

How long in seconds to keep a persistent connection to the backend between requests.
:max_conn (Integer) —

Maximum number of concurrent connections this backend will accept.
:max_tls_version (String) —

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.
:min_tls_version (String) —

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.
:name (String) —

The name of the backend.
:override_host (String) —

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.
:port (Integer) —

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.
:request_condition (String) —

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.
:share_key (String) —

Value that when shared across backends will enable those backends to share the same health check.
:shield (String) —

Identifier of the POP to use as a [shield](docs.fastly.com/en/guides/shielding).
:ssl_ca_cert (String) —

CA certificate attached to origin.
:ssl_cert_hostname (String) —

Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.
:ssl_check_cert (Boolean) —

Be strict on checking SSL certs. (default to true)
:ssl_ciphers (String) —

List of [OpenSSL ciphers](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.
:ssl_client_cert (String) —

Client certificate attached to origin.
:ssl_client_key (String) —

Client key attached to origin.
:ssl_hostname (String) —

Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.
:ssl_sni_hostname (String) —

Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all.
:tcp_keepalive_enable (Boolean) —

Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified.
:tcp_keepalive_interval (Integer) —

Interval in seconds between subsequent keepalive probes.
:tcp_keepalive_probes (Integer) —

Number of unacknowledged probes to send before considering the connection dead.
:tcp_keepalive_time (Integer) —

Interval in seconds between the last data packet sent and the first keepalive probe.
:use_ssl (Boolean) —

Whether or not to require TLS for connections to this backend.
:weight (Integer) —

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.

Returns:

(BackendResponse)

# File 'lib/fastly/api/backend_api.rb', line 60

def create_backend(opts = {})
  data, _status_code, _headers = create_backend_with_http_info(opts)
  data
end

#create_backend_with_http_info(opts = {}) ⇒ `Array<(BackendResponse, Integer, Hash)>`

Create a backend Create a backend for a particular service and version.

Parameters:

opts (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (opts):

:service_id (String) —

Alphanumeric string identifying the service. (required)
:version_id (Integer) —

Integer identifying a service version. (required)
:address (String) —

A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend.
:auto_loadbalance (Boolean) —

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`.
:between_bytes_timeout (Integer) —

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`.
:client_cert (String) —

Unused.
:comment (String) —

A freeform descriptive note.
:connect_timeout (Integer) —

Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.
:first_byte_timeout (Integer) —

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 synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.
:healthcheck (String) —

The name of the healthcheck to use with this backend.
:hostname (String) —

The hostname of the backend. May be used as an alternative to `address` to set the backend location.
:ipv4 (String) —

IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.
:ipv6 (String) —

IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.
:keepalive_time (Integer) —

How long in seconds to keep a persistent connection to the backend between requests.
:max_conn (Integer) —

Maximum number of concurrent connections this backend will accept.
:max_tls_version (String) —

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.
:min_tls_version (String) —

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.
:name (String) —

The name of the backend.
:override_host (String) —

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.
:port (Integer) —

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.
:request_condition (String) —

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.
:share_key (String) —

Value that when shared across backends will enable those backends to share the same health check.
:shield (String) —

Identifier of the POP to use as a [shield](docs.fastly.com/en/guides/shielding).
:ssl_ca_cert (String) —

CA certificate attached to origin.
:ssl_cert_hostname (String) —

Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.
:ssl_check_cert (Boolean) —

Be strict on checking SSL certs. (default to true)
:ssl_ciphers (String) —

List of [OpenSSL ciphers](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.
:ssl_client_cert (String) —

Client certificate attached to origin.
:ssl_client_key (String) —

Client key attached to origin.
:ssl_hostname (String) —

Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.
:ssl_sni_hostname (String) —

Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all.
:tcp_keepalive_enable (Boolean) —

Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified.
:tcp_keepalive_interval (Integer) —

Interval in seconds between subsequent keepalive probes.
:tcp_keepalive_probes (Integer) —

Number of unacknowledged probes to send before considering the connection dead.
:tcp_keepalive_time (Integer) —

Interval in seconds between the last data packet sent and the first keepalive probe.
:use_ssl (Boolean) —

Whether or not to require TLS for connections to this backend.
:weight (Integer) —

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.

Returns:

(Array<(BackendResponse, Integer, Hash)>) —

BackendResponse data, response status code and response headers

# File 'lib/fastly/api/backend_api.rb', line 105

def create_backend_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackendApi.create_backend ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling BackendApi.create_backend"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling BackendApi.create_backend"
  end
  pattern = Regexp.new(/^[A-Za-z0-9]+$/)
  if @api_client.config.client_side_validation && !opts[:'share_key'].nil? && opts[:'share_key'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"share_key\"]' when calling BackendApi.create_backend, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/backend'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['address'] = opts[:'address'] if !opts[:'address'].nil?
  form_params['auto_loadbalance'] = opts[:'auto_loadbalance'] if !opts[:'auto_loadbalance'].nil?
  form_params['between_bytes_timeout'] = opts[:'between_bytes_timeout'] if !opts[:'between_bytes_timeout'].nil?
  form_params['client_cert'] = opts[:'client_cert'] if !opts[:'client_cert'].nil?
  form_params['comment'] = opts[:'comment'] if !opts[:'comment'].nil?
  form_params['connect_timeout'] = opts[:'connect_timeout'] if !opts[:'connect_timeout'].nil?
  form_params['first_byte_timeout'] = opts[:'first_byte_timeout'] if !opts[:'first_byte_timeout'].nil?
  form_params['healthcheck'] = opts[:'healthcheck'] if !opts[:'healthcheck'].nil?
  form_params['hostname'] = opts[:'hostname'] if !opts[:'hostname'].nil?
  form_params['ipv4'] = opts[:'ipv4'] if !opts[:'ipv4'].nil?
  form_params['ipv6'] = opts[:'ipv6'] if !opts[:'ipv6'].nil?
  form_params['keepalive_time'] = opts[:'keepalive_time'] if !opts[:'keepalive_time'].nil?
  form_params['max_conn'] = opts[:'max_conn'] if !opts[:'max_conn'].nil?
  form_params['max_tls_version'] = opts[:'max_tls_version'] if !opts[:'max_tls_version'].nil?
  form_params['min_tls_version'] = opts[:'min_tls_version'] if !opts[:'min_tls_version'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['override_host'] = opts[:'override_host'] if !opts[:'override_host'].nil?
  form_params['port'] = opts[:'port'] if !opts[:'port'].nil?
  form_params['request_condition'] = opts[:'request_condition'] if !opts[:'request_condition'].nil?
  form_params['share_key'] = opts[:'share_key'] if !opts[:'share_key'].nil?
  form_params['shield'] = opts[:'shield'] if !opts[:'shield'].nil?
  form_params['ssl_ca_cert'] = opts[:'ssl_ca_cert'] if !opts[:'ssl_ca_cert'].nil?
  form_params['ssl_cert_hostname'] = opts[:'ssl_cert_hostname'] if !opts[:'ssl_cert_hostname'].nil?
  form_params['ssl_check_cert'] = opts[:'ssl_check_cert'] if !opts[:'ssl_check_cert'].nil?
  form_params['ssl_ciphers'] = opts[:'ssl_ciphers'] if !opts[:'ssl_ciphers'].nil?
  form_params['ssl_client_cert'] = opts[:'ssl_client_cert'] if !opts[:'ssl_client_cert'].nil?
  form_params['ssl_client_key'] = opts[:'ssl_client_key'] if !opts[:'ssl_client_key'].nil?
  form_params['ssl_hostname'] = opts[:'ssl_hostname'] if !opts[:'ssl_hostname'].nil?
  form_params['ssl_sni_hostname'] = opts[:'ssl_sni_hostname'] if !opts[:'ssl_sni_hostname'].nil?
  form_params['tcp_keepalive_enable'] = opts[:'tcp_keepalive_enable'] if !opts[:'tcp_keepalive_enable'].nil?
  form_params['tcp_keepalive_interval'] = opts[:'tcp_keepalive_interval'] if !opts[:'tcp_keepalive_interval'].nil?
  form_params['tcp_keepalive_probes'] = opts[:'tcp_keepalive_probes'] if !opts[:'tcp_keepalive_probes'].nil?
  form_params['tcp_keepalive_time'] = opts[:'tcp_keepalive_time'] if !opts[:'tcp_keepalive_time'].nil?
  form_params['use_ssl'] = opts[:'use_ssl'] if !opts[:'use_ssl'].nil?
  form_params['weight'] = opts[:'weight'] if !opts[:'weight'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BackendResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"BackendApi.create_backend",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BackendApi#create_backend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_backend(opts = {}) ⇒ `InlineResponse200`

Delete a backend Delete the backend for a particular service and version.

Parameters:

opts (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (opts):

:service_id (String) —

Alphanumeric string identifying the service. (required)
:version_id (Integer) —

Integer identifying a service version. (required)
:backend_name (String) —

The name of the backend. (required)

Returns:

(InlineResponse200)

# File 'lib/fastly/api/backend_api.rb', line 211

def delete_backend(opts = {})
  data, _status_code, _headers = delete_backend_with_http_info(opts)
  data
end

#delete_backend_with_http_info(opts = {}) ⇒ `Array<(InlineResponse200, Integer, Hash)>`

Delete a backend Delete the backend for a particular service and version.

Parameters:

opts (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (opts):

:service_id (String) —

Alphanumeric string identifying the service. (required)
:version_id (Integer) —

Integer identifying a service version. (required)
:backend_name (String) —

The name of the backend. (required)

Returns:

(Array<(InlineResponse200, Integer, Hash)>) —

InlineResponse200 data, response status code and response headers

# File 'lib/fastly/api/backend_api.rb', line 222

def delete_backend_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackendApi.delete_backend ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  backend_name = opts[:'backend_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling BackendApi.delete_backend"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling BackendApi.delete_backend"
  end
  # verify the required parameter 'backend_name' is set
  if @api_client.config.client_side_validation && backend_name.nil?
    fail ArgumentError, "Missing the required parameter 'backend_name' when calling BackendApi.delete_backend"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/backend/{backend_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'backend_name' + '}', CGI.escape(backend_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse200'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"BackendApi.delete_backend",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BackendApi#delete_backend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_backend(opts = {}) ⇒ `BackendResponse`

Describe a backend Get the backend for a particular service and version.

Parameters:

opts (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (opts):

:service_id (String) —

Alphanumeric string identifying the service. (required)
:version_id (Integer) —

Integer identifying a service version. (required)
:backend_name (String) —

The name of the backend. (required)

Returns:

(BackendResponse)

# File 'lib/fastly/api/backend_api.rb', line 288

def get_backend(opts = {})
  data, _status_code, _headers = get_backend_with_http_info(opts)
  data
end

#get_backend_with_http_info(opts = {}) ⇒ `Array<(BackendResponse, Integer, Hash)>`

Describe a backend Get the backend for a particular service and version.

Parameters:

opts (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (opts):

:service_id (String) —

Alphanumeric string identifying the service. (required)
:version_id (Integer) —

Integer identifying a service version. (required)
:backend_name (String) —

The name of the backend. (required)

Returns:

(Array<(BackendResponse, Integer, Hash)>) —

BackendResponse data, response status code and response headers

# File 'lib/fastly/api/backend_api.rb', line 299

def get_backend_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackendApi.get_backend ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  backend_name = opts[:'backend_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling BackendApi.get_backend"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling BackendApi.get_backend"
  end
  # verify the required parameter 'backend_name' is set
  if @api_client.config.client_side_validation && backend_name.nil?
    fail ArgumentError, "Missing the required parameter 'backend_name' when calling BackendApi.get_backend"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/backend/{backend_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'backend_name' + '}', CGI.escape(backend_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BackendResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"BackendApi.get_backend",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BackendApi#get_backend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_backends(opts = {}) ⇒ `Array<BackendResponse>`

List backends List all backends for a particular service and version.

Parameters:

opts (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (opts):

:service_id (String) —

Alphanumeric string identifying the service. (required)
:version_id (Integer) —

Integer identifying a service version. (required)

Returns:

(Array<BackendResponse>)

# File 'lib/fastly/api/backend_api.rb', line 364

def list_backends(opts = {})
  data, _status_code, _headers = list_backends_with_http_info(opts)
  data
end

#list_backends_with_http_info(opts = {}) ⇒ `Array<(Array<BackendResponse>, Integer, Hash)>`

List backends List all backends for a particular service and version.

Parameters:

opts (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (opts):

:service_id (String) —

Alphanumeric string identifying the service. (required)
:version_id (Integer) —

Integer identifying a service version. (required)

Returns:

(Array<(Array<BackendResponse>, Integer, Hash)>) —

Array<BackendResponse> data, response status code and response headers

# File 'lib/fastly/api/backend_api.rb', line 374

def list_backends_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackendApi.list_backends ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling BackendApi.list_backends"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling BackendApi.list_backends"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/backend'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<BackendResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"BackendApi.list_backends",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BackendApi#list_backends\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_backend(opts = {}) ⇒ `BackendResponse`

Update a backend Update the backend for a particular service and version.

Parameters:

opts (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (opts):

:service_id (String) —

Alphanumeric string identifying the service. (required)
:version_id (Integer) —

Integer identifying a service version. (required)
:backend_name (String) —

The name of the backend. (required)
:address (String) —

A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend.
:auto_loadbalance (Boolean) —

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`.
:between_bytes_timeout (Integer) —

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`.
:client_cert (String) —

Unused.
:comment (String) —

A freeform descriptive note.
:connect_timeout (Integer) —

Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.
:first_byte_timeout (Integer) —

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 synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.
:healthcheck (String) —

The name of the healthcheck to use with this backend.
:hostname (String) —

The hostname of the backend. May be used as an alternative to `address` to set the backend location.
:ipv4 (String) —

IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.
:ipv6 (String) —

IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.
:keepalive_time (Integer) —

How long in seconds to keep a persistent connection to the backend between requests.
:max_conn (Integer) —

Maximum number of concurrent connections this backend will accept.
:max_tls_version (String) —

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.
:min_tls_version (String) —

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.
:name (String) —

The name of the backend.
:override_host (String) —

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.
:port (Integer) —

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.
:request_condition (String) —

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.
:share_key (String) —

Value that when shared across backends will enable those backends to share the same health check.
:shield (String) —

Identifier of the POP to use as a [shield](docs.fastly.com/en/guides/shielding).
:ssl_ca_cert (String) —

CA certificate attached to origin.
:ssl_cert_hostname (String) —

Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.
:ssl_check_cert (Boolean) —

Be strict on checking SSL certs. (default to true)
:ssl_ciphers (String) —

List of [OpenSSL ciphers](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.
:ssl_client_cert (String) —

Client certificate attached to origin.
:ssl_client_key (String) —

Client key attached to origin.
:ssl_hostname (String) —

Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.
:ssl_sni_hostname (String) —

Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all.
:tcp_keepalive_enable (Boolean) —

Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified.
:tcp_keepalive_interval (Integer) —

Interval in seconds between subsequent keepalive probes.
:tcp_keepalive_probes (Integer) —

Number of unacknowledged probes to send before considering the connection dead.
:tcp_keepalive_time (Integer) —

Interval in seconds between the last data packet sent and the first keepalive probe.
:use_ssl (Boolean) —

Whether or not to require TLS for connections to this backend.
:weight (Integer) —

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.

Returns:

(BackendResponse)

# File 'lib/fastly/api/backend_api.rb', line 470

def update_backend(opts = {})
  data, _status_code, _headers = update_backend_with_http_info(opts)
  data
end

#update_backend_with_http_info(opts = {}) ⇒ `Array<(BackendResponse, Integer, Hash)>`

Update a backend Update the backend for a particular service and version.

Parameters:

opts (Hash) (defaults to: {}) —

a customizable set of options

Options Hash (opts):

:service_id (String) —

Alphanumeric string identifying the service. (required)
:version_id (Integer) —

Integer identifying a service version. (required)
:backend_name (String) —

The name of the backend. (required)
:address (String) —

A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend.
:auto_loadbalance (Boolean) —

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`.
:between_bytes_timeout (Integer) —

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`.
:client_cert (String) —

Unused.
:comment (String) —

A freeform descriptive note.
:connect_timeout (Integer) —

Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.
:first_byte_timeout (Integer) —

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 synthethic `503` response will be presented instead. May be set at runtime using `bereq.first_byte_timeout`.
:healthcheck (String) —

The name of the healthcheck to use with this backend.
:hostname (String) —

The hostname of the backend. May be used as an alternative to `address` to set the backend location.
:ipv4 (String) —

IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.
:ipv6 (String) —

IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.
:keepalive_time (Integer) —

How long in seconds to keep a persistent connection to the backend between requests.
:max_conn (Integer) —

Maximum number of concurrent connections this backend will accept.
:max_tls_version (String) —

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.
:min_tls_version (String) —

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.
:name (String) —

The name of the backend.
:override_host (String) —

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.
:port (Integer) —

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.
:request_condition (String) —

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.
:share_key (String) —

Value that when shared across backends will enable those backends to share the same health check.
:shield (String) —

Identifier of the POP to use as a [shield](docs.fastly.com/en/guides/shielding).
:ssl_ca_cert (String) —

CA certificate attached to origin.
:ssl_cert_hostname (String) —

Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.
:ssl_check_cert (Boolean) —

Be strict on checking SSL certs. (default to true)
:ssl_ciphers (String) —

List of [OpenSSL ciphers](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.
:ssl_client_cert (String) —

Client certificate attached to origin.
:ssl_client_key (String) —

Client key attached to origin.
:ssl_hostname (String) —

Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.
:ssl_sni_hostname (String) —

Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all.
:tcp_keepalive_enable (Boolean) —

Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified.
:tcp_keepalive_interval (Integer) —

Interval in seconds between subsequent keepalive probes.
:tcp_keepalive_probes (Integer) —

Number of unacknowledged probes to send before considering the connection dead.
:tcp_keepalive_time (Integer) —

Interval in seconds between the last data packet sent and the first keepalive probe.
:use_ssl (Boolean) —

Whether or not to require TLS for connections to this backend.
:weight (Integer) —

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.

Returns:

(Array<(BackendResponse, Integer, Hash)>) —

BackendResponse data, response status code and response headers

# File 'lib/fastly/api/backend_api.rb', line 516

def update_backend_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackendApi.update_backend ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  backend_name = opts[:'backend_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling BackendApi.update_backend"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling BackendApi.update_backend"
  end
  # verify the required parameter 'backend_name' is set
  if @api_client.config.client_side_validation && backend_name.nil?
    fail ArgumentError, "Missing the required parameter 'backend_name' when calling BackendApi.update_backend"
  end
  pattern = Regexp.new(/^[A-Za-z0-9]+$/)
  if @api_client.config.client_side_validation && !opts[:'share_key'].nil? && opts[:'share_key'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"share_key\"]' when calling BackendApi.update_backend, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/backend/{backend_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'backend_name' + '}', CGI.escape(backend_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['address'] = opts[:'address'] if !opts[:'address'].nil?
  form_params['auto_loadbalance'] = opts[:'auto_loadbalance'] if !opts[:'auto_loadbalance'].nil?
  form_params['between_bytes_timeout'] = opts[:'between_bytes_timeout'] if !opts[:'between_bytes_timeout'].nil?
  form_params['client_cert'] = opts[:'client_cert'] if !opts[:'client_cert'].nil?
  form_params['comment'] = opts[:'comment'] if !opts[:'comment'].nil?
  form_params['connect_timeout'] = opts[:'connect_timeout'] if !opts[:'connect_timeout'].nil?
  form_params['first_byte_timeout'] = opts[:'first_byte_timeout'] if !opts[:'first_byte_timeout'].nil?
  form_params['healthcheck'] = opts[:'healthcheck'] if !opts[:'healthcheck'].nil?
  form_params['hostname'] = opts[:'hostname'] if !opts[:'hostname'].nil?
  form_params['ipv4'] = opts[:'ipv4'] if !opts[:'ipv4'].nil?
  form_params['ipv6'] = opts[:'ipv6'] if !opts[:'ipv6'].nil?
  form_params['keepalive_time'] = opts[:'keepalive_time'] if !opts[:'keepalive_time'].nil?
  form_params['max_conn'] = opts[:'max_conn'] if !opts[:'max_conn'].nil?
  form_params['max_tls_version'] = opts[:'max_tls_version'] if !opts[:'max_tls_version'].nil?
  form_params['min_tls_version'] = opts[:'min_tls_version'] if !opts[:'min_tls_version'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['override_host'] = opts[:'override_host'] if !opts[:'override_host'].nil?
  form_params['port'] = opts[:'port'] if !opts[:'port'].nil?
  form_params['request_condition'] = opts[:'request_condition'] if !opts[:'request_condition'].nil?
  form_params['share_key'] = opts[:'share_key'] if !opts[:'share_key'].nil?
  form_params['shield'] = opts[:'shield'] if !opts[:'shield'].nil?
  form_params['ssl_ca_cert'] = opts[:'ssl_ca_cert'] if !opts[:'ssl_ca_cert'].nil?
  form_params['ssl_cert_hostname'] = opts[:'ssl_cert_hostname'] if !opts[:'ssl_cert_hostname'].nil?
  form_params['ssl_check_cert'] = opts[:'ssl_check_cert'] if !opts[:'ssl_check_cert'].nil?
  form_params['ssl_ciphers'] = opts[:'ssl_ciphers'] if !opts[:'ssl_ciphers'].nil?
  form_params['ssl_client_cert'] = opts[:'ssl_client_cert'] if !opts[:'ssl_client_cert'].nil?
  form_params['ssl_client_key'] = opts[:'ssl_client_key'] if !opts[:'ssl_client_key'].nil?
  form_params['ssl_hostname'] = opts[:'ssl_hostname'] if !opts[:'ssl_hostname'].nil?
  form_params['ssl_sni_hostname'] = opts[:'ssl_sni_hostname'] if !opts[:'ssl_sni_hostname'].nil?
  form_params['tcp_keepalive_enable'] = opts[:'tcp_keepalive_enable'] if !opts[:'tcp_keepalive_enable'].nil?
  form_params['tcp_keepalive_interval'] = opts[:'tcp_keepalive_interval'] if !opts[:'tcp_keepalive_interval'].nil?
  form_params['tcp_keepalive_probes'] = opts[:'tcp_keepalive_probes'] if !opts[:'tcp_keepalive_probes'].nil?
  form_params['tcp_keepalive_time'] = opts[:'tcp_keepalive_time'] if !opts[:'tcp_keepalive_time'].nil?
  form_params['use_ssl'] = opts[:'use_ssl'] if !opts[:'use_ssl'].nil?
  form_params['weight'] = opts[:'weight'] if !opts[:'weight'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BackendResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"BackendApi.update_backend",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BackendApi#update_backend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ `BackendApi`

Instance Attribute Details

#api_client ⇒ `Object`

Instance Method Details

#create_backend(opts = {}) ⇒ `BackendResponse`

#create_backend_with_http_info(opts = {}) ⇒ `Array<(BackendResponse, Integer, Hash)>`

#delete_backend(opts = {}) ⇒ `InlineResponse200`

#delete_backend_with_http_info(opts = {}) ⇒ `Array<(InlineResponse200, Integer, Hash)>`

#get_backend(opts = {}) ⇒ `BackendResponse`

#get_backend_with_http_info(opts = {}) ⇒ `Array<(BackendResponse, Integer, Hash)>`

#list_backends(opts = {}) ⇒ `Array<BackendResponse>`

#list_backends_with_http_info(opts = {}) ⇒ `Array<(Array<BackendResponse>, Integer, Hash)>`

#update_backend(opts = {}) ⇒ `BackendResponse`

#update_backend_with_http_info(opts = {}) ⇒ `Array<(BackendResponse, Integer, Hash)>`

Class: Fastly::BackendApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BackendApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#create_backend(opts = {}) ⇒ BackendResponse

#create_backend_with_http_info(opts = {}) ⇒ Array<(BackendResponse, Integer, Hash)>

#delete_backend(opts = {}) ⇒ InlineResponse200

#delete_backend_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

#get_backend(opts = {}) ⇒ BackendResponse

#get_backend_with_http_info(opts = {}) ⇒ Array<(BackendResponse, Integer, Hash)>

#list_backends(opts = {}) ⇒ Array<BackendResponse>

#list_backends_with_http_info(opts = {}) ⇒ Array<(Array<BackendResponse>, Integer, Hash)>

#update_backend(opts = {}) ⇒ BackendResponse

#update_backend_with_http_info(opts = {}) ⇒ Array<(BackendResponse, Integer, Hash)>

#initialize(api_client = ApiClient.default) ⇒ `BackendApi`

#api_client ⇒ `Object`

#create_backend(opts = {}) ⇒ `BackendResponse`

#create_backend_with_http_info(opts = {}) ⇒ `Array<(BackendResponse, Integer, Hash)>`

#delete_backend(opts = {}) ⇒ `InlineResponse200`

#delete_backend_with_http_info(opts = {}) ⇒ `Array<(InlineResponse200, Integer, Hash)>`

#get_backend(opts = {}) ⇒ `BackendResponse`

#get_backend_with_http_info(opts = {}) ⇒ `Array<(BackendResponse, Integer, Hash)>`

#list_backends(opts = {}) ⇒ `Array<BackendResponse>`

#list_backends_with_http_info(opts = {}) ⇒ `Array<(Array<BackendResponse>, Integer, Hash)>`

#update_backend(opts = {}) ⇒ `BackendResponse`

#update_backend_with_http_info(opts = {}) ⇒ `Array<(BackendResponse, Integer, Hash)>`