Create Configuration#

Create a new deployment configuration for a NIM microservice you want to deploy.

Prerequisites#

Before you can create a NIM deployment configuration, 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.

  • Model details and deployment specifications you want to deploy. To find the models supported by NVIDIA NIM, see Models in the NVIDIA NIM for LLMs documentation.

Options#

You can create a NIM deployment configuration in the following ways.

API#

  1. Submit a POST request to /v1/deployment/configs.

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

    For NVIDIA NGC Models

    curl -X POST \
  "${DEPLOYMENT_SERVICE_URL}/v1/deployment/configs" \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "namespace": "string",
    "description": "string",
    "model": "string",
    "nim_deployment": {
      "image_name": "string",
      "image_tag": "string",
      "gpu": 0,
      "additional_envs": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "namespace": "string"
    },
    "project": "string",
    "custom_fields": {},
    "ownership": {
      "created_by": "",
      "access_policies": {}
    }
  }' | jq

    For External Models such as OpenAI ChatGPT and build.nvidia.com

    curl -X POST \
  "${DEPLOYMENT_SERVICE_URL}/v1/deployment/configs" \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "namespace": "string",
    "description": "string",
    "model": "string",
    "external_endpoint": {
      "host_url": "https://example.com/",
      "api_key": "string",
      "enabled_models": [
        "string"
      ]
    },
    "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:45:33.033Z",
  "updated_at": "2025-05-30T23:45:33.033Z",
  "name": "string",
  "namespace": "string",
  "description": "string",
  "model": "string",
  "nim_deployment": {
    "image_name": "string",
    "image_tag": "string",
    "gpu": 0,
    "additional_envs": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "namespace": "string"
  },
  "external_endpoint": {
    "host_url": "https://example.com/",
    "api_key": "string",
    "enabled_models": [
      "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

    The configuration is created immediately and can be used for deployments right away.

On this page