# Create

Launch stage: GA

`POST /api/2.0/accounts/{log_delivery_configuration.account_id}/log-delivery`

Creates a new <Databricks> log delivery configuration to enable delivery of the specified type of logs to your storage location.
 This requires that you already created a credential object (which encapsulates a cross-account service IAM role)
 and a storage configuration object (which encapsulates an S3 bucket).

 For full details, including the required IAM role policies and bucket policies,
 see [Deliver and access billable usage logs](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html)
 or [Configure audit logging](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html).

 **Note**: There is a limit on the number of log delivery configurations available per account (each limit applies separately to each log type including billable usage and audit logs).
 You can create a maximum of two enabled account-level delivery configurations (configurations without a workspace filter) per type.
 Additionally, you can create two enabled workspace-level delivery configurations per workspace for each log type, which means that the same workspace ID can occur in the workspace filter for no more than two delivery configurations per log type.

 You cannot delete a log delivery configuration, but you can disable it (see Enable or disable log delivery configuration).

API scopes: billing

## Path parameters

- `log_delivery_configuration` (object, optional)
  - `config_id` (string, optional)
    The unique UUID of log delivery configuration
  - `config_name` (string, optional)
    The optional human-readable name of the log delivery configuration. Defaults to empty.
  - `log_type` (string, optional)
    Log delivery type. Supported values are:
     * `BILLABLE_USAGE` — Configure [billable usage log delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). For the CSV schema, see the [View billable usage](https://docs.databricks.com/administration-guide/account-settings/usage.html).
     * `AUDIT_LOGS` — Configure [audit log delivery](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html). For the JSON schema, see [Configure audit logging](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html)
    Possible values: `BILLABLE_USAGE`, `AUDIT_LOGS`
  - `output_format` (string, optional)
    The file type of log delivery.
     * If `log_type` is `BILLABLE_USAGE`, this value must be `CSV`. Only the CSV (comma-separated values) format is supported. For the schema, see the [View billable usage](https://docs.databricks.com/administration-guide/account-settings/usage.html)
     * If `log_type` is `AUDIT_LOGS`, this value must be `JSON`. Only the JSON (JavaScript Object Notation) format is supported. For the schema, see the [Configuring audit logs](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html).
    Possible values: `CSV`, `JSON`
  - `account_id` (string, optional)
    <Databricks> account ID.
    **AWS:** <Databricks> account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html).
  - `credentials_id` (string, optional)
    The ID for a method:credentials/create that represents the AWS IAM role with policy and trust relationship as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html).
  - `storage_configuration_id` (string, optional)
    The ID for a method:storage/create  that represents the S3 bucket with bucket policy as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html).
  - `workspace_ids_filter` (array of int64, optional)
    Optional filter that specifies workspace IDs to deliver logs for. By default the workspace filter is empty and log delivery applies at the account level, delivering workspace-level logs for all workspaces in your account, plus account level logs. You can optionally set this field to an array of workspace IDs (each one is an `int64`) to which log delivery should apply, in which case only workspace-level logs relating to the specified workspaces are delivered. If you plan to use different log delivery configurations for different workspaces, set this field explicitly. Be aware that delivery configurations mentioning specific workspaces won't apply to new workspaces created in the future, and delivery won't include account level logs. For some types of <Databricks> deployments there is only one workspace per account ID, so this field is unnecessary.
  - `delivery_path_prefix` (string, optional)
    The optional delivery path prefix within Amazon S3 storage. Defaults to empty, which means that logs are delivered to the root of the bucket. This must be a valid S3 object key. This must not start or end with a slash character.
  - `delivery_start_time` (string, optional)
    This field applies only if log_type is BILLABLE_USAGE. This is the optional start month and year for delivery, specified in YYYY-MM format. Defaults to current year and month. BILLABLE_USAGE logs are not available for usage before March 2019 (2019-03).
  - `status` (string, optional)
    Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable the configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration is not supported, so disable a log delivery configuration that is no longer needed.
    Possible values: `ENABLED`, `DISABLED`
  - `creation_time` (int64, optional)
    Time in epoch milliseconds when the log delivery configuration was created.
  - `update_time` (int64, optional)
    Time in epoch milliseconds when the log delivery configuration was updated.
  - `log_delivery_status` (object, optional)
    The LogDeliveryStatus of this log delivery configuration
    - `status` (string, optional)
      Enum that describes the status. Possible values are:
       * `CREATED`: There were no log delivery attempts since the config was created.
       * `SUCCEEDED`: The latest attempt of log delivery has succeeded completely.
       * `USER_FAILURE`: The latest attempt of log delivery failed because of misconfiguration of customer provided permissions on role or storage.
       * `SYSTEM_FAILURE`: The latest attempt of log delivery failed because of an <Databricks> internal error. Contact support if it doesn't go away soon.
       * `NOT_FOUND`: The log delivery status as the configuration has been disabled since the release of this feature or there are no workspaces in the account.
      Possible values: `CREATED`, `SUCCEEDED`, `USER_FAILURE`, `SYSTEM_FAILURE`, `NOT_FOUND`
    - `last_attempt_time` (string, optional)
      The UTC time for the latest log delivery attempt.
    - `last_successful_attempt_time` (string, optional)
      The UTC time for the latest successful log delivery.
    - `message` (string, optional)
      Informative message about the latest log delivery attempt. If the log delivery fails with USER_FAILURE, error details will be provided for fixing misconfigurations in cloud permissions.

