# Deployment Configuration
URL: https://docs.datarobot.com/en/docs/api/reference/public-api/deployment_configuration.html

> Use the endpoints described below to manage deployment configuration. Configure capabilities of your current deployment based on the data provided, for example, training data, prediction data, or actuals. After you create and configure a deployment, you can use the deployment settings to add or update deployment functionality that wasn't configured during deployment creation.

# Deployment Configuration

Use the endpoints described below to manage deployment configuration. Configure capabilities of your current deployment based on the data provided, for example, training data, prediction data, or actuals. After you create and configure a deployment, you can use the deployment settings to add or update deployment functionality that wasn't configured during deployment creation.

## Retrieve deployment health settings by deployment ID

Operation path: `GET /api/v2/deployments/{deploymentId}/healthSettings/`

Authentication requirements: `BearerAuth`

Retrieve deployment health settings.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| deploymentId | path | string | true | Unique identifier of the deployment. |

### Example responses

> 200 Response

```
{
  "properties": {
    "accuracy": {
      "description": "Accuracy health status setting.",
      "properties": {
        "batchCount": {
          "description": "Number of recent batches used to compute accuracy health status, only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ],
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "failingThreshold": {
          "description": "Threshold for failing status.",
          "type": [
            "number",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "measurement": {
          "description": "Measurement for calculating accuracy health status.",
          "enum": [
            "percent",
            "value"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "metric": {
          "description": "Metric used for calculating accuracy health status.",
          "enum": [
            "AUC",
            "Accuracy",
            "Balanced Accuracy",
            "F1",
            "FPR",
            "FVE Binomial",
            "FVE Gamma",
            "FVE Multinomial",
            "FVE Poisson",
            "FVE Tweedie",
            "Gamma Deviance",
            "Gini Norm",
            "Kolmogorov-Smirnov",
            "LogLoss",
            "MAE",
            "MAPE",
            "MCC",
            "NPV",
            "PPV",
            "Poisson Deviance",
            "R Squared",
            "RMSE",
            "RMSLE",
            "Rate@Top10%",
            "Rate@Top5%",
            "TNR",
            "TPR",
            "Tweedie Deviance",
            "WGS84 MAE",
            "WGS84 RMSE"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "warningThreshold": {
          "description": "Threshold for warning status.",
          "type": [
            "number",
            "null"
          ],
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "actualsTimeliness": {
      "description": "Predictions timeliness health setting.",
      "properties": {
        "enabled": {
          "description": "Indicates if timeliness status is enabled.",
          "type": "boolean",
          "x-versionadded": "v2.33"
        },
        "expectedFrequency": {
          "description": "Expected frequency for receiving data as an ISO 8601 duration string.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "customMetrics": {
      "description": "Custom metrics health status setting.",
      "properties": {
        "failingConditions": {
          "description": "Conditions for failing status.",
          "items": {
            "properties": {
              "categoryName": {
                "description": "Category name for the custom metric. Only relevant for categorical metrics.",
                "maxLength": 256,
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.36"
              },
              "compareOperator": {
                "description": "Defines how the custom metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "metricId": {
                "description": "Custom metric ID.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "compareOperator",
              "metricId",
              "threshold"
            ],
            "type": "object"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "warningConditions": {
          "description": "Conditions for warning status.",
          "items": {
            "properties": {
              "categoryName": {
                "description": "Category name for the custom metric. Only relevant for categorical metrics.",
                "maxLength": 256,
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.36"
              },
              "compareOperator": {
                "description": "Defines how the custom metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "metricId": {
                "description": "Custom metric ID.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "compareOperator",
              "metricId",
              "threshold"
            ],
            "type": "object"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "dataDrift": {
      "description": "Data drift health status setting.",
      "properties": {
        "batchCount": {
          "description": "Number of recent batches used to compute data drift health status, only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ],
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "driftThreshold": {
          "description": "The drift metric threshold above which the feature is considered as drifted.",
          "maximum": 1,
          "minimum": 0,
          "type": "number",
          "x-versionadded": "v2.33"
        },
        "excludedFeatures": {
          "description": "Features that are excluded from data drift status consideration.",
          "items": {
            "maxLength": 256,
            "type": "string"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "highImportanceFailingCount": {
          "description": "Threshold of drifted high importance feature count for failing status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "highImportanceWarningCount": {
          "description": "Threshold of drifted high importance feature count for warning status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "importanceThreshold": {
          "description": "The feature importance threshold above which the feature is considered as important.",
          "maximum": 1,
          "minimum": 0,
          "type": "number",
          "x-versionadded": "v2.33"
        },
        "lowImportanceFailingCount": {
          "description": "Threshold of drifted low importance feature count for failing status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "lowImportanceWarningCount": {
          "description": "Threshold of drifted low importance feature count for warning status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "starredFeatures": {
          "description": "Features that are deemed to be of high importance, regardless of how their feature importance values compare against the threshold.",
          "items": {
            "maxLength": 256,
            "type": "string"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "timeInterval": {
          "description": "Time duration used to compute data drift health status, only applicable to deployments with batch monitoring disabled.",
          "enum": [
            "T2H",
            "P1D",
            "P7D",
            "P30D",
            "P90D",
            "P180D",
            "P365D"
          ],
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "fairness": {
      "description": "Fairness health status setting. Only available if deployment supports fairness.",
      "properties": {
        "protectedClassFailingCount": {
          "description": "Number of protected class below fairness threshold for failing status.",
          "minimum": 1,
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "protectedClassWarningCount": {
          "description": "Number of protected class below fairness threshold for warning status.",
          "minimum": 1,
          "type": "integer",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "predictionsTimeliness": {
      "description": "Predictions timeliness health setting.",
      "properties": {
        "enabled": {
          "description": "Indicates if timeliness status is enabled.",
          "type": "boolean",
          "x-versionadded": "v2.33"
        },
        "expectedFrequency": {
          "description": "Expected frequency for receiving data as an ISO 8601 duration string.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "service": {
      "description": "Service health status setting.",
      "properties": {
        "batchCount": {
          "description": "Number of recent batches used to compute the service health status. Only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ],
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "failingConditions": {
          "description": "Conditions for \"failing\" status.",
          "items": {
            "properties": {
              "compareOperator": {
                "description": "Defines how the metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string"
              },
              "metric": {
                "description": "Service health metric to evaluate.",
                "enum": [
                  "dataErrorCount",
                  "serverErrorCount",
                  "dataErrorPercent",
                  "serverErrorPercent",
                  "medianResponseTimeMs",
                  "medianExecutionTimeMs"
                ],
                "type": "string"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number"
              }
            },
            "required": [
              "compareOperator",
              "metric",
              "threshold"
            ],
            "type": "object",
            "x-versionadded": "v2.41"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.41"
        },
        "timeInterval": {
          "description": "Amount of time used to compute service health status. Only applicable to deployments with batch monitoring disabled.",
          "enum": [
            "T1H",
            "T2H",
            "P1D",
            "P7D",
            "P30D",
            "P90D",
            "P180D",
            "P365D"
          ],
          "type": "string",
          "x-versionadded": "v2.41"
        },
        "warningConditions": {
          "description": "Conditions for \"warning\" status.",
          "items": {
            "properties": {
              "compareOperator": {
                "description": "Defines how the metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string"
              },
              "metric": {
                "description": "Service health metric to evaluate.",
                "enum": [
                  "dataErrorCount",
                  "serverErrorCount",
                  "dataErrorPercent",
                  "serverErrorPercent",
                  "medianResponseTimeMs",
                  "medianExecutionTimeMs"
                ],
                "type": "string"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number"
              }
            },
            "required": [
              "compareOperator",
              "metric",
              "threshold"
            ],
            "type": "object",
            "x-versionadded": "v2.41"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.41"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Deployment health settings. | HealthSettings |

## Update deployment health settings by deployment ID

Operation path: `PATCH /api/v2/deployments/{deploymentId}/healthSettings/`

Authentication requirements: `BearerAuth`

Update deployment health settings.

### Body parameter

```
{
  "properties": {
    "accuracy": {
      "description": "Accuracy health status setting.",
      "properties": {
        "batchCount": {
          "description": "Number of recent batches used to compute accuracy health status, only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ],
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "failingThreshold": {
          "description": "Threshold for failing status.",
          "type": [
            "number",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "measurement": {
          "description": "Measurement for calculating accuracy health status.",
          "enum": [
            "percent",
            "value"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "metric": {
          "description": "Metric used for calculating accuracy health status.",
          "enum": [
            "AUC",
            "Accuracy",
            "Balanced Accuracy",
            "F1",
            "FPR",
            "FVE Binomial",
            "FVE Gamma",
            "FVE Multinomial",
            "FVE Poisson",
            "FVE Tweedie",
            "Gamma Deviance",
            "Gini Norm",
            "Kolmogorov-Smirnov",
            "LogLoss",
            "MAE",
            "MAPE",
            "MCC",
            "NPV",
            "PPV",
            "Poisson Deviance",
            "R Squared",
            "RMSE",
            "RMSLE",
            "Rate@Top10%",
            "Rate@Top5%",
            "TNR",
            "TPR",
            "Tweedie Deviance",
            "WGS84 MAE",
            "WGS84 RMSE"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "warningThreshold": {
          "description": "Threshold for warning status.",
          "type": [
            "number",
            "null"
          ],
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "actualsTimeliness": {
      "description": "Predictions timeliness health setting.",
      "properties": {
        "enabled": {
          "description": "Indicates if timeliness status is enabled.",
          "type": "boolean",
          "x-versionadded": "v2.33"
        },
        "expectedFrequency": {
          "description": "Expected frequency for receiving data as an ISO 8601 duration string.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "customMetrics": {
      "description": "Custom metrics health status setting.",
      "properties": {
        "failingConditions": {
          "description": "Conditions for failing status.",
          "items": {
            "properties": {
              "categoryName": {
                "description": "Category name for the custom metric. Only relevant for categorical metrics.",
                "maxLength": 256,
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.36"
              },
              "compareOperator": {
                "description": "Defines how the custom metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "metricId": {
                "description": "Custom metric ID.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "compareOperator",
              "metricId",
              "threshold"
            ],
            "type": "object"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "warningConditions": {
          "description": "Conditions for warning status.",
          "items": {
            "properties": {
              "categoryName": {
                "description": "Category name for the custom metric. Only relevant for categorical metrics.",
                "maxLength": 256,
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.36"
              },
              "compareOperator": {
                "description": "Defines how the custom metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "metricId": {
                "description": "Custom metric ID.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "compareOperator",
              "metricId",
              "threshold"
            ],
            "type": "object"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "dataDrift": {
      "description": "Data drift health status setting.",
      "properties": {
        "batchCount": {
          "description": "Number of recent batches used to compute data drift health status, only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ],
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "driftThreshold": {
          "description": "The drift metric threshold above which the feature is considered as drifted.",
          "maximum": 1,
          "minimum": 0,
          "type": "number",
          "x-versionadded": "v2.33"
        },
        "excludedFeatures": {
          "description": "Features that are excluded from data drift status consideration.",
          "items": {
            "maxLength": 256,
            "type": "string"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "highImportanceFailingCount": {
          "description": "Threshold of drifted high importance feature count for failing status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "highImportanceWarningCount": {
          "description": "Threshold of drifted high importance feature count for warning status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "importanceThreshold": {
          "description": "The feature importance threshold above which the feature is considered as important.",
          "maximum": 1,
          "minimum": 0,
          "type": "number",
          "x-versionadded": "v2.33"
        },
        "lowImportanceFailingCount": {
          "description": "Threshold of drifted low importance feature count for failing status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "lowImportanceWarningCount": {
          "description": "Threshold of drifted low importance feature count for warning status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "starredFeatures": {
          "description": "Features that are deemed to be of high importance, regardless of how their feature importance values compare against the threshold.",
          "items": {
            "maxLength": 256,
            "type": "string"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "timeInterval": {
          "description": "Time duration used to compute data drift health status, only applicable to deployments with batch monitoring disabled.",
          "enum": [
            "T2H",
            "P1D",
            "P7D",
            "P30D",
            "P90D",
            "P180D",
            "P365D"
          ],
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "fairness": {
      "description": "Fairness health status setting. Only available if deployment supports fairness.",
      "properties": {
        "protectedClassFailingCount": {
          "description": "Number of protected class below fairness threshold for failing status.",
          "minimum": 1,
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "protectedClassWarningCount": {
          "description": "Number of protected class below fairness threshold for warning status.",
          "minimum": 1,
          "type": "integer",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "predictionsTimeliness": {
      "description": "Predictions timeliness health setting.",
      "properties": {
        "enabled": {
          "description": "Indicates if timeliness status is enabled.",
          "type": "boolean",
          "x-versionadded": "v2.33"
        },
        "expectedFrequency": {
          "description": "Expected frequency for receiving data as an ISO 8601 duration string.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "service": {
      "description": "Service health status setting.",
      "properties": {
        "batchCount": {
          "description": "Number of recent batches used to compute the service health status. Only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ],
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "failingConditions": {
          "description": "Conditions for \"failing\" status.",
          "items": {
            "properties": {
              "compareOperator": {
                "description": "Defines how the metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string"
              },
              "metric": {
                "description": "Service health metric to evaluate.",
                "enum": [
                  "dataErrorCount",
                  "serverErrorCount",
                  "dataErrorPercent",
                  "serverErrorPercent",
                  "medianResponseTimeMs",
                  "medianExecutionTimeMs"
                ],
                "type": "string"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number"
              }
            },
            "required": [
              "compareOperator",
              "metric",
              "threshold"
            ],
            "type": "object",
            "x-versionadded": "v2.41"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.41"
        },
        "timeInterval": {
          "description": "Amount of time used to compute service health status. Only applicable to deployments with batch monitoring disabled.",
          "enum": [
            "T1H",
            "T2H",
            "P1D",
            "P7D",
            "P30D",
            "P90D",
            "P180D",
            "P365D"
          ],
          "type": "string",
          "x-versionadded": "v2.41"
        },
        "warningConditions": {
          "description": "Conditions for \"warning\" status.",
          "items": {
            "properties": {
              "compareOperator": {
                "description": "Defines how the metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string"
              },
              "metric": {
                "description": "Service health metric to evaluate.",
                "enum": [
                  "dataErrorCount",
                  "serverErrorCount",
                  "dataErrorPercent",
                  "serverErrorPercent",
                  "medianResponseTimeMs",
                  "medianExecutionTimeMs"
                ],
                "type": "string"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number"
              }
            },
            "required": [
              "compareOperator",
              "metric",
              "threshold"
            ],
            "type": "object",
            "x-versionadded": "v2.41"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.41"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| deploymentId | path | string | true | Unique identifier of the deployment. |
| body | body | HealthSettings | false | none |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Updated deployment health settings. | None |

## Retrieve default deployment health settings by deployment ID

Operation path: `GET /api/v2/deployments/{deploymentId}/healthSettings/defaults/`

Authentication requirements: `BearerAuth`

Retrieve default deployment health settings.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| deploymentId | path | string | true | Unique identifier of the deployment. |

### Example responses

> 200 Response

```
{
  "properties": {
    "accuracy": {
      "description": "Accuracy health status setting.",
      "properties": {
        "batchCount": {
          "description": "Number of recent batches used to compute accuracy health status, only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ],
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "failingThreshold": {
          "description": "Threshold for failing status.",
          "type": [
            "number",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "measurement": {
          "description": "Measurement for calculating accuracy health status.",
          "enum": [
            "percent",
            "value"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "metric": {
          "description": "Metric used for calculating accuracy health status.",
          "enum": [
            "AUC",
            "Accuracy",
            "Balanced Accuracy",
            "F1",
            "FPR",
            "FVE Binomial",
            "FVE Gamma",
            "FVE Multinomial",
            "FVE Poisson",
            "FVE Tweedie",
            "Gamma Deviance",
            "Gini Norm",
            "Kolmogorov-Smirnov",
            "LogLoss",
            "MAE",
            "MAPE",
            "MCC",
            "NPV",
            "PPV",
            "Poisson Deviance",
            "R Squared",
            "RMSE",
            "RMSLE",
            "Rate@Top10%",
            "Rate@Top5%",
            "TNR",
            "TPR",
            "Tweedie Deviance",
            "WGS84 MAE",
            "WGS84 RMSE"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "warningThreshold": {
          "description": "Threshold for warning status.",
          "type": [
            "number",
            "null"
          ],
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "actualsTimeliness": {
      "description": "Predictions timeliness health setting.",
      "properties": {
        "enabled": {
          "description": "Indicates if timeliness status is enabled.",
          "type": "boolean",
          "x-versionadded": "v2.33"
        },
        "expectedFrequency": {
          "description": "Expected frequency for receiving data as an ISO 8601 duration string.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "customMetrics": {
      "description": "Custom metrics health status setting.",
      "properties": {
        "failingConditions": {
          "description": "Conditions for failing status.",
          "items": {
            "properties": {
              "categoryName": {
                "description": "Category name for the custom metric. Only relevant for categorical metrics.",
                "maxLength": 256,
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.36"
              },
              "compareOperator": {
                "description": "Defines how the custom metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "metricId": {
                "description": "Custom metric ID.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "compareOperator",
              "metricId",
              "threshold"
            ],
            "type": "object"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "warningConditions": {
          "description": "Conditions for warning status.",
          "items": {
            "properties": {
              "categoryName": {
                "description": "Category name for the custom metric. Only relevant for categorical metrics.",
                "maxLength": 256,
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.36"
              },
              "compareOperator": {
                "description": "Defines how the custom metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "metricId": {
                "description": "Custom metric ID.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "compareOperator",
              "metricId",
              "threshold"
            ],
            "type": "object"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "dataDrift": {
      "description": "Data drift health status setting.",
      "properties": {
        "batchCount": {
          "description": "Number of recent batches used to compute data drift health status, only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ],
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "driftThreshold": {
          "description": "The drift metric threshold above which the feature is considered as drifted.",
          "maximum": 1,
          "minimum": 0,
          "type": "number",
          "x-versionadded": "v2.33"
        },
        "excludedFeatures": {
          "description": "Features that are excluded from data drift status consideration.",
          "items": {
            "maxLength": 256,
            "type": "string"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "highImportanceFailingCount": {
          "description": "Threshold of drifted high importance feature count for failing status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "highImportanceWarningCount": {
          "description": "Threshold of drifted high importance feature count for warning status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "importanceThreshold": {
          "description": "The feature importance threshold above which the feature is considered as important.",
          "maximum": 1,
          "minimum": 0,
          "type": "number",
          "x-versionadded": "v2.33"
        },
        "lowImportanceFailingCount": {
          "description": "Threshold of drifted low importance feature count for failing status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "lowImportanceWarningCount": {
          "description": "Threshold of drifted low importance feature count for warning status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "starredFeatures": {
          "description": "Features that are deemed to be of high importance, regardless of how their feature importance values compare against the threshold.",
          "items": {
            "maxLength": 256,
            "type": "string"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "timeInterval": {
          "description": "Time duration used to compute data drift health status, only applicable to deployments with batch monitoring disabled.",
          "enum": [
            "T2H",
            "P1D",
            "P7D",
            "P30D",
            "P90D",
            "P180D",
            "P365D"
          ],
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "fairness": {
      "description": "Fairness health status setting. Only available if deployment supports fairness.",
      "properties": {
        "protectedClassFailingCount": {
          "description": "Number of protected class below fairness threshold for failing status.",
          "minimum": 1,
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "protectedClassWarningCount": {
          "description": "Number of protected class below fairness threshold for warning status.",
          "minimum": 1,
          "type": "integer",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "predictionsTimeliness": {
      "description": "Predictions timeliness health setting.",
      "properties": {
        "enabled": {
          "description": "Indicates if timeliness status is enabled.",
          "type": "boolean",
          "x-versionadded": "v2.33"
        },
        "expectedFrequency": {
          "description": "Expected frequency for receiving data as an ISO 8601 duration string.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "service": {
      "description": "Service health status setting.",
      "properties": {
        "batchCount": {
          "description": "Number of recent batches used to compute the service health status. Only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ],
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "failingConditions": {
          "description": "Conditions for \"failing\" status.",
          "items": {
            "properties": {
              "compareOperator": {
                "description": "Defines how the metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string"
              },
              "metric": {
                "description": "Service health metric to evaluate.",
                "enum": [
                  "dataErrorCount",
                  "serverErrorCount",
                  "dataErrorPercent",
                  "serverErrorPercent",
                  "medianResponseTimeMs",
                  "medianExecutionTimeMs"
                ],
                "type": "string"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number"
              }
            },
            "required": [
              "compareOperator",
              "metric",
              "threshold"
            ],
            "type": "object",
            "x-versionadded": "v2.41"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.41"
        },
        "timeInterval": {
          "description": "Amount of time used to compute service health status. Only applicable to deployments with batch monitoring disabled.",
          "enum": [
            "T1H",
            "T2H",
            "P1D",
            "P7D",
            "P30D",
            "P90D",
            "P180D",
            "P365D"
          ],
          "type": "string",
          "x-versionadded": "v2.41"
        },
        "warningConditions": {
          "description": "Conditions for \"warning\" status.",
          "items": {
            "properties": {
              "compareOperator": {
                "description": "Defines how the metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string"
              },
              "metric": {
                "description": "Service health metric to evaluate.",
                "enum": [
                  "dataErrorCount",
                  "serverErrorCount",
                  "dataErrorPercent",
                  "serverErrorPercent",
                  "medianResponseTimeMs",
                  "medianExecutionTimeMs"
                ],
                "type": "string"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number"
              }
            },
            "required": [
              "compareOperator",
              "metric",
              "threshold"
            ],
            "type": "object",
            "x-versionadded": "v2.41"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.41"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Default deployment health settings. | HealthSettings |

## Retrieve secondary datasets configuration by deployment ID

Operation path: `GET /api/v2/deployments/{deploymentId}/model/secondaryDatasetConfiguration/`

Authentication requirements: `BearerAuth`

Retrieve the secondary datasets configuration used by a deployed Feature Discovery model.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| deploymentId | path | string | true | Unique identifier of the deployment. |

### Example responses

> 200 Response

```
{
  "properties": {
    "created": {
      "description": "DR-formatted datetime, null for legacy (before DR 6.0) db records.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.24"
    },
    "creatorFullName": {
      "description": "Full name or email of the user who created this config. Null for legacy (before DR 6.0) db records.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.24"
    },
    "creatorUserId": {
      "description": "ID of the user who created this config, null for legacy (before DR 6.0) db records.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.24"
    },
    "credentialIds": {
      "description": "The list of credentials used by the secondary datasets if the datasets used in the configuration are from a datasource.",
      "items": {
        "properties": {
          "catalogVersionId": {
            "description": "ID of the catalog version.",
            "type": "string"
          },
          "credentialId": {
            "description": "ID of the credential store to be used for the given catalog version.",
            "type": "string"
          },
          "url": {
            "description": "The URL of the datasource.",
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "catalogVersionId",
          "credentialId"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "featurelistId": {
      "description": "ID of the feature list.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.24"
    },
    "isDefault": {
      "description": "Whether the secondary datasets config is the default config.",
      "type": "boolean"
    },
    "isDeleted": {
      "description": "Whether the secondary datasets config is soft-deleted.",
      "type": "boolean"
    },
    "name": {
      "description": "Name of the secondary datasets config.",
      "type": [
        "string",
        "null"
      ]
    },
    "projectId": {
      "description": "ID of the project.",
      "type": [
        "string",
        "null"
      ]
    },
    "secondaryDatasetConfigId": {
      "description": "ID of the secondary datasets configuration.",
      "type": "string"
    },
    "secondaryDatasets": {
      "description": "The list of secondary datasets used in the config.",
      "items": {
        "properties": {
          "catalogId": {
            "description": "ID of the catalog item.",
            "type": "string"
          },
          "catalogVersionId": {
            "description": "ID of the catalog version.",
            "type": "string"
          },
          "identifier": {
            "description": "Short name of this table (used directly as part of generated feature names).",
            "maxLength": 45,
            "minLength": 1,
            "type": "string"
          },
          "snapshotPolicy": {
            "description": "Policy to use by a dataset while making prediction.",
            "enum": [
              "specified",
              "latest",
              "dynamic"
            ],
            "type": "string"
          }
        },
        "required": [
          "catalogId",
          "catalogVersionId",
          "identifier",
          "snapshotPolicy"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.24"
    }
  },
  "required": [
    "created",
    "creatorFullName",
    "creatorUserId",
    "featurelistId",
    "isDefault",
    "isDeleted",
    "name",
    "projectId",
    "secondaryDatasetConfigId"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Secondary datasets configuration. | SecondaryDatasetConfigResponse |
| 404 | Not Found | Deployment or secondary datasets configuration cannot be found for the deployed model. | None |

## Update the secondary datasets configuration by deployment ID

Operation path: `PATCH /api/v2/deployments/{deploymentId}/model/secondaryDatasetConfiguration/`

Authentication requirements: `BearerAuth`

Update the secondary datasets configuration used by the deployed feature discovery model.

### Body parameter

```
{
  "properties": {
    "credentialsIds": {
      "description": "The list of credentials used by the secondary datasets.",
      "items": {
        "properties": {
          "catalogVersionId": {
            "description": "ID of the catalog version.",
            "type": "string"
          },
          "credentialId": {
            "description": "ID of the credential store to be used for the given catalog version.",
            "type": "string"
          },
          "url": {
            "description": "The URL of the datasource.",
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "catalogVersionId",
          "credentialId"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "secondaryDatasetConfigId": {
      "description": "ID of the secondary datasets configuration to be used at the time of prediction.",
      "type": "string"
    }
  },
  "required": [
    "secondaryDatasetConfigId"
  ],
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| deploymentId | path | string | true | Unique identifier of the deployment. |
| body | body | SecondaryDatasetConfigUpdate | false | none |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | Secondary Datasets Configuration updated successfully. | None |
| 403 | Forbidden | Invalid credentials for secondary datasets configuration. | None |

## List the secondary datasets configuration history by deployment ID

Operation path: `GET /api/v2/deployments/{deploymentId}/model/secondaryDatasetConfigurationHistory/`

Authentication requirements: `BearerAuth`

List all the secondary datasets configuration used by a given Feature Discovery deployment.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | true | Number of items to skip. Defaults to 0 if not provided. |
| limit | query | integer | true | Number of items to return, defaults to 100 if not provided. |
| deploymentId | path | string | true | Unique identifier of the deployment. |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "Number of items.",
      "type": "integer"
    },
    "data": {
      "description": "Secondary datasets configuration history.",
      "items": {
        "properties": {
          "configId": {
            "description": "ID of the secondary datasets configuration.",
            "type": "string"
          },
          "configName": {
            "description": "The name of the secondary datasets config.",
            "type": "string"
          },
          "updated": {
            "description": "Timestamp when configuration was updated on the given deployment.",
            "type": "string"
          },
          "username": {
            "description": "The name of the user who made the update.",
            "type": "string"
          }
        },
        "required": [
          "configId",
          "configName",
          "updated",
          "username"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "next": {
      "description": "URL pointing to the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "URL pointing to the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Secondary Datasets Configuration history. | SecondaryDatasetsConfigListResponse |

## Retrieve deployment settings by deployment ID

Operation path: `GET /api/v2/deployments/{deploymentId}/settings/`

Authentication requirements: `BearerAuth`

Retrieve deployment settings.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| deploymentId | path | string | true | Unique identifier of the deployment. |

### Example responses

> 200 Response

```
{
  "properties": {
    "associationId": {
      "description": "The association ID setting for the deployment.",
      "properties": {
        "columnNames": {
          "description": "List of column names used to represent an association ID.",
          "items": {
            "type": "string"
          },
          "maxItems": 1,
          "minItems": 1,
          "type": "array"
        },
        "requiredInPredictionRequests": {
          "description": "Indicates whether the association ID is required in prediction requests.Note that you may not change an association ID's column names after they have been set and predictions including those columns have been made.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "automaticActuals": {
      "description": "Automatic actuals setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether automatic actuals is enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object",
      "x-versionadded": "v2.25"
    },
    "biasAndFairness": {
      "description": "Bias and fairness setting for the deployment.",
      "properties": {
        "fairnessMetricsSet": {
          "description": "A set of fairness metrics to use for calculating fairness.",
          "enum": [
            "proportionalParity",
            "equalParity",
            "predictionBalance",
            "trueFavorableAndUnfavorableRateParity",
            "favorableAndUnfavorablePredictiveValueParity"
          ],
          "type": "string"
        },
        "fairnessThreshold": {
          "description": "Threshold value of the fairness metric.",
          "maximum": 1,
          "minimum": 0,
          "type": "number"
        },
        "preferableTargetValue": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "integer"
            },
            {
              "type": "string"
            }
          ],
          "description": "A target value that should be treated as a positive outcome for the prediction."
        },
        "protectedFeatures": {
          "description": "A list of features to mark as protected for bias and fairness measurement.",
          "items": {
            "type": "string"
          },
          "maxItems": 10,
          "minItems": 1,
          "type": "array"
        }
      },
      "required": [
        "fairnessMetricsSet",
        "fairnessThreshold",
        "preferableTargetValue",
        "protectedFeatures"
      ],
      "type": "object"
    },
    "challengerModels": {
      "description": "Challenger models setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether challenger models are enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "featureDrift": {
      "description": "The feature drift setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether feature drift tracking is enabled for this deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "humility": {
      "description": "Humility setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether humility rules are enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "predictionIntervals": {
      "description": "The prediction intervals setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether prediction intervals are enabled for this deployment. ",
          "type": "boolean"
        },
        "percentiles": {
          "description": "The percentiles used for this deployment. Currently, we support at most one percentile at a time.",
          "items": {
            "type": "integer"
          },
          "type": "array"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "predictionWarning": {
      "description": "The prediction warning setting for the deployment.",
      "properties": {
        "customBoundaries": {
          "description": "Null if default boundaries for the model are used",
          "properties": {
            "lower": {
              "description": "All predictions less than provided value are considered anomalous.",
              "type": "number"
            },
            "upper": {
              "description": "All predictions greater than provided value are considered anomalous.",
              "type": "number"
            }
          },
          "required": [
            "lower",
            "upper"
          ],
          "type": "object"
        },
        "enabled": {
          "description": "Indicates whether prediction warnings are enabled for this deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "predictionsByForecastDate": {
      "description": "Forecast date setting for the deployment.",
      "properties": {
        "columnName": {
          "description": "The column name in prediction datasets to be used as forecast date",
          "type": [
            "string",
            "null"
          ]
        },
        "datetimeFormat": {
          "description": "The datetime format of the forecast date column in prediction datasets.\nFor time series deployments using the datetime format `%Y-%m-%d %H:%M:%S.%f`,\nDataRobot automatically populates a `v2` in front of the timestamp format.\nDate/time values submitted in prediction data should not include this `v2` prefix.\nOther timestamp formats are not affected.\n",
          "type": [
            "string",
            "null"
          ]
        },
        "enabled": {
          "description": "Indicates whether predictions by forecast dates is enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object",
      "x-versionadded": "v2.35"
    },
    "predictionsDataCollection": {
      "description": "The predictions data collection setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether incoming prediction requests and results should be stored in record-level storage.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "processingLimits": {
      "description": "Processing limits setting for the deployment.",
      "properties": {
        "interval": {
          "description": "A time interval that is applied when calculating processing limits.",
          "enum": [
            "hour",
            "day",
            "week"
          ],
          "type": "string"
        }
      },
      "required": [
        "interval"
      ],
      "type": "object"
    },
    "segmentAnalysis": {
      "description": "The segment analysis setting for the deployment.",
      "properties": {
        "attributes": {
          "description": "The segment attributes to be tracked. Note that only categorical columns can be specified as tracked segment attributes. The target column may not be specified",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "enabled": {
          "description": "Indicates whether service health, drift, and accuracy are tracked for segments of prediction data.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "targetDrift": {
      "description": "The target drift setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether target drift tracking is enabled for this deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    }
  },
  "required": [
    "associationId",
    "featureDrift",
    "predictionIntervals",
    "targetDrift"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | The deployment settings | DeploymentSettingsResponse |

## Update deployment settings by deployment ID

Operation path: `PATCH /api/v2/deployments/{deploymentId}/settings/`

Authentication requirements: `BearerAuth`

Updates deployment settings.

### Body parameter

```
{
  "properties": {
    "associationId": {
      "description": "The association ID setting for the deployment.",
      "properties": {
        "columnNames": {
          "description": "List of column names used to represent an association ID.",
          "items": {
            "type": "string"
          },
          "maxItems": 1,
          "minItems": 1,
          "type": "array"
        },
        "requiredInPredictionRequests": {
          "description": "Indicates whether the association ID is required in prediction requests.Note that you may not change an association ID's column names after they have been set and predictions including those columns have been made.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "automaticActuals": {
      "description": "Automatic actuals setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether automatic actuals is enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object",
      "x-versionadded": "v2.25"
    },
    "biasAndFairness": {
      "description": "Bias and fairness setting for the deployment.",
      "properties": {
        "fairnessMetricsSet": {
          "description": "A set of fairness metrics to use for calculating fairness.",
          "enum": [
            "proportionalParity",
            "equalParity",
            "predictionBalance",
            "trueFavorableAndUnfavorableRateParity",
            "favorableAndUnfavorablePredictiveValueParity"
          ],
          "type": "string"
        },
        "fairnessThreshold": {
          "description": "Threshold value of the fairness metric.",
          "maximum": 1,
          "minimum": 0,
          "type": "number"
        },
        "preferableTargetValue": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "integer"
            },
            {
              "type": "string"
            }
          ],
          "description": "A target value that should be treated as a positive outcome for the prediction."
        },
        "protectedFeatures": {
          "description": "A list of features to mark as protected for bias and fairness measurement.",
          "items": {
            "type": "string"
          },
          "maxItems": 10,
          "minItems": 1,
          "type": "array"
        }
      },
      "required": [
        "fairnessMetricsSet",
        "fairnessThreshold",
        "preferableTargetValue",
        "protectedFeatures"
      ],
      "type": "object"
    },
    "challengerModels": {
      "description": "Challenger models setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether challenger models are enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "featureDrift": {
      "description": "The feature drift setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether feature drift tracking is enabled for this deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "humility": {
      "description": "Humility setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether humility rules are enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "predictionIntervals": {
      "description": "The prediction intervals setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether prediction intervals are enabled for this deployment. ",
          "type": "boolean"
        },
        "percentiles": {
          "description": "The percentiles used for this deployment. Currently, we support at most one percentile at a time.",
          "items": {
            "type": "integer"
          },
          "type": "array"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "predictionWarning": {
      "description": "The prediction warning setting for the deployment.",
      "properties": {
        "customBoundaries": {
          "description": "Null if default boundaries for the model are used",
          "properties": {
            "lower": {
              "description": "All predictions less than provided value are considered anomalous.",
              "type": "number"
            },
            "upper": {
              "description": "All predictions greater than provided value are considered anomalous.",
              "type": "number"
            }
          },
          "required": [
            "lower",
            "upper"
          ],
          "type": "object"
        },
        "enabled": {
          "description": "Indicates whether prediction warnings are enabled for this deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "predictionsByForecastDate": {
      "description": "Forecast date setting for the deployment.",
      "properties": {
        "columnName": {
          "description": "The column name in prediction datasets to be used as forecast date",
          "type": [
            "string",
            "null"
          ]
        },
        "datetimeFormat": {
          "description": "The datetime format of the forecast date column in prediction datasets.\nFor time series deployments using the datetime format `%Y-%m-%d %H:%M:%S.%f`,\nDataRobot automatically populates a `v2` in front of the timestamp format.\nDate/time values submitted in prediction data should not include this `v2` prefix.\nOther timestamp formats are not affected.\n",
          "type": [
            "string",
            "null"
          ]
        },
        "enabled": {
          "description": "Indicates whether predictions by forecast dates is enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object",
      "x-versionadded": "v2.35"
    },
    "predictionsDataCollection": {
      "description": "The predictions data collection setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether incoming prediction requests and results should be stored in record-level storage.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "processingLimits": {
      "description": "Processing limits setting for the deployment.",
      "properties": {
        "interval": {
          "description": "A time interval that is applied when calculating processing limits.",
          "enum": [
            "hour",
            "day",
            "week"
          ],
          "type": "string"
        }
      },
      "required": [
        "interval"
      ],
      "type": "object"
    },
    "segmentAnalysis": {
      "description": "The segment analysis setting for the deployment.",
      "properties": {
        "attributes": {
          "description": "The segment attributes to be tracked. Note that only categorical columns can be specified as tracked segment attributes. The target column may not be specified",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "enabled": {
          "description": "Indicates whether service health, drift, and accuracy are tracked for segments of prediction data.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "targetDrift": {
      "description": "The target drift setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether target drift tracking is enabled for this deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    }
  },
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| deploymentId | path | string | true | Unique identifier of the deployment. |
| body | body | DeploymentSettingsUpdate | false | none |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 202 | Accepted | Job submitted. See Location header. | None |

### Response Headers

| Status | Header | Type | Format | Description |
| --- | --- | --- | --- | --- |
| 202 | Location | string |  | A url that can be polled to check the status. |

# Schemas

## AccuracyHealth

```
{
  "description": "Accuracy health status setting.",
  "properties": {
    "batchCount": {
      "description": "Number of recent batches used to compute accuracy health status, only applicable to deployments with batch monitoring enabled.",
      "enum": [
        1,
        5,
        10,
        50,
        100,
        1000,
        10000
      ],
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "failingThreshold": {
      "description": "Threshold for failing status.",
      "type": [
        "number",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "measurement": {
      "description": "Measurement for calculating accuracy health status.",
      "enum": [
        "percent",
        "value"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "metric": {
      "description": "Metric used for calculating accuracy health status.",
      "enum": [
        "AUC",
        "Accuracy",
        "Balanced Accuracy",
        "F1",
        "FPR",
        "FVE Binomial",
        "FVE Gamma",
        "FVE Multinomial",
        "FVE Poisson",
        "FVE Tweedie",
        "Gamma Deviance",
        "Gini Norm",
        "Kolmogorov-Smirnov",
        "LogLoss",
        "MAE",
        "MAPE",
        "MCC",
        "NPV",
        "PPV",
        "Poisson Deviance",
        "R Squared",
        "RMSE",
        "RMSLE",
        "Rate@Top10%",
        "Rate@Top5%",
        "TNR",
        "TPR",
        "Tweedie Deviance",
        "WGS84 MAE",
        "WGS84 RMSE"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "warningThreshold": {
      "description": "Threshold for warning status.",
      "type": [
        "number",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

Accuracy health status setting.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| batchCount | integer | false |  | Number of recent batches used to compute accuracy health status, only applicable to deployments with batch monitoring enabled. |
| failingThreshold | number,null | false |  | Threshold for failing status. |
| measurement | string,null | false |  | Measurement for calculating accuracy health status. |
| metric | string,null | false |  | Metric used for calculating accuracy health status. |
| warningThreshold | number,null | false |  | Threshold for warning status. |

### Enumerated Values

| Property | Value |
| --- | --- |
| batchCount | [1, 5, 10, 50, 100, 1000, 10000] |
| measurement | [percent, value] |
| metric | [AUC, Accuracy, Balanced Accuracy, F1, FPR, FVE Binomial, FVE Gamma, FVE Multinomial, FVE Poisson, FVE Tweedie, Gamma Deviance, Gini Norm, Kolmogorov-Smirnov, LogLoss, MAE, MAPE, MCC, NPV, PPV, Poisson Deviance, R Squared, RMSE, RMSLE, Rate@Top10%, Rate@Top5%, TNR, TPR, Tweedie Deviance, WGS84 MAE, WGS84 RMSE] |

## AssociationID

```
{
  "description": "The association ID setting for the deployment.",
  "properties": {
    "columnNames": {
      "description": "List of column names used to represent an association ID.",
      "items": {
        "type": "string"
      },
      "maxItems": 1,
      "minItems": 1,
      "type": "array"
    },
    "requiredInPredictionRequests": {
      "description": "Indicates whether the association ID is required in prediction requests.Note that you may not change an association ID's column names after they have been set and predictions including those columns have been made.",
      "type": "boolean"
    }
  },
  "type": "object"
}
```

The association ID setting for the deployment.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| columnNames | [string] | false | maxItems: 1minItems: 1 | List of column names used to represent an association ID. |
| requiredInPredictionRequests | boolean | false |  | Indicates whether the association ID is required in prediction requests.Note that you may not change an association ID's column names after they have been set and predictions including those columns have been made. |

## AutomaticActuals

```
{
  "description": "Automatic actuals setting for the deployment.",
  "properties": {
    "enabled": {
      "description": "Indicates whether automatic actuals is enabled for the deployment.",
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "type": "object",
  "x-versionadded": "v2.25"
}
```

Automatic actuals setting for the deployment.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| enabled | boolean | true |  | Indicates whether automatic actuals is enabled for the deployment. |

## BiasAndFairness

```
{
  "description": "Bias and fairness setting for the deployment.",
  "properties": {
    "fairnessMetricsSet": {
      "description": "A set of fairness metrics to use for calculating fairness.",
      "enum": [
        "proportionalParity",
        "equalParity",
        "predictionBalance",
        "trueFavorableAndUnfavorableRateParity",
        "favorableAndUnfavorablePredictiveValueParity"
      ],
      "type": "string"
    },
    "fairnessThreshold": {
      "description": "Threshold value of the fairness metric.",
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "preferableTargetValue": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ],
      "description": "A target value that should be treated as a positive outcome for the prediction."
    },
    "protectedFeatures": {
      "description": "A list of features to mark as protected for bias and fairness measurement.",
      "items": {
        "type": "string"
      },
      "maxItems": 10,
      "minItems": 1,
      "type": "array"
    }
  },
  "required": [
    "fairnessMetricsSet",
    "fairnessThreshold",
    "preferableTargetValue",
    "protectedFeatures"
  ],
  "type": "object"
}
```

Bias and fairness setting for the deployment.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| fairnessMetricsSet | string | true |  | A set of fairness metrics to use for calculating fairness. |
| fairnessThreshold | number | true | maximum: 1minimum: 0 | Threshold value of the fairness metric. |
| preferableTargetValue | any | true |  | A target value that should be treated as a positive outcome for the prediction. |

anyOf

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | boolean | false |  | none |

or

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | integer | false |  | none |

or

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | string | false |  | none |

continued

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| protectedFeatures | [string] | true | maxItems: 10minItems: 1 | A list of features to mark as protected for bias and fairness measurement. |

### Enumerated Values

| Property | Value |
| --- | --- |
| fairnessMetricsSet | [proportionalParity, equalParity, predictionBalance, trueFavorableAndUnfavorableRateParity, favorableAndUnfavorablePredictiveValueParity] |

## Challengers

```
{
  "description": "Challenger models setting for the deployment.",
  "properties": {
    "enabled": {
      "description": "Indicates whether challenger models are enabled for the deployment.",
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "type": "object"
}
```

Challenger models setting for the deployment.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| enabled | boolean | true |  | Indicates whether challenger models are enabled for the deployment. |

## CustomBoundaries

```
{
  "description": "Null if default boundaries for the model are used",
  "properties": {
    "lower": {
      "description": "All predictions less than provided value are considered anomalous.",
      "type": "number"
    },
    "upper": {
      "description": "All predictions greater than provided value are considered anomalous.",
      "type": "number"
    }
  },
  "required": [
    "lower",
    "upper"
  ],
  "type": "object"
}
```

Null if default boundaries for the model are used

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| lower | number | true |  | All predictions less than provided value are considered anomalous. |
| upper | number | true |  | All predictions greater than provided value are considered anomalous. |

## CustomMetricCondition

```
{
  "properties": {
    "categoryName": {
      "description": "Category name for the custom metric. Only relevant for categorical metrics.",
      "maxLength": 256,
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.36"
    },
    "compareOperator": {
      "description": "Defines how the custom metric value is compared against the threshold.",
      "enum": [
        "lt",
        "lte",
        "gt",
        "gte"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "metricId": {
      "description": "Custom metric ID.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "threshold": {
      "description": "Threshold value used to determine if the condition is met.",
      "type": "number",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "compareOperator",
    "metricId",
    "threshold"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| categoryName | string,null | false | maxLength: 256 | Category name for the custom metric. Only relevant for categorical metrics. |
| compareOperator | string | true |  | Defines how the custom metric value is compared against the threshold. |
| metricId | string | true |  | Custom metric ID. |
| threshold | number | true |  | Threshold value used to determine if the condition is met. |

### Enumerated Values

| Property | Value |
| --- | --- |
| compareOperator | [lt, lte, gt, gte] |

## CustomMetricsHealth

```
{
  "description": "Custom metrics health status setting.",
  "properties": {
    "failingConditions": {
      "description": "Conditions for failing status.",
      "items": {
        "properties": {
          "categoryName": {
            "description": "Category name for the custom metric. Only relevant for categorical metrics.",
            "maxLength": 256,
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.36"
          },
          "compareOperator": {
            "description": "Defines how the custom metric value is compared against the threshold.",
            "enum": [
              "lt",
              "lte",
              "gt",
              "gte"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "metricId": {
            "description": "Custom metric ID.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "threshold": {
            "description": "Threshold value used to determine if the condition is met.",
            "type": "number",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "compareOperator",
          "metricId",
          "threshold"
        ],
        "type": "object"
      },
      "maxItems": 25,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "warningConditions": {
      "description": "Conditions for warning status.",
      "items": {
        "properties": {
          "categoryName": {
            "description": "Category name for the custom metric. Only relevant for categorical metrics.",
            "maxLength": 256,
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.36"
          },
          "compareOperator": {
            "description": "Defines how the custom metric value is compared against the threshold.",
            "enum": [
              "lt",
              "lte",
              "gt",
              "gte"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "metricId": {
            "description": "Custom metric ID.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "threshold": {
            "description": "Threshold value used to determine if the condition is met.",
            "type": "number",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "compareOperator",
          "metricId",
          "threshold"
        ],
        "type": "object"
      },
      "maxItems": 25,
      "type": "array",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

Custom metrics health status setting.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| failingConditions | [CustomMetricCondition] | false | maxItems: 25 | Conditions for failing status. |
| warningConditions | [CustomMetricCondition] | false | maxItems: 25 | Conditions for warning status. |

## DataDriftHealth

```
{
  "description": "Data drift health status setting.",
  "properties": {
    "batchCount": {
      "description": "Number of recent batches used to compute data drift health status, only applicable to deployments with batch monitoring enabled.",
      "enum": [
        1,
        5,
        10,
        50,
        100,
        1000,
        10000
      ],
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "driftThreshold": {
      "description": "The drift metric threshold above which the feature is considered as drifted.",
      "maximum": 1,
      "minimum": 0,
      "type": "number",
      "x-versionadded": "v2.33"
    },
    "excludedFeatures": {
      "description": "Features that are excluded from data drift status consideration.",
      "items": {
        "maxLength": 256,
        "type": "string"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "highImportanceFailingCount": {
      "description": "Threshold of drifted high importance feature count for failing status.",
      "minimum": 1,
      "type": [
        "integer",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "highImportanceWarningCount": {
      "description": "Threshold of drifted high importance feature count for warning status.",
      "minimum": 1,
      "type": [
        "integer",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "importanceThreshold": {
      "description": "The feature importance threshold above which the feature is considered as important.",
      "maximum": 1,
      "minimum": 0,
      "type": "number",
      "x-versionadded": "v2.33"
    },
    "lowImportanceFailingCount": {
      "description": "Threshold of drifted low importance feature count for failing status.",
      "minimum": 1,
      "type": [
        "integer",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "lowImportanceWarningCount": {
      "description": "Threshold of drifted low importance feature count for warning status.",
      "minimum": 1,
      "type": [
        "integer",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "starredFeatures": {
      "description": "Features that are deemed to be of high importance, regardless of how their feature importance values compare against the threshold.",
      "items": {
        "maxLength": 256,
        "type": "string"
      },
      "maxItems": 100,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "timeInterval": {
      "description": "Time duration used to compute data drift health status, only applicable to deployments with batch monitoring disabled.",
      "enum": [
        "T2H",
        "P1D",
        "P7D",
        "P30D",
        "P90D",
        "P180D",
        "P365D"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

Data drift health status setting.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| batchCount | integer | false |  | Number of recent batches used to compute data drift health status, only applicable to deployments with batch monitoring enabled. |
| driftThreshold | number | false | maximum: 1minimum: 0 | The drift metric threshold above which the feature is considered as drifted. |
| excludedFeatures | [string] | false | maxItems: 100 | Features that are excluded from data drift status consideration. |
| highImportanceFailingCount | integer,null | false | minimum: 1 | Threshold of drifted high importance feature count for failing status. |
| highImportanceWarningCount | integer,null | false | minimum: 1 | Threshold of drifted high importance feature count for warning status. |
| importanceThreshold | number | false | maximum: 1minimum: 0 | The feature importance threshold above which the feature is considered as important. |
| lowImportanceFailingCount | integer,null | false | minimum: 1 | Threshold of drifted low importance feature count for failing status. |
| lowImportanceWarningCount | integer,null | false | minimum: 1 | Threshold of drifted low importance feature count for warning status. |
| starredFeatures | [string] | false | maxItems: 100 | Features that are deemed to be of high importance, regardless of how their feature importance values compare against the threshold. |
| timeInterval | string | false |  | Time duration used to compute data drift health status, only applicable to deployments with batch monitoring disabled. |

### Enumerated Values

| Property | Value |
| --- | --- |
| batchCount | [1, 5, 10, 50, 100, 1000, 10000] |
| timeInterval | [T2H, P1D, P7D, P30D, P90D, P180D, P365D] |

## DatasetsCredential

```
{
  "properties": {
    "catalogVersionId": {
      "description": "ID of the catalog version.",
      "type": "string"
    },
    "credentialId": {
      "description": "ID of the credential store to be used for the given catalog version.",
      "type": "string"
    },
    "url": {
      "description": "The URL of the datasource.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "catalogVersionId",
    "credentialId"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| catalogVersionId | string | true |  | ID of the catalog version. |
| credentialId | string | true |  | ID of the credential store to be used for the given catalog version. |
| url | string,null | false |  | The URL of the datasource. |

## DeploymentSecondaryDataset

```
{
  "properties": {
    "catalogId": {
      "description": "ID of the catalog item.",
      "type": "string"
    },
    "catalogVersionId": {
      "description": "ID of the catalog version.",
      "type": "string"
    },
    "identifier": {
      "description": "Short name of this table (used directly as part of generated feature names).",
      "maxLength": 45,
      "minLength": 1,
      "type": "string"
    },
    "snapshotPolicy": {
      "description": "Policy to use by a dataset while making prediction.",
      "enum": [
        "specified",
        "latest",
        "dynamic"
      ],
      "type": "string"
    }
  },
  "required": [
    "catalogId",
    "catalogVersionId",
    "identifier",
    "snapshotPolicy"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| catalogId | string | true |  | ID of the catalog item. |
| catalogVersionId | string | true |  | ID of the catalog version. |
| identifier | string | true | maxLength: 45minLength: 1minLength: 1 | Short name of this table (used directly as part of generated feature names). |
| snapshotPolicy | string | true |  | Policy to use by a dataset while making prediction. |

### Enumerated Values

| Property | Value |
| --- | --- |
| snapshotPolicy | [specified, latest, dynamic] |

## DeploymentSettingsResponse

```
{
  "properties": {
    "associationId": {
      "description": "The association ID setting for the deployment.",
      "properties": {
        "columnNames": {
          "description": "List of column names used to represent an association ID.",
          "items": {
            "type": "string"
          },
          "maxItems": 1,
          "minItems": 1,
          "type": "array"
        },
        "requiredInPredictionRequests": {
          "description": "Indicates whether the association ID is required in prediction requests.Note that you may not change an association ID's column names after they have been set and predictions including those columns have been made.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "automaticActuals": {
      "description": "Automatic actuals setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether automatic actuals is enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object",
      "x-versionadded": "v2.25"
    },
    "biasAndFairness": {
      "description": "Bias and fairness setting for the deployment.",
      "properties": {
        "fairnessMetricsSet": {
          "description": "A set of fairness metrics to use for calculating fairness.",
          "enum": [
            "proportionalParity",
            "equalParity",
            "predictionBalance",
            "trueFavorableAndUnfavorableRateParity",
            "favorableAndUnfavorablePredictiveValueParity"
          ],
          "type": "string"
        },
        "fairnessThreshold": {
          "description": "Threshold value of the fairness metric.",
          "maximum": 1,
          "minimum": 0,
          "type": "number"
        },
        "preferableTargetValue": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "integer"
            },
            {
              "type": "string"
            }
          ],
          "description": "A target value that should be treated as a positive outcome for the prediction."
        },
        "protectedFeatures": {
          "description": "A list of features to mark as protected for bias and fairness measurement.",
          "items": {
            "type": "string"
          },
          "maxItems": 10,
          "minItems": 1,
          "type": "array"
        }
      },
      "required": [
        "fairnessMetricsSet",
        "fairnessThreshold",
        "preferableTargetValue",
        "protectedFeatures"
      ],
      "type": "object"
    },
    "challengerModels": {
      "description": "Challenger models setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether challenger models are enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "featureDrift": {
      "description": "The feature drift setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether feature drift tracking is enabled for this deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "humility": {
      "description": "Humility setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether humility rules are enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "predictionIntervals": {
      "description": "The prediction intervals setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether prediction intervals are enabled for this deployment. ",
          "type": "boolean"
        },
        "percentiles": {
          "description": "The percentiles used for this deployment. Currently, we support at most one percentile at a time.",
          "items": {
            "type": "integer"
          },
          "type": "array"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "predictionWarning": {
      "description": "The prediction warning setting for the deployment.",
      "properties": {
        "customBoundaries": {
          "description": "Null if default boundaries for the model are used",
          "properties": {
            "lower": {
              "description": "All predictions less than provided value are considered anomalous.",
              "type": "number"
            },
            "upper": {
              "description": "All predictions greater than provided value are considered anomalous.",
              "type": "number"
            }
          },
          "required": [
            "lower",
            "upper"
          ],
          "type": "object"
        },
        "enabled": {
          "description": "Indicates whether prediction warnings are enabled for this deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "predictionsByForecastDate": {
      "description": "Forecast date setting for the deployment.",
      "properties": {
        "columnName": {
          "description": "The column name in prediction datasets to be used as forecast date",
          "type": [
            "string",
            "null"
          ]
        },
        "datetimeFormat": {
          "description": "The datetime format of the forecast date column in prediction datasets.\nFor time series deployments using the datetime format `%Y-%m-%d %H:%M:%S.%f`,\nDataRobot automatically populates a `v2` in front of the timestamp format.\nDate/time values submitted in prediction data should not include this `v2` prefix.\nOther timestamp formats are not affected.\n",
          "type": [
            "string",
            "null"
          ]
        },
        "enabled": {
          "description": "Indicates whether predictions by forecast dates is enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object",
      "x-versionadded": "v2.35"
    },
    "predictionsDataCollection": {
      "description": "The predictions data collection setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether incoming prediction requests and results should be stored in record-level storage.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "processingLimits": {
      "description": "Processing limits setting for the deployment.",
      "properties": {
        "interval": {
          "description": "A time interval that is applied when calculating processing limits.",
          "enum": [
            "hour",
            "day",
            "week"
          ],
          "type": "string"
        }
      },
      "required": [
        "interval"
      ],
      "type": "object"
    },
    "segmentAnalysis": {
      "description": "The segment analysis setting for the deployment.",
      "properties": {
        "attributes": {
          "description": "The segment attributes to be tracked. Note that only categorical columns can be specified as tracked segment attributes. The target column may not be specified",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "enabled": {
          "description": "Indicates whether service health, drift, and accuracy are tracked for segments of prediction data.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "targetDrift": {
      "description": "The target drift setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether target drift tracking is enabled for this deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    }
  },
  "required": [
    "associationId",
    "featureDrift",
    "predictionIntervals",
    "targetDrift"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| associationId | AssociationID | true |  | The association ID setting for the deployment. |
| automaticActuals | AutomaticActuals | false |  | Automatic actuals setting for the deployment. |
| biasAndFairness | BiasAndFairness | false |  | Bias and fairness setting for the deployment. |
| challengerModels | Challengers | false |  | Challenger models setting for the deployment. |
| featureDrift | FeatureDriftSetting | true |  | The feature drift setting for the deployment. |
| humility | Humility | false |  | Humility setting for the deployment. |
| predictionIntervals | PredictionIntervals | true |  | The prediction intervals setting for the deployment. |
| predictionWarning | PredictionWarning | false |  | The prediction warning setting for the deployment. |
| predictionsByForecastDate | PredictionsByForecastDate | false |  | Forecast date setting for the deployment. |
| predictionsDataCollection | PredictionsDataCollection | false |  | The predictions data collection setting for the deployment. |
| processingLimits | ProcessingLimits | false |  | Processing limits setting for the deployment. |
| segmentAnalysis | SegmentAnalysis | false |  | The segment analysis setting for the deployment. |
| targetDrift | TargetDriftSetting | true |  | The target drift setting for the deployment. |

## DeploymentSettingsUpdate

```
{
  "properties": {
    "associationId": {
      "description": "The association ID setting for the deployment.",
      "properties": {
        "columnNames": {
          "description": "List of column names used to represent an association ID.",
          "items": {
            "type": "string"
          },
          "maxItems": 1,
          "minItems": 1,
          "type": "array"
        },
        "requiredInPredictionRequests": {
          "description": "Indicates whether the association ID is required in prediction requests.Note that you may not change an association ID's column names after they have been set and predictions including those columns have been made.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "automaticActuals": {
      "description": "Automatic actuals setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether automatic actuals is enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object",
      "x-versionadded": "v2.25"
    },
    "biasAndFairness": {
      "description": "Bias and fairness setting for the deployment.",
      "properties": {
        "fairnessMetricsSet": {
          "description": "A set of fairness metrics to use for calculating fairness.",
          "enum": [
            "proportionalParity",
            "equalParity",
            "predictionBalance",
            "trueFavorableAndUnfavorableRateParity",
            "favorableAndUnfavorablePredictiveValueParity"
          ],
          "type": "string"
        },
        "fairnessThreshold": {
          "description": "Threshold value of the fairness metric.",
          "maximum": 1,
          "minimum": 0,
          "type": "number"
        },
        "preferableTargetValue": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "integer"
            },
            {
              "type": "string"
            }
          ],
          "description": "A target value that should be treated as a positive outcome for the prediction."
        },
        "protectedFeatures": {
          "description": "A list of features to mark as protected for bias and fairness measurement.",
          "items": {
            "type": "string"
          },
          "maxItems": 10,
          "minItems": 1,
          "type": "array"
        }
      },
      "required": [
        "fairnessMetricsSet",
        "fairnessThreshold",
        "preferableTargetValue",
        "protectedFeatures"
      ],
      "type": "object"
    },
    "challengerModels": {
      "description": "Challenger models setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether challenger models are enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "featureDrift": {
      "description": "The feature drift setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether feature drift tracking is enabled for this deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "humility": {
      "description": "Humility setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether humility rules are enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "predictionIntervals": {
      "description": "The prediction intervals setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether prediction intervals are enabled for this deployment. ",
          "type": "boolean"
        },
        "percentiles": {
          "description": "The percentiles used for this deployment. Currently, we support at most one percentile at a time.",
          "items": {
            "type": "integer"
          },
          "type": "array"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "predictionWarning": {
      "description": "The prediction warning setting for the deployment.",
      "properties": {
        "customBoundaries": {
          "description": "Null if default boundaries for the model are used",
          "properties": {
            "lower": {
              "description": "All predictions less than provided value are considered anomalous.",
              "type": "number"
            },
            "upper": {
              "description": "All predictions greater than provided value are considered anomalous.",
              "type": "number"
            }
          },
          "required": [
            "lower",
            "upper"
          ],
          "type": "object"
        },
        "enabled": {
          "description": "Indicates whether prediction warnings are enabled for this deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "predictionsByForecastDate": {
      "description": "Forecast date setting for the deployment.",
      "properties": {
        "columnName": {
          "description": "The column name in prediction datasets to be used as forecast date",
          "type": [
            "string",
            "null"
          ]
        },
        "datetimeFormat": {
          "description": "The datetime format of the forecast date column in prediction datasets.\nFor time series deployments using the datetime format `%Y-%m-%d %H:%M:%S.%f`,\nDataRobot automatically populates a `v2` in front of the timestamp format.\nDate/time values submitted in prediction data should not include this `v2` prefix.\nOther timestamp formats are not affected.\n",
          "type": [
            "string",
            "null"
          ]
        },
        "enabled": {
          "description": "Indicates whether predictions by forecast dates is enabled for the deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object",
      "x-versionadded": "v2.35"
    },
    "predictionsDataCollection": {
      "description": "The predictions data collection setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether incoming prediction requests and results should be stored in record-level storage.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "processingLimits": {
      "description": "Processing limits setting for the deployment.",
      "properties": {
        "interval": {
          "description": "A time interval that is applied when calculating processing limits.",
          "enum": [
            "hour",
            "day",
            "week"
          ],
          "type": "string"
        }
      },
      "required": [
        "interval"
      ],
      "type": "object"
    },
    "segmentAnalysis": {
      "description": "The segment analysis setting for the deployment.",
      "properties": {
        "attributes": {
          "description": "The segment attributes to be tracked. Note that only categorical columns can be specified as tracked segment attributes. The target column may not be specified",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "enabled": {
          "description": "Indicates whether service health, drift, and accuracy are tracked for segments of prediction data.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    },
    "targetDrift": {
      "description": "The target drift setting for the deployment.",
      "properties": {
        "enabled": {
          "description": "Indicates whether target drift tracking is enabled for this deployment.",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "type": "object"
    }
  },
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| associationId | AssociationID | false |  | The association ID setting for the deployment. |
| automaticActuals | AutomaticActuals | false |  | Automatic actuals setting for the deployment. |
| biasAndFairness | BiasAndFairness | false |  | Bias and fairness setting for the deployment. |
| challengerModels | Challengers | false |  | Challenger models setting for the deployment. |
| featureDrift | FeatureDriftSetting | false |  | The feature drift setting for the deployment. |
| humility | Humility | false |  | Humility setting for the deployment. |
| predictionIntervals | PredictionIntervals | false |  | The prediction intervals setting for the deployment. |
| predictionWarning | PredictionWarning | false |  | The prediction warning setting for the deployment. |
| predictionsByForecastDate | PredictionsByForecastDate | false |  | Forecast date setting for the deployment. |
| predictionsDataCollection | PredictionsDataCollection | false |  | The predictions data collection setting for the deployment. |
| processingLimits | ProcessingLimits | false |  | Processing limits setting for the deployment. |
| segmentAnalysis | SegmentAnalysis | false |  | The segment analysis setting for the deployment. |
| targetDrift | TargetDriftSetting | false |  | The target drift setting for the deployment. |

## FairnessHealth

```
{
  "description": "Fairness health status setting. Only available if deployment supports fairness.",
  "properties": {
    "protectedClassFailingCount": {
      "description": "Number of protected class below fairness threshold for failing status.",
      "minimum": 1,
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "protectedClassWarningCount": {
      "description": "Number of protected class below fairness threshold for warning status.",
      "minimum": 1,
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

Fairness health status setting. Only available if deployment supports fairness.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| protectedClassFailingCount | integer | false | minimum: 1 | Number of protected class below fairness threshold for failing status. |
| protectedClassWarningCount | integer | false | minimum: 1 | Number of protected class below fairness threshold for warning status. |

## FeatureDriftSetting

```
{
  "description": "The feature drift setting for the deployment.",
  "properties": {
    "enabled": {
      "description": "Indicates whether feature drift tracking is enabled for this deployment.",
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "type": "object"
}
```

The feature drift setting for the deployment.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| enabled | boolean | true |  | Indicates whether feature drift tracking is enabled for this deployment. |

## HealthSettings

```
{
  "properties": {
    "accuracy": {
      "description": "Accuracy health status setting.",
      "properties": {
        "batchCount": {
          "description": "Number of recent batches used to compute accuracy health status, only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ],
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "failingThreshold": {
          "description": "Threshold for failing status.",
          "type": [
            "number",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "measurement": {
          "description": "Measurement for calculating accuracy health status.",
          "enum": [
            "percent",
            "value"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "metric": {
          "description": "Metric used for calculating accuracy health status.",
          "enum": [
            "AUC",
            "Accuracy",
            "Balanced Accuracy",
            "F1",
            "FPR",
            "FVE Binomial",
            "FVE Gamma",
            "FVE Multinomial",
            "FVE Poisson",
            "FVE Tweedie",
            "Gamma Deviance",
            "Gini Norm",
            "Kolmogorov-Smirnov",
            "LogLoss",
            "MAE",
            "MAPE",
            "MCC",
            "NPV",
            "PPV",
            "Poisson Deviance",
            "R Squared",
            "RMSE",
            "RMSLE",
            "Rate@Top10%",
            "Rate@Top5%",
            "TNR",
            "TPR",
            "Tweedie Deviance",
            "WGS84 MAE",
            "WGS84 RMSE"
          ],
          "type": [
            "string",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "warningThreshold": {
          "description": "Threshold for warning status.",
          "type": [
            "number",
            "null"
          ],
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "actualsTimeliness": {
      "description": "Predictions timeliness health setting.",
      "properties": {
        "enabled": {
          "description": "Indicates if timeliness status is enabled.",
          "type": "boolean",
          "x-versionadded": "v2.33"
        },
        "expectedFrequency": {
          "description": "Expected frequency for receiving data as an ISO 8601 duration string.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "customMetrics": {
      "description": "Custom metrics health status setting.",
      "properties": {
        "failingConditions": {
          "description": "Conditions for failing status.",
          "items": {
            "properties": {
              "categoryName": {
                "description": "Category name for the custom metric. Only relevant for categorical metrics.",
                "maxLength": 256,
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.36"
              },
              "compareOperator": {
                "description": "Defines how the custom metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "metricId": {
                "description": "Custom metric ID.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "compareOperator",
              "metricId",
              "threshold"
            ],
            "type": "object"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "warningConditions": {
          "description": "Conditions for warning status.",
          "items": {
            "properties": {
              "categoryName": {
                "description": "Category name for the custom metric. Only relevant for categorical metrics.",
                "maxLength": 256,
                "type": [
                  "string",
                  "null"
                ],
                "x-versionadded": "v2.36"
              },
              "compareOperator": {
                "description": "Defines how the custom metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "metricId": {
                "description": "Custom metric ID.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "compareOperator",
              "metricId",
              "threshold"
            ],
            "type": "object"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "dataDrift": {
      "description": "Data drift health status setting.",
      "properties": {
        "batchCount": {
          "description": "Number of recent batches used to compute data drift health status, only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ],
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "driftThreshold": {
          "description": "The drift metric threshold above which the feature is considered as drifted.",
          "maximum": 1,
          "minimum": 0,
          "type": "number",
          "x-versionadded": "v2.33"
        },
        "excludedFeatures": {
          "description": "Features that are excluded from data drift status consideration.",
          "items": {
            "maxLength": 256,
            "type": "string"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "highImportanceFailingCount": {
          "description": "Threshold of drifted high importance feature count for failing status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "highImportanceWarningCount": {
          "description": "Threshold of drifted high importance feature count for warning status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "importanceThreshold": {
          "description": "The feature importance threshold above which the feature is considered as important.",
          "maximum": 1,
          "minimum": 0,
          "type": "number",
          "x-versionadded": "v2.33"
        },
        "lowImportanceFailingCount": {
          "description": "Threshold of drifted low importance feature count for failing status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "lowImportanceWarningCount": {
          "description": "Threshold of drifted low importance feature count for warning status.",
          "minimum": 1,
          "type": [
            "integer",
            "null"
          ],
          "x-versionadded": "v2.33"
        },
        "starredFeatures": {
          "description": "Features that are deemed to be of high importance, regardless of how their feature importance values compare against the threshold.",
          "items": {
            "maxLength": 256,
            "type": "string"
          },
          "maxItems": 100,
          "type": "array",
          "x-versionadded": "v2.33"
        },
        "timeInterval": {
          "description": "Time duration used to compute data drift health status, only applicable to deployments with batch monitoring disabled.",
          "enum": [
            "T2H",
            "P1D",
            "P7D",
            "P30D",
            "P90D",
            "P180D",
            "P365D"
          ],
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "fairness": {
      "description": "Fairness health status setting. Only available if deployment supports fairness.",
      "properties": {
        "protectedClassFailingCount": {
          "description": "Number of protected class below fairness threshold for failing status.",
          "minimum": 1,
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "protectedClassWarningCount": {
          "description": "Number of protected class below fairness threshold for warning status.",
          "minimum": 1,
          "type": "integer",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "predictionsTimeliness": {
      "description": "Predictions timeliness health setting.",
      "properties": {
        "enabled": {
          "description": "Indicates if timeliness status is enabled.",
          "type": "boolean",
          "x-versionadded": "v2.33"
        },
        "expectedFrequency": {
          "description": "Expected frequency for receiving data as an ISO 8601 duration string.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "type": "object"
    },
    "service": {
      "description": "Service health status setting.",
      "properties": {
        "batchCount": {
          "description": "Number of recent batches used to compute the service health status. Only applicable to deployments with batch monitoring enabled.",
          "enum": [
            1,
            5,
            10,
            50,
            100,
            1000,
            10000
          ],
          "type": "integer",
          "x-versionadded": "v2.33"
        },
        "failingConditions": {
          "description": "Conditions for \"failing\" status.",
          "items": {
            "properties": {
              "compareOperator": {
                "description": "Defines how the metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string"
              },
              "metric": {
                "description": "Service health metric to evaluate.",
                "enum": [
                  "dataErrorCount",
                  "serverErrorCount",
                  "dataErrorPercent",
                  "serverErrorPercent",
                  "medianResponseTimeMs",
                  "medianExecutionTimeMs"
                ],
                "type": "string"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number"
              }
            },
            "required": [
              "compareOperator",
              "metric",
              "threshold"
            ],
            "type": "object",
            "x-versionadded": "v2.41"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.41"
        },
        "timeInterval": {
          "description": "Amount of time used to compute service health status. Only applicable to deployments with batch monitoring disabled.",
          "enum": [
            "T1H",
            "T2H",
            "P1D",
            "P7D",
            "P30D",
            "P90D",
            "P180D",
            "P365D"
          ],
          "type": "string",
          "x-versionadded": "v2.41"
        },
        "warningConditions": {
          "description": "Conditions for \"warning\" status.",
          "items": {
            "properties": {
              "compareOperator": {
                "description": "Defines how the metric value is compared against the threshold.",
                "enum": [
                  "lt",
                  "lte",
                  "gt",
                  "gte"
                ],
                "type": "string"
              },
              "metric": {
                "description": "Service health metric to evaluate.",
                "enum": [
                  "dataErrorCount",
                  "serverErrorCount",
                  "dataErrorPercent",
                  "serverErrorPercent",
                  "medianResponseTimeMs",
                  "medianExecutionTimeMs"
                ],
                "type": "string"
              },
              "threshold": {
                "description": "Threshold value used to determine if the condition is met.",
                "type": "number"
              }
            },
            "required": [
              "compareOperator",
              "metric",
              "threshold"
            ],
            "type": "object",
            "x-versionadded": "v2.41"
          },
          "maxItems": 25,
          "type": "array",
          "x-versionadded": "v2.41"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| accuracy | AccuracyHealth | false |  | Accuracy health status setting. |
| actualsTimeliness | TimelinessSettings | false |  | Predictions timeliness health setting. |
| customMetrics | CustomMetricsHealth | false |  | Custom metrics health status setting. |
| dataDrift | DataDriftHealth | false |  | Data drift health status setting. |
| fairness | FairnessHealth | false |  | Fairness health status setting. Only available if deployment supports fairness. |
| predictionsTimeliness | TimelinessSettings | false |  | Predictions timeliness health setting. |
| service | ServiceHealth | false |  | Service health status setting. |

## Humility

```
{
  "description": "Humility setting for the deployment.",
  "properties": {
    "enabled": {
      "description": "Indicates whether humility rules are enabled for the deployment.",
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "type": "object"
}
```

Humility setting for the deployment.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| enabled | boolean | true |  | Indicates whether humility rules are enabled for the deployment. |

## PredictionIntervals

```
{
  "description": "The prediction intervals setting for the deployment.",
  "properties": {
    "enabled": {
      "description": "Indicates whether prediction intervals are enabled for this deployment. ",
      "type": "boolean"
    },
    "percentiles": {
      "description": "The percentiles used for this deployment. Currently, we support at most one percentile at a time.",
      "items": {
        "type": "integer"
      },
      "type": "array"
    }
  },
  "required": [
    "enabled"
  ],
  "type": "object"
}
```

The prediction intervals setting for the deployment.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| enabled | boolean | true |  | Indicates whether prediction intervals are enabled for this deployment. |
| percentiles | [integer] | false |  | The percentiles used for this deployment. Currently, we support at most one percentile at a time. |

## PredictionWarning

```
{
  "description": "The prediction warning setting for the deployment.",
  "properties": {
    "customBoundaries": {
      "description": "Null if default boundaries for the model are used",
      "properties": {
        "lower": {
          "description": "All predictions less than provided value are considered anomalous.",
          "type": "number"
        },
        "upper": {
          "description": "All predictions greater than provided value are considered anomalous.",
          "type": "number"
        }
      },
      "required": [
        "lower",
        "upper"
      ],
      "type": "object"
    },
    "enabled": {
      "description": "Indicates whether prediction warnings are enabled for this deployment.",
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "type": "object"
}
```

The prediction warning setting for the deployment.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| customBoundaries | CustomBoundaries | false |  | Null if default boundaries for the model are used |
| enabled | boolean | true |  | Indicates whether prediction warnings are enabled for this deployment. |

## PredictionsByForecastDate

```
{
  "description": "Forecast date setting for the deployment.",
  "properties": {
    "columnName": {
      "description": "The column name in prediction datasets to be used as forecast date",
      "type": [
        "string",
        "null"
      ]
    },
    "datetimeFormat": {
      "description": "The datetime format of the forecast date column in prediction datasets.\nFor time series deployments using the datetime format `%Y-%m-%d %H:%M:%S.%f`,\nDataRobot automatically populates a `v2` in front of the timestamp format.\nDate/time values submitted in prediction data should not include this `v2` prefix.\nOther timestamp formats are not affected.\n",
      "type": [
        "string",
        "null"
      ]
    },
    "enabled": {
      "description": "Indicates whether predictions by forecast dates is enabled for the deployment.",
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "type": "object",
  "x-versionadded": "v2.35"
}
```

Forecast date setting for the deployment.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| columnName | string,null | false |  | The column name in prediction datasets to be used as forecast date |
| datetimeFormat | string,null | false |  | The datetime format of the forecast date column in prediction datasets.For time series deployments using the datetime format %Y-%m-%d %H:%M:%S.%f,DataRobot automatically populates a v2 in front of the timestamp format.Date/time values submitted in prediction data should not include this v2 prefix.Other timestamp formats are not affected. |
| enabled | boolean | true |  | Indicates whether predictions by forecast dates is enabled for the deployment. |

## PredictionsDataCollection

```
{
  "description": "The predictions data collection setting for the deployment.",
  "properties": {
    "enabled": {
      "description": "Indicates whether incoming prediction requests and results should be stored in record-level storage.",
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "type": "object"
}
```

The predictions data collection setting for the deployment.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| enabled | boolean | true |  | Indicates whether incoming prediction requests and results should be stored in record-level storage. |

## ProcessingLimits

```
{
  "description": "Processing limits setting for the deployment.",
  "properties": {
    "interval": {
      "description": "A time interval that is applied when calculating processing limits.",
      "enum": [
        "hour",
        "day",
        "week"
      ],
      "type": "string"
    }
  },
  "required": [
    "interval"
  ],
  "type": "object"
}
```

Processing limits setting for the deployment.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| interval | string | true |  | A time interval that is applied when calculating processing limits. |

### Enumerated Values

| Property | Value |
| --- | --- |
| interval | [hour, day, week] |

## SecondaryDatasetConfigResponse

```
{
  "properties": {
    "created": {
      "description": "DR-formatted datetime, null for legacy (before DR 6.0) db records.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.24"
    },
    "creatorFullName": {
      "description": "Full name or email of the user who created this config. Null for legacy (before DR 6.0) db records.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.24"
    },
    "creatorUserId": {
      "description": "ID of the user who created this config, null for legacy (before DR 6.0) db records.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.24"
    },
    "credentialIds": {
      "description": "The list of credentials used by the secondary datasets if the datasets used in the configuration are from a datasource.",
      "items": {
        "properties": {
          "catalogVersionId": {
            "description": "ID of the catalog version.",
            "type": "string"
          },
          "credentialId": {
            "description": "ID of the credential store to be used for the given catalog version.",
            "type": "string"
          },
          "url": {
            "description": "The URL of the datasource.",
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "catalogVersionId",
          "credentialId"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "featurelistId": {
      "description": "ID of the feature list.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.24"
    },
    "isDefault": {
      "description": "Whether the secondary datasets config is the default config.",
      "type": "boolean"
    },
    "isDeleted": {
      "description": "Whether the secondary datasets config is soft-deleted.",
      "type": "boolean"
    },
    "name": {
      "description": "Name of the secondary datasets config.",
      "type": [
        "string",
        "null"
      ]
    },
    "projectId": {
      "description": "ID of the project.",
      "type": [
        "string",
        "null"
      ]
    },
    "secondaryDatasetConfigId": {
      "description": "ID of the secondary datasets configuration.",
      "type": "string"
    },
    "secondaryDatasets": {
      "description": "The list of secondary datasets used in the config.",
      "items": {
        "properties": {
          "catalogId": {
            "description": "ID of the catalog item.",
            "type": "string"
          },
          "catalogVersionId": {
            "description": "ID of the catalog version.",
            "type": "string"
          },
          "identifier": {
            "description": "Short name of this table (used directly as part of generated feature names).",
            "maxLength": 45,
            "minLength": 1,
            "type": "string"
          },
          "snapshotPolicy": {
            "description": "Policy to use by a dataset while making prediction.",
            "enum": [
              "specified",
              "latest",
              "dynamic"
            ],
            "type": "string"
          }
        },
        "required": [
          "catalogId",
          "catalogVersionId",
          "identifier",
          "snapshotPolicy"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.24"
    }
  },
  "required": [
    "created",
    "creatorFullName",
    "creatorUserId",
    "featurelistId",
    "isDefault",
    "isDeleted",
    "name",
    "projectId",
    "secondaryDatasetConfigId"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| created | string,null(date-time) | true |  | DR-formatted datetime, null for legacy (before DR 6.0) db records. |
| creatorFullName | string,null | true |  | Full name or email of the user who created this config. Null for legacy (before DR 6.0) db records. |
| creatorUserId | string,null | true |  | ID of the user who created this config, null for legacy (before DR 6.0) db records. |
| credentialIds | [DatasetsCredential] | false |  | The list of credentials used by the secondary datasets if the datasets used in the configuration are from a datasource. |
| featurelistId | string,null | true |  | ID of the feature list. |
| isDefault | boolean | true |  | Whether the secondary datasets config is the default config. |
| isDeleted | boolean | true |  | Whether the secondary datasets config is soft-deleted. |
| name | string,null | true |  | Name of the secondary datasets config. |
| projectId | string,null | true |  | ID of the project. |
| secondaryDatasetConfigId | string | true |  | ID of the secondary datasets configuration. |
| secondaryDatasets | [DeploymentSecondaryDataset] | false |  | The list of secondary datasets used in the config. |

## SecondaryDatasetConfigUpdate

```
{
  "properties": {
    "credentialsIds": {
      "description": "The list of credentials used by the secondary datasets.",
      "items": {
        "properties": {
          "catalogVersionId": {
            "description": "ID of the catalog version.",
            "type": "string"
          },
          "credentialId": {
            "description": "ID of the credential store to be used for the given catalog version.",
            "type": "string"
          },
          "url": {
            "description": "The URL of the datasource.",
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "catalogVersionId",
          "credentialId"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "secondaryDatasetConfigId": {
      "description": "ID of the secondary datasets configuration to be used at the time of prediction.",
      "type": "string"
    }
  },
  "required": [
    "secondaryDatasetConfigId"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| credentialsIds | [DatasetsCredential] | false |  | The list of credentials used by the secondary datasets. |
| secondaryDatasetConfigId | string | true |  | ID of the secondary datasets configuration to be used at the time of prediction. |

## SecondaryDatasetsConfig

```
{
  "properties": {
    "configId": {
      "description": "ID of the secondary datasets configuration.",
      "type": "string"
    },
    "configName": {
      "description": "The name of the secondary datasets config.",
      "type": "string"
    },
    "updated": {
      "description": "Timestamp when configuration was updated on the given deployment.",
      "type": "string"
    },
    "username": {
      "description": "The name of the user who made the update.",
      "type": "string"
    }
  },
  "required": [
    "configId",
    "configName",
    "updated",
    "username"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| configId | string | true |  | ID of the secondary datasets configuration. |
| configName | string | true |  | The name of the secondary datasets config. |
| updated | string | true |  | Timestamp when configuration was updated on the given deployment. |
| username | string | true |  | The name of the user who made the update. |

## SecondaryDatasetsConfigListResponse

```
{
  "properties": {
    "count": {
      "description": "Number of items.",
      "type": "integer"
    },
    "data": {
      "description": "Secondary datasets configuration history.",
      "items": {
        "properties": {
          "configId": {
            "description": "ID of the secondary datasets configuration.",
            "type": "string"
          },
          "configName": {
            "description": "The name of the secondary datasets config.",
            "type": "string"
          },
          "updated": {
            "description": "Timestamp when configuration was updated on the given deployment.",
            "type": "string"
          },
          "username": {
            "description": "The name of the user who made the update.",
            "type": "string"
          }
        },
        "required": [
          "configId",
          "configName",
          "updated",
          "username"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "next": {
      "description": "URL pointing to the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "URL pointing to the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true |  | Number of items. |
| data | [SecondaryDatasetsConfig] | true |  | Secondary datasets configuration history. |
| next | string,null(uri) | true |  | URL pointing to the next page (if null, there is no next page). |
| previous | string,null(uri) | true |  | URL pointing to the previous page (if null, there is no previous page). |

## SegmentAnalysis

```
{
  "description": "The segment analysis setting for the deployment.",
  "properties": {
    "attributes": {
      "description": "The segment attributes to be tracked. Note that only categorical columns can be specified as tracked segment attributes. The target column may not be specified",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "enabled": {
      "description": "Indicates whether service health, drift, and accuracy are tracked for segments of prediction data.",
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "type": "object"
}
```

The segment analysis setting for the deployment.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| attributes | [string] | false |  | The segment attributes to be tracked. Note that only categorical columns can be specified as tracked segment attributes. The target column may not be specified |
| enabled | boolean | true |  | Indicates whether service health, drift, and accuracy are tracked for segments of prediction data. |

## ServiceHealth

```
{
  "description": "Service health status setting.",
  "properties": {
    "batchCount": {
      "description": "Number of recent batches used to compute the service health status. Only applicable to deployments with batch monitoring enabled.",
      "enum": [
        1,
        5,
        10,
        50,
        100,
        1000,
        10000
      ],
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "failingConditions": {
      "description": "Conditions for \"failing\" status.",
      "items": {
        "properties": {
          "compareOperator": {
            "description": "Defines how the metric value is compared against the threshold.",
            "enum": [
              "lt",
              "lte",
              "gt",
              "gte"
            ],
            "type": "string"
          },
          "metric": {
            "description": "Service health metric to evaluate.",
            "enum": [
              "dataErrorCount",
              "serverErrorCount",
              "dataErrorPercent",
              "serverErrorPercent",
              "medianResponseTimeMs",
              "medianExecutionTimeMs"
            ],
            "type": "string"
          },
          "threshold": {
            "description": "Threshold value used to determine if the condition is met.",
            "type": "number"
          }
        },
        "required": [
          "compareOperator",
          "metric",
          "threshold"
        ],
        "type": "object",
        "x-versionadded": "v2.41"
      },
      "maxItems": 25,
      "type": "array",
      "x-versionadded": "v2.41"
    },
    "timeInterval": {
      "description": "Amount of time used to compute service health status. Only applicable to deployments with batch monitoring disabled.",
      "enum": [
        "T1H",
        "T2H",
        "P1D",
        "P7D",
        "P30D",
        "P90D",
        "P180D",
        "P365D"
      ],
      "type": "string",
      "x-versionadded": "v2.41"
    },
    "warningConditions": {
      "description": "Conditions for \"warning\" status.",
      "items": {
        "properties": {
          "compareOperator": {
            "description": "Defines how the metric value is compared against the threshold.",
            "enum": [
              "lt",
              "lte",
              "gt",
              "gte"
            ],
            "type": "string"
          },
          "metric": {
            "description": "Service health metric to evaluate.",
            "enum": [
              "dataErrorCount",
              "serverErrorCount",
              "dataErrorPercent",
              "serverErrorPercent",
              "medianResponseTimeMs",
              "medianExecutionTimeMs"
            ],
            "type": "string"
          },
          "threshold": {
            "description": "Threshold value used to determine if the condition is met.",
            "type": "number"
          }
        },
        "required": [
          "compareOperator",
          "metric",
          "threshold"
        ],
        "type": "object",
        "x-versionadded": "v2.41"
      },
      "maxItems": 25,
      "type": "array",
      "x-versionadded": "v2.41"
    }
  },
  "type": "object"
}
```

Service health status setting.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| batchCount | integer | false |  | Number of recent batches used to compute the service health status. Only applicable to deployments with batch monitoring enabled. |
| failingConditions | [ServiceHealthMetricCondition] | false | maxItems: 25 | Conditions for "failing" status. |
| timeInterval | string | false |  | Amount of time used to compute service health status. Only applicable to deployments with batch monitoring disabled. |
| warningConditions | [ServiceHealthMetricCondition] | false | maxItems: 25 | Conditions for "warning" status. |

### Enumerated Values

| Property | Value |
| --- | --- |
| batchCount | [1, 5, 10, 50, 100, 1000, 10000] |
| timeInterval | [T1H, T2H, P1D, P7D, P30D, P90D, P180D, P365D] |

## ServiceHealthMetricCondition

```
{
  "properties": {
    "compareOperator": {
      "description": "Defines how the metric value is compared against the threshold.",
      "enum": [
        "lt",
        "lte",
        "gt",
        "gte"
      ],
      "type": "string"
    },
    "metric": {
      "description": "Service health metric to evaluate.",
      "enum": [
        "dataErrorCount",
        "serverErrorCount",
        "dataErrorPercent",
        "serverErrorPercent",
        "medianResponseTimeMs",
        "medianExecutionTimeMs"
      ],
      "type": "string"
    },
    "threshold": {
      "description": "Threshold value used to determine if the condition is met.",
      "type": "number"
    }
  },
  "required": [
    "compareOperator",
    "metric",
    "threshold"
  ],
  "type": "object",
  "x-versionadded": "v2.41"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| compareOperator | string | true |  | Defines how the metric value is compared against the threshold. |
| metric | string | true |  | Service health metric to evaluate. |
| threshold | number | true |  | Threshold value used to determine if the condition is met. |

### Enumerated Values

| Property | Value |
| --- | --- |
| compareOperator | [lt, lte, gt, gte] |
| metric | [dataErrorCount, serverErrorCount, dataErrorPercent, serverErrorPercent, medianResponseTimeMs, medianExecutionTimeMs] |

## TargetDriftSetting

```
{
  "description": "The target drift setting for the deployment.",
  "properties": {
    "enabled": {
      "description": "Indicates whether target drift tracking is enabled for this deployment.",
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "type": "object"
}
```

The target drift setting for the deployment.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| enabled | boolean | true |  | Indicates whether target drift tracking is enabled for this deployment. |

## TimelinessSettings

```
{
  "description": "Predictions timeliness health setting.",
  "properties": {
    "enabled": {
      "description": "Indicates if timeliness status is enabled.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "expectedFrequency": {
      "description": "Expected frequency for receiving data as an ISO 8601 duration string.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

Predictions timeliness health setting.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| enabled | boolean | false |  | Indicates if timeliness status is enabled. |
| expectedFrequency | string | false |  | Expected frequency for receiving data as an ISO 8601 duration string. |

---
