Retrieve all DPU Extension Services

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/dpu-extension-service

GET

/v2/org/:org/nico/dpu-extension-service

curl -G https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/dpu-extension-service \
     -H "Authorization: Bearer <token>" \
     -d pageSize=20

[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "serviceType": "KubernetesPod",
    "dpuTarget": "Primary",
    "siteId": "string",
    "tenantId": "string",
    "version": "string",
    "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": [
      "string"
    ],
    "status": "Pending",
    "statusHistory": [
      {
        "status": "string",
        "message": "string",
        "created": "2024-01-15T09:30:00Z",
        "updated": "2024-01-15T09:30:00Z"
      }
    ],
    "created": "2024-01-15T09:30:00Z",
    "updated": "2024-01-15T09:30:00Z"
  }
]

Retrieve all DPU Extension Services for the current Tenant

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

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"

# Example org name: "acme-inc
export ORG_NAME=<org-name>

# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

Path parameters

orgstringRequired

Name of the Org

Query parameters

siteIdstringOptional

Filter DPU Extension Services by Site ID

statusenumOptional

Status filter for the DPU Extension Services

Allowed values:

querystringOptional

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

includeRelationenumOptional

Related entity to expand

Allowed values:

pageNumberintegerOptional1-21474836

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

Response

idstringOptionalRead-onlyformat: "uuid"

Unique identifier for the DPU Extension Service

namestringOptional

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

descriptionstring or nullOptional

Optional description for the DPU Extension Service

serviceTypeenumOptional

Type of the DPU Extension Service

Allowed values:

dpuTargetenumOptional

Immutable DPU placement policy for DpfHelmChart services; null for KubernetesPod services

Allowed values:

siteIdstringOptionalformat: "uuid"

ID for the Site the DPU Extension Service belongs to

tenantIdstringOptionalformat: "uuid"

ID for the Tenant the DPU Extension Service belongs to

versionstring or nullOptional

Latest version of the DPU Extension Service

versionInfoobjectOptional

Details for the latest version of the DPU Extension Service

activeVersionslist of stringsOptional

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

statusenumOptional

Status of the DPU Extension Service

Allowed values:

statusHistorylist of objectsOptional

History of the DPU Extension Service statuses

createddatetimeOptionalRead-only

Date/time when the DPU Extension Service was created

updateddatetimeOptionalRead-only

Date/time when the DPU Extension Service was last updated

Errors

403

Forbidden Error