PATCH
/
deployments
/
modify-deployment
Modify Deployment
curl --request PATCH \
  --url https://api.enkryptai.com/deployments/modify-deployment \
  --header 'Content-Type: application/json' \
  --header 'X-Enkrypt-Deployment: <x-enkrypt-deployment>' \
  --header 'apikey: <api-key>' \
  --data '{
  "name": "test-deployment",
  "model_saved_name": "Test Model",
  "model_version": "v1",
  "input_guardrails_policy": {
    "policy_name": "test-input",
    "enabled": true,
    "additional_config": {
      "pii_redaction": true
    },
    "block": [
      "topic_detector",
      "nsfw",
      "toxicity",
      "pii",
      "injection_attack",
      "keyword_detector",
      "policy_violation",
      "bias",
      "sponge_attack"
    ]
  },
  "output_guardrails_policy": {
    "policy_name": "test-output",
    "enabled": true,
    "additional_config": {
      "hallucination": false,
      "adherence": false,
      "relevancy": false
    },
    "block": [
      "topic_detector",
      "nsfw",
      "toxicity",
      "pii",
      "injection_attack",
      "keyword_detector",
      "policy_violation",
      "bias",
      "adherence",
      "relevancy"
    ]
  }
}'
{
  "message": "Deployment details updated successfully",
  "data": {
    "name": "test-deployment",
    "model_saved_name": "Test Model",
    "model_version": "v1",
    "input_guardrails_policy": {
      "additional_config": {
        "pii_redaction": true
      },
      "block": [
        "topic_detector",
        "nsfw",
        "toxicity",
        "pii",
        "injection_attack",
        "keyword_detector",
        "policy_violation",
        "bias",
        "sponge_attack"
      ],
      "policy_name": "test-input",
      "enabled": true
    },
    "output_guardrails_policy": {
      "additional_config": {
        "relevancy": false,
        "hallucination": false,
        "adherence": false
      },
      "block": [
        "topic_detector",
        "nsfw",
        "toxicity",
        "pii",
        "injection_attack",
        "keyword_detector",
        "policy_violation",
        "bias",
        "adherence",
        "relevancy"
      ],
      "policy_name": "test-output",
      "enabled": true
    },
    "updated_at": "2024-12-23T04:43:59.005032+00:00",
    "deployment_id": 1234567890,
    "created_at": "2024-12-23T04:43:59.005032+00:00"
  }
}

Authorizations

​
apikey
string
header
required

Headers

​
X-Enkrypt-Deployment
string
required

The deployment saved name. E.g. test-deployment-1

Example:

"test-deployment"

Body

application/json
​
name
string
required

Name of the deployment

Example:

"test-deployment"

​
model_saved_name
string
required

Name of the saved model to use

Example:

"Test Model"

​
model_version
string
required

Version of the model to use

Example:

"v1"

​
input_guardrails_policy
object
required
​
output_guardrails_policy
object
required

Response

200 - application/json

Successful Response

​
message
string
Example:

"Deployment details updated successfully"

​
data
object
Example:
{
  "name": "test-deployment",
  "model_saved_name": "Test Model",
  "model_version": "v1",
  "input_guardrails_policy": {
    "policy_name": "test-input",
    "enabled": true,
    "additional_config": { "pii_redaction": true },
    "block": [
      "topic_detector",
      "nsfw",
      "toxicity",
      "pii",
      "injection_attack",
      "keyword_detector",
      "policy_violation",
      "bias",
      "sponge_attack"
    ]
  },
  "output_guardrails_policy": {
    "policy_name": "test-output",
    "enabled": true,
    "additional_config": {
      "hallucination": false,
      "adherence": false,
      "relevancy": false
    },
    "block": [
      "topic_detector",
      "nsfw",
      "toxicity",
      "pii",
      "injection_attack",
      "keyword_detector",
      "policy_violation",
      "bias",
      "adherence",
      "relevancy"
    ]
  },
  "updated_at": "2024-12-23T04:43:59.005032+00:00",
  "deployment_id": 1234567890,
  "created_at": "2024-12-23T04:43:59.005032+00:00"
}