Get Configuration#

Retrieve details of a specific NIM deployment configuration by specifying the namespace and the configuration name of the configuration.

Prerequisites#

Before you can get the details of 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_BASE_URL.

  • The namespace and name of the configuration to retrieve.

To Get a Configuration#

Choose one of the following options of getting a configuration.

from nemo_microservices import NeMoMicroservices

client = NeMoMicroservices(
    base_url=os.environ["DEPLOYMENT_MANAGEMENT_BASE_URL"],
    inference_base_url=os.environ["NIM_PROXY_BASE_URL"]
)

response = client.deployment.configs.retrieve(
    "your-custom-config",
    namespace="your-namespace"
)
print(response)

Make a GET request to the /v1/deployment/configs/<namespace>/<config_name> endpoint. For more details on the request body, see the Deployment Management API reference.

curl -X GET \
  "${DEPLOYMENT_BASE_URL}/v1/deployment/configs/<namespace>/<config_name>" \
  -H 'accept: application/json' | jq
Example Response
{
  "created_at": "2025-05-30T23:47:51.398Z",
  "updated_at": "2025-05-30T23:47:51.398Z",
  "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 response includes all configuration details including model specifications and deployment settings.