List policies. [experimental] | NVIDIA Run:ai Documentation

{
  "items": [
    {
      "createdAt": "2024-01-15T09:30:00Z",
      "createdBy": "string",
      "id": "string",
      "scope": "system",
      "updatedAt": "2024-01-15T09:30:00Z",
      "updatedBy": "string",
      "workloadType": {
        "version": "v1",
        "kind": "Deployment",
        "group": "apps"
      },
      "clusterId": "string",
      "departmentId": "string",
      "description": "a short description of the policy",
      "effectiveRules": [
        {
          "field": "containerPort",
          "specSelector": "containerByName",
          "enforcements": [
            {
              "set": {
                "containerPort": 1234,
                "protocol": "TCP"
              }
            }
          ],
          "sourceOfRule": {
            "scope": "project",
            "projectId": 3
          },
          "itemSelector": "string",
          "selectorParams": {
            "containerName": "my-container"
          },
          "allowOverride": true
        }
      ],
      "projectId": "string",
      "rules": [
        {
          "field": "containerPort",
          "specSelector": "containerByName",
          "enforcements": [
            {
              "set": {
                "containerPort": 1234,
                "protocol": "TCP"
              }
            }
          ],
          "itemSelector": "string",
          "selectorParams": {
            "containerName": "my-container"
          },
          "allowOverride": true
        }
      ],
      "status": {
        "phase": "Ready",
        "issues": [
          "configuration-issue-1",
          "configuration-issue-2"
        ]
      }
    }
  ]
}

Retrieve a list of policies with their details, optionally filtered, sorted, and paginated.

Authentication

AuthorizationBearer

Bearer authentication

Query parameters

filterBylist of stringsOptional

Filter results by a parameter. Use the format field-name operator value. Filterable fields are id, type and scope. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contain, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

sortByenumOptional

The field to sort the results by.

offsetintegerOptional

The offset of the first item returned in the collection.

limitintegerOptional1-500Defaults to 50

The maximum number of entries to return.

sortOrderenumOptionalDefaults to asc

Sort results in descending or ascending order.

Allowed values:

Response

The list of matching policies.

itemslist of objects

The policies matching the request, up to a maximum of 1000.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

503

Service Unavailable Error