Skip to content

Latest commit

 

History

History
240 lines (180 loc) · 8.45 KB

LoggingSumologicApi.md

File metadata and controls

240 lines (180 loc) · 8.45 KB

Fastly.LoggingSumologicApi

const apiInstance = new Fastly.LoggingSumologicApi();

Methods

Note

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

Method HTTP request Description
createLogSumologic POST /service/{service_id}/version/{version_id}/logging/sumologic Create a Sumologic log endpoint
deleteLogSumologic DELETE /service/{service_id}/version/{version_id}/logging/sumologic/{logging_sumologic_name} Delete a Sumologic log endpoint
getLogSumologic GET /service/{service_id}/version/{version_id}/logging/sumologic/{logging_sumologic_name} Get a Sumologic log endpoint
listLogSumologic GET /service/{service_id}/version/{version_id}/logging/sumologic List Sumologic log endpoints
updateLogSumologic PUT /service/{service_id}/version/{version_id}/logging/sumologic/{logging_sumologic_name} Update a Sumologic log endpoint

createLogSumologic

createLogSumologic({ service_id, version_id, [name, ][placement, ][response_condition, ][format, ][format_version, ][message_type, ][url] })

Create a Sumologic for a particular service and version.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
  name: "name_example",
  placement: "none",
  response_condition: "response_condition_example",
  format: "'%h %l %u %t \"%r\" %>s %b'",
  format_version: 1,
  message_type: new Fastly.LoggingMessageType(),
  url: "url_example",
};

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

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.
name String The name for the real-time logging configuration. [optional]
placement String Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. [optional] [one of: "none", "waf_debug", "null"]
response_condition String The name of an existing condition in the configured endpoint, or leave blank to always execute. [optional]
format String A Fastly log format string. [optional] [defaults to '%h %l %u %t "%r" %>s %b']
format_version Number The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. [optional] [one of: 1, 2]
message_type LoggingMessageType [optional]
url String The URL to post logs to. [optional]

Return type

LoggingSumologicResponse

deleteLogSumologic

deleteLogSumologic({ service_id, version_id, logging_sumologic_name })

Delete the Sumologic for a particular service and version.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
  logging_sumologic_name: "logging_sumologic_name_example", // required
};

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

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.
logging_sumologic_name String The name for the real-time logging configuration.

Return type

InlineResponse200

getLogSumologic

getLogSumologic({ service_id, version_id, logging_sumologic_name })

Get the Sumologic for a particular service and version.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
  logging_sumologic_name: "logging_sumologic_name_example", // required
};

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

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.
logging_sumologic_name String The name for the real-time logging configuration.

Return type

LoggingSumologicResponse

listLogSumologic

listLogSumologic({ service_id, version_id })

List all of the Sumologics for a particular service and version.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
};

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

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.

Return type

[LoggingSumologicResponse]

updateLogSumologic

updateLogSumologic({ service_id, version_id, logging_sumologic_name, [name, ][placement, ][response_condition, ][format, ][format_version, ][message_type, ][url] })

Update the Sumologic for a particular service and version.

Example

const options = {
  service_id: "service_id_example", // required
  version_id: 56, // required
  logging_sumologic_name: "logging_sumologic_name_example", // required
  name: "name_example",
  placement: "none",
  response_condition: "response_condition_example",
  format: "'%h %l %u %t \"%r\" %>s %b'",
  format_version: 1,
  message_type: new Fastly.LoggingMessageType(),
  url: "url_example",
};

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

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
version_id Number Integer identifying a service version.
logging_sumologic_name String The name for the real-time logging configuration.
name String The name for the real-time logging configuration. [optional]
placement String Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. [optional] [one of: "none", "waf_debug", "null"]
response_condition String The name of an existing condition in the configured endpoint, or leave blank to always execute. [optional]
format String A Fastly log format string. [optional] [defaults to '%h %l %u %t "%r" %>s %b']
format_version Number The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. [optional] [one of: 1, 2]
message_type LoggingMessageType [optional]
url String The URL to post logs to. [optional]

Return type

LoggingSumologicResponse

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