Update Deployment#

Update an existing NIM deployment by specifying the namespace and the deployment name of the deployment.

Prerequisites#

Before you can update a NIM deployment, make sure that you have:

  • Access to the NeMo Deployment Management service through the NeMo platform host if you have installed the NeMo platform or the independent base URL if you have installed the service individually. Store the base URL in an environment variable DEPLOYMENT_SERVICE_URL.

  • The namespace and name of the deployment to update.

Options#

You can update a NIM deployment in the following ways.

API#

  1. Submit a PATCH request to /v1/deployment/model-deployments/<namespace>/<deployment_name>.

    Use the following cURL command. For more details on the request body, see the Deployment Management API reference.

    curl -X PATCH \
  "${DEPLOYMENT_SERVICE_URL}/v1/deployment/model-deployments/<namespace>/<deployment_name>" \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "models": [
      "string"
    ],
    "async_enabled": false,
    "config": "string",
    "schema_version": "1.0",
    "project": "string",
    "custom_fields": {},
    "ownership": {
      "created_by": "",
      "access_policies": {}
    }
  }' | jq

  2. Review the response.

    Example Response

    The following is an example of a successful response.

    {
  "created_at": "2025-05-30T23:55:48.362Z",
  "updated_at": "2025-05-30T23:55:48.362Z",
  "name": "string",
  "namespace": "string",
  "description": "string",
  "url": "https://example.com/",
  "deployed": false,
  "status_details": {
    "status": "created",
    "description": "string"
  },
  "models": [
    "string"
  ],
  "async_enabled": false,
  "config": "string",
  "schema_version": "1.0",
  "project": "string",
  "custom_fields": {},
  "ownership": {
    "created_by": "",
    "access_policies": {}
  }
}

    For more information about the response of the API, see the Deployment Management API reference.

    Tip

    Only the fields included in the request will be updated. Other fields will remain unchanged.

On this page