---
title: HTTPS
summary: Fastly will upload log messages to an HTTPS endpoint in the format specified in the HTTPS object. The HTTPS endpoint requires proof of domain ownership before logs can be received. Learn how to validate your domain in our <a href="https://www.fastly.com/documentation/guides/integrations/logging-endpoints/log-streaming-https/">HTTPS endpoint documentation</a>.
url: https://www.fastly.com/documentation/reference/api/logging/https
---

Fastly will upload log messages to an HTTPS endpoint in the format specified in the HTTPS object. The HTTPS endpoint requires proof of domain ownership before logs can be received. Learn how to validate your domain in our <a href="https://www.fastly.com/documentation/guides/integrations/logging-endpoints/log-streaming-https/">HTTPS endpoint documentation</a>.

## Data model

| Field | Type | Description |
|-------|------|-------------|
| `content_type` | string | Content type of the header sent with the request. |
| `format` | string | A Fastly <a href="https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/">log format string</a>. |
| `header_name` | string | Name of the custom header sent with the request. |
| `header_value` | string | Value of the custom header sent with the request. |
| `json_format` | string | Enforces valid JSON formatting for log entries. |
| `message_type` | string | How the message should be formatted. |
| `method` | string | HTTP method used for request. |
| `period` | integer | How frequently, in seconds, batches of log data are sent to the HTTPS endpoint. A value of <code>0</code> sends logs at the same interval as the default, which is <code>5</code> seconds. |
| `request_max_bytes` | integer | The maximum number of bytes sent in one request. Defaults <code>0</code> (100MB). |
| `request_max_entries` | integer | The maximum number of logs sent in one request. Defaults <code>0</code> (10k). |
| `url` | string | The URL to send logs to. Must use HTTPS. Required. |
| `format_version` | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in <code>vcl_log</code> if <code>format_version</code> is set to <code>2</code> and in <code>vcl_deliver</code> if <code>format_version</code> is set to <code>1</code>. |
| `log_processing_region` | string | The geographic region where the logs will be processed before streaming. Valid values are <code>us</code>, <code>eu</code>, and <code>none</code> for global. |
| `name` | string | The name for the real-time logging configuration. |
| `placement` | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with <code>format_version</code> of 2 are placed in <code>vcl_log</code> and those with <code>format_version</code> of 1 are placed in <code>vcl_deliver</code>. |
| `response_condition` | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |
| `tls_ca_cert` | string | A secure certificate to authenticate a server with. Must be in PEM format. |
| `tls_client_cert` | string | The client certificate used to make authenticated requests. Must be in PEM format. |
| `tls_client_key` | string | The client private key used to make authenticated requests. Must be in PEM format. |
| `tls_hostname` | string | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. |
| `created_at` | string | Date and time in ISO 8601 format. (Read-only) |
| `deleted_at` | string | Date and time in ISO 8601 format. (Read-only) |
| `service_id` | string | Alphanumeric string identifying the service. (Read-only) |
| `updated_at` | string | Date and time in ISO 8601 format. (Read-only) |
| `version` | string | String identifying a service version. (Read-only) |

## API endpoints

### List HTTPS log endpoints

**GET** `/service/{service_id}/version/{version_id}/logging/https`

List all of the HTTPS objects for a particular service and version.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `service_id` | string | path | Yes | Alphanumeric string identifying the service. |
| `version_id` | integer | path | Yes | Integer identifying a service version. |

### Create an HTTPS log endpoint

**POST** `/service/{service_id}/version/{version_id}/logging/https`

Create an HTTPS object for a particular service and version.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `service_id` | string | path | Yes | Alphanumeric string identifying the service. |
| `version_id` | integer | path | Yes | Integer identifying a service version. |

### Get an HTTPS log endpoint

**GET** `/service/{service_id}/version/{version_id}/logging/https/{logging_https_name}`

Get the HTTPS object for a particular service and version.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `logging_https_name` | string | path | Yes | The name for the real-time logging configuration. |
| `service_id` | string | path | Yes | Alphanumeric string identifying the service. |
| `version_id` | integer | path | Yes | Integer identifying a service version. |

### Update an HTTPS log endpoint

**PUT** `/service/{service_id}/version/{version_id}/logging/https/{logging_https_name}`

Update the HTTPS object for a particular service and version.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `logging_https_name` | string | path | Yes | The name for the real-time logging configuration. |
| `service_id` | string | path | Yes | Alphanumeric string identifying the service. |
| `version_id` | integer | path | Yes | Integer identifying a service version. |

### Delete an HTTPS log endpoint

**DELETE** `/service/{service_id}/version/{version_id}/logging/https/{logging_https_name}`

Delete the HTTPS object for a particular service and version.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `logging_https_name` | string | path | Yes | The name for the real-time logging configuration. |
| `service_id` | string | path | Yes | Alphanumeric string identifying the service. |
| `version_id` | integer | path | Yes | Integer identifying a service version. |