List Deployments#

List available NIM deployments with optional filtering and pagination.

Prerequisites#

Before you can list NIM deployments, make sure that you have:

To List Deployments#

Choose one of the following options of listing deployments.

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.list(
    page=1,
    page_size=10,
    sort="created_at"
)
print(response)

Make a GET request to the /v1/deployment/model-deployments endpoint.

curl -X GET \
  "${DEPLOYMENT_BASE_URL}/v1/deployment/model-deployments" \
  -H 'accept: application/json' | jq
Example 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)