DELETE
/
customers
/
{DEPLOYMENT_ID}
/
ai
/
deployments
DELETE Deployments
curl --request DELETE \
  --url https:/api.lucidworks.com/customers/{DEPLOYMENT_ID}/ai/deployments \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "id": "<string>",
  "modelId": "<string>",
  "region": "<string>",
  "config": {
    "parameter_1": "<string>",
    "parameter_2": "<string>"
  },
  "minReplicas": 1,
  "maxReplicas": 1,
  "state": "<string>",
  "deployedAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>"
}

Path Parameters

DEPLOYMENT_ID
string
required

Unique identifier generated when the model is deployed.

Body

application/json · deleteDeployments · object

Response

200 - application/json

OK

id
string

The identifier for the custom model. The value is the universally unique identified (UUID) that is the primary key for the model.

modelId
string

The identifier for the custom model being deleted. The value is the universally unique identified (UUID) reference the foreign keys for the model.

region
string

The geographic region specified when the custom model is deployed.

config
object

The configuration parameters for model deployment passed to the workflow as a raw JSON blob. Multiple parameters can be defined and passed.

minReplicas
integer
default:1

The minimum value of Seldon replicas for the model.

Required range: x >= 1
maxReplicas
integer
default:1

The maximum value of Seldon replicas for the model.

Required range: x >= 1
state
string

This field specifies the current status of the custom model. The value is DELETING, DELETED, or DELETE_FAILED.

deployedAt
string<date-time>

The date and time the deployment occurred.

createdBy
string

The user who created the deployment.