Sign in
DPU Extension Service

Retrieve all DPU Extension Services

Retrieve all DPU Extension Services for the current Tenant

Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

get/v2/org/{org}/nico/dpu-extension-service

Query parameters

siteIdstring

Filter DPU Extension Services by Site ID

status'Pending' | 'Ready' | 'Error' | 'Deleting'

Status filter for the DPU Extension Services

querystring

Search for matches across all DPU Extension Services. Input will be matched against name, description, and status fields

includeRelation'Site' | 'Tenant'

Related entity to expand

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'NAME_ASC' | 'NAME_DESC' | 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query

Response

idstring uuid

Unique identifier for the DPU Extension Service

namestring

Name for the DPU Extension Service. Must be unique for a given Tenant

descriptionstring nullable

Optional description for the DPU Extension Service

serviceType'KubernetesPod' | 'DpfHelmChart'

Type of the DPU Extension Service

siteIdstring uuid

ID for the Site the DPU Extension Service belongs to

tenantIdstring uuid

ID for the Tenant the DPU Extension Service belongs to

versionstring nullable

Latest version of the DPU Extension Service

activeVersionsstring[]

Latest and past versions of this DPU Extension Service that have not been deleted and are available for deployment

status'Pending' | 'Ready' | 'Error' | 'Updating' | 'Deleting'

Status values for DPU Extension Service objects

createdstring date-time

Date/time when the DPU Extension Service was created

updatedstring date-time

Date/time when the DPU Extension Service was last updated

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "busybox",
    "description": "Single, multi-call executable that contains stripped-down versions of common Unix utilities",
    "serviceType": "KubernetesPod",
    "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "version": "V1-T1761856992374052",
    "versionInfo": {
      "version": "V1-T1761856992374052",
      "data": "apiVersion: apps/v1\\nkind: Deployment\\nmetadata:\\n  name: busybox-deployment\\n  labels:\\n    app: busybox\\nspec:\\n  replicas: 1 # You can adjust the number of desired replicas here\\n  selector:\\n    matchLabels:\\n      app: busybox\\n  template:\\n    metadata:\\n      labels:\\n        app: busybox\\n    spec:\\n      containers:\\n      - name: busybox-container\\n        image: busybox:latest # You can specify a different BusyBox image tag\\n        command: [\"sh\", \"-c\", \"echo \\'BusyBox container running\\' && sleep 3600\"]",
      "hasCredentials": true,
      "created": "2019-08-24T14:15:22Z",
      "observability": {
        "configs": [
          {
            "name": "busybox-metrics",
            "prometheus": {
              "scrapeIntervalSeconds": 30,
              "endpoint": "busybox:9090"
            }
          }
        ]
      }
    },
    "activeVersions": [
      "V1-T1761857134382532",
      "V1-T1761856992374052"
    ],
    "status": "Ready",
    "statusHistory": [
      {
        "status": "Pending",
        "message": "DPU Service Extension is ready for use",
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z"
      },
      {
        "status": "Pending",
        "message": "Request received, pending processing",
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]

Changes

Changed in 3 of the 100 revisions of this API.5

  • d4cff952b75b2See the full diff
    • ●

      added the new DpfHelmChart enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new Updating enum value to the / response property for the response status

      response-property-enum-value-added

  • d26122e47ad72See the full diff
    • ●

      added the new DpfHelmChart enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new Updating enum value to the / response property for the response status

      response-property-enum-value-added

  • c459c6587dee1See the full diff
    • ●

      for the query request parameter pageNumber, the max was set to 21474836.00

      request-parameter-max-set