Skip to navigation
API ReferenceDPU Extension Service

Update DPU Extension Service

View as Markdown

Update a specific DPU Extension Service.

DPU Extension Service must be owned by current Tenant. A new version will be created if data or credentials are modified.

For a DpfHelmChart service, credentials and observability are unsupported, and data is accepted only while the service is Ready and only when it differs from the current definition.

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
dpuExtensionServiceIdstringRequired
ID of the DPU Extension Service

Request

This endpoint expects an object.
namestring or nullOptional
Name for the DPU Extension Service. Must be unique for a given Tenant
descriptionstring or nullOptional
Optional description for the DPU Extension Service
dataobject or string or nullOptional
Replacement deployment spec using the create request's format. Omission or null leaves the existing configuration unchanged.
credentialsobjectOptional

Credentials to download resources specified in DPU Extension Service data; unsupported for DpfHelmChart

observabilityobjectOptional

Observability configuration for the DPU Extension Service version; unsupported for DpfHelmChart

Response

OK
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:
deploymentTypeenumOptionalDefaults to DemandDriven

Immutable deployment policy. Omitted or null on create defaults to DemandDriven, which deploys through instance attachment. Baseline is supported only for DpfHelmChart services and requests deployment to all DPUs managed by DPF at creation, without a DPU target. Baseline services cannot be attached to instances. Empty and unknown values are rejected. Responses always include the stored policy. This field cannot be changed through updates.

Allowed values:
dpuTargetenumOptional

Immutable host-scoped placement for DemandDriven Helm services; null for Baseline Helm and 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

400
Bad Request Error
403
Forbidden Error
404
Not Found Error