List Configurations#

List available NIM deployment configurations with optional filtering and pagination.

Prerequisites#

Before you can list NIM deployment configurations, make sure that you have:


Options#

You can get the list of NIM deployment configurations in the following ways.

API#

  1. Submit a GET request to /v1/deployment/configs.

    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/configs" \
      -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:00:26.824Z",
          "updated_at": "2025-05-30T23:00:26.824Z",
          "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": {}
          }
        }
      ],
      "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)