TlsConfigurationsApi.md

Fastly.TlsConfigurationsApi

const apiInstance = new Fastly.TlsConfigurationsApi();

Methods

Note

All URIs are relative to https://api.fastly.com

Method	HTTP request	Description
getTlsConfig	GET /tls/configurations/{tls_configuration_id}	Get a TLS configuration
listTlsConfigs	GET /tls/configurations	List TLS configurations
updateTlsConfig	PATCH /tls/configurations/{tls_configuration_id}	Update a TLS configuration

getTlsConfig

getTlsConfig({ tls_configuration_id, [include] })

Show a TLS configuration.

Example

const options = {
  tls_configuration_id: "tls_configuration_id_example", // required
  include: dns_records,
};

apiInstance.getTlsConfig(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name	Type	Description	Notes
tls_configuration_id	String	Alphanumeric string identifying a TLS configuration.
include	String	Include related objects. Optional, comma-separated values. Permitted values: dns_records.	[optional]

Return type

TlsConfigurationResponse

listTlsConfigs

listTlsConfigs({ , [filter_bulk, ][include, ][page_number, ][page_size] })

List all TLS configurations.

Example

const options = {
  filter_bulk: "filter_bulk_example",
  include: dns_records,
  page_number: 1,
  page_size: 20,
};

apiInstance.listTlsConfigs(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name	Type	Description	Notes
filter_bulk	String	Optionally filters by the bulk attribute.	[optional]
include	String	Include related objects. Optional, comma-separated values. Permitted values: dns_records.	[optional]
page_number	Number	Current page.	[optional]
page_size	Number	Number of records per page.	[optional] [defaults to 20]

Return type

TlsConfigurationsResponse

updateTlsConfig

updateTlsConfig({ tls_configuration_id, [tls_configuration] })

Update a TLS configuration.

Example

const options = {
  tls_configuration_id: "tls_configuration_id_example", // required
  tls_configuration: {"data":{"type":"tls_configuration","attributes":{"name":"New TLS configuration name"}}},
};

apiInstance.updateTlsConfig(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name	Type	Description	Notes
tls_configuration_id	String	Alphanumeric string identifying a TLS configuration.
tls_configuration	TlsConfiguration		[optional]

Return type

TlsConfigurationResponse

[Back to top] [Back to API list] [Back to README]