Get NIM Deployment Details

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

Prerequisites

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

• The namespace and name of the deployment to retrieve.

To Get Details of a NIM Deployment

Choose one of the following options of getting the details of a NIM deployment.

Python SDK

Create a NeMoMicroservices client instance using the base URL of the NeMo Deployment Management microservice and perform the task as follows.

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.model_deployments.retrieve(
    "your-nim-deployment",
    namespace="your-namespace"
)
print(response)

cURL

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

curl -X GET \
  "${DEPLOYMENT_BASE_URL}/v1/deployment/model-deployments/<namespace>/<deployment_name>" \
  -H 'accept: application/json' | jq

Example Response

{
  "created_at": "2025-05-30T23:54:01.585Z",
  "updated_at": "2025-05-30T23:54:01.585Z",
  "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

The response includes the deployment status and URL that you can use to access the deployed model.