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_SERVICE_URL.

  • The namespace and name of the deployment to retrieve.

Options#

You can get the details of a NIM deployment in the following ways.

API#

  1. Submit a GET 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 GET \
  "${DEPLOYMENT_SERVICE_URL}/v1/deployment/model-deployments/<namespace>/<deployment_name>" \
  -H 'accept: application/json' | jq

  2. Review the response.

    Example Response

    The following is an example of a successful 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.

On this page