List Deployments

List available NIM deployments with optional filtering and pagination.

Prerequisites

Before you can list NIM deployments, 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.

---

Options

You can get the list of NIM deployments in the following ways.

API

1. Submit a GET request to /v1/deployment/model-deployments.

   cURL

   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" \
     -H 'accept: application/json' | jq
   

2. Review the response.

   Example Response

   The following is an example of a successful response.

   {
     "object": "list",
     "data": [
       {
         "created_at": "2025-05-30T23:51:41.010Z",
         "updated_at": "2025-05-30T23:51:41.010Z",
         "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": {}
         }
       }
     ],
     "pagination": {
       "page": 0,
       "page_size": 0,
       "current_page_size": 0,
       "total_pages": 0,
       "total_results": 0
     },
     "sort": "string",
     "filter": {}
   }
   

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

   Tip

   You can use query parameters to filter and sort the results. Available parameters include:

   • page: Page number (default: 1)

   • page_size: Number of items per page (default: 10)

   • sort: Sort field and direction (e.g., created_at:desc)

   • filter: Filter criteria (e.g., namespace=default)