## Returns

- `log_delivery_configuration` (object, optional)
  The created log delivery configuration
  - `config_id` (string, optional)
    The unique UUID of log delivery configuration
  - `config_name` (string, optional)
    The optional human-readable name of the log delivery configuration. Defaults to empty.
  - `log_type` (string, optional)
    Log delivery type. Supported values are:
     * `BILLABLE_USAGE` — Configure [billable usage log delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). For the CSV schema, see the [View billable usage](https://docs.databricks.com/administration-guide/account-settings/usage.html).
     * `AUDIT_LOGS` — Configure [audit log delivery](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html). For the JSON schema, see [Configure audit logging](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html)
    Possible values: `BILLABLE_USAGE`, `AUDIT_LOGS`
  - `output_format` (string, optional)
    The file type of log delivery.
     * If `log_type` is `BILLABLE_USAGE`, this value must be `CSV`. Only the CSV (comma-separated values) format is supported. For the schema, see the [View billable usage](https://docs.databricks.com/administration-guide/account-settings/usage.html)
     * If `log_type` is `AUDIT_LOGS`, this value must be `JSON`. Only the JSON (JavaScript Object Notation) format is supported. For the schema, see the [Configuring audit logs](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html).
    Possible values: `CSV`, `JSON`
  - `account_id` (string, optional)
    <Databricks> account ID.
    **AWS:** <Databricks> account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html).
  - `credentials_id` (string, optional)
    The ID for a method:credentials/create that represents the AWS IAM role with policy and trust relationship as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html).
  - `storage_configuration_id` (string, optional)
    The ID for a method:storage/create  that represents the S3 bucket with bucket policy as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html).
  - `workspace_ids_filter` (array of int64, optional)
    Optional filter that specifies workspace IDs to deliver logs for. By default the workspace filter is empty and log delivery applies at the account level, delivering workspace-level logs for all workspaces in your account, plus account level logs. You can optionally set this field to an array of workspace IDs (each one is an `int64`) to which log delivery should apply, in which case only workspace-level logs relating to the specified workspaces are delivered. If you plan to use different log delivery configurations for different workspaces, set this field explicitly. Be aware that delivery configurations mentioning specific workspaces won't apply to new workspaces created in the future, and delivery won't include account level logs. For some types of <Databricks> deployments there is only one workspace per account ID, so this field is unnecessary.
  - `delivery_path_prefix` (string, optional)
    The optional delivery path prefix within Amazon S3 storage. Defaults to empty, which means that logs are delivered to the root of the bucket. This must be a valid S3 object key. This must not start or end with a slash character.
  - `delivery_start_time` (string, optional)
    This field applies only if log_type is BILLABLE_USAGE. This is the optional start month and year for delivery, specified in YYYY-MM format. Defaults to current year and month. BILLABLE_USAGE logs are not available for usage before March 2019 (2019-03).
  - `status` (string, optional)
    Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable the configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration is not supported, so disable a log delivery configuration that is no longer needed.
    Possible values: `ENABLED`, `DISABLED`
  - `creation_time` (int64, optional)
    Time in epoch milliseconds when the log delivery configuration was created.
  - `update_time` (int64, optional)
    Time in epoch milliseconds when the log delivery configuration was updated.
  - `log_delivery_status` (object, optional)
    The LogDeliveryStatus of this log delivery configuration
    - `status` (string, optional)
      Enum that describes the status. Possible values are:
       * `CREATED`: There were no log delivery attempts since the config was created.
       * `SUCCEEDED`: The latest attempt of log delivery has succeeded completely.
       * `USER_FAILURE`: The latest attempt of log delivery failed because of misconfiguration of customer provided permissions on role or storage.
       * `SYSTEM_FAILURE`: The latest attempt of log delivery failed because of an <Databricks> internal error. Contact support if it doesn't go away soon.
       * `NOT_FOUND`: The log delivery status as the configuration has been disabled since the release of this feature or there are no workspaces in the account.
      Possible values: `CREATED`, `SUCCEEDED`, `USER_FAILURE`, `SYSTEM_FAILURE`, `NOT_FOUND`
    - `last_attempt_time` (string, optional)
      The UTC time for the latest log delivery attempt.
    - `last_successful_attempt_time` (string, optional)
      The UTC time for the latest successful log delivery.
    - `message` (string, optional)
      Informative message about the latest log delivery attempt. If the log delivery fails with USER_FAILURE, error details will be provided for fixing misconfigurations in cloud permissions.

## Response

```json
{
  "log_delivery_configuration": {
    "config_id": "string",
    "config_name": "string",
    "log_type": "string",
    "output_format": "string",
    "account_id": "string",
    "credentials_id": "string",
    "storage_configuration_id": "string",
    "workspace_ids_filter": [
      0
    ],
    "delivery_path_prefix": "string",
    "delivery_start_time": "string",
    "status": "string",
    "creation_time": 0,
    "update_time": 0,
    "log_delivery_status": {}
  }
}
```