Retrieve all DPU Extension Services

View as Markdown

Retrieve all DPU Extension Services for the current Tenant

Org must have a Tenant entity. User must have FORGE_TENANT_ADMIN authorization role.

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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

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 Sites. Input will be matched against name, description and status
includeRelationenumOptional
Related entity to expand
Allowed values:
pageNumberintegerOptional>=1Defaults to 1
Page number for pagination query
pageSizeintegerOptional1-100
Page size for pagination query
orderByenumOptional
Ordering for pagination query

Response headers

X-Paginationstring
Pagination result in JSON format

Response

idstringRead-onlyformat: "uuid"
Unique identifier for the DPU Extension Service
namestring
Name for the DPU Extension Service. Must be unique for a given Tenant
descriptionstring or null
Optional description for the DPU Extension Service
serviceTypeenum
Type of the DPU Extension Service
Allowed values:
siteIdstringformat: "uuid"
ID for the Site the DPU Extension Service belongs to
tenantIdstringformat: "uuid"
ID for the Tenant the DPU Extension Service belongs to
versionstring or null
Latest version of the DPU Extension Service
versionInfoobject
Details for the latest version of the DPU Extension Service
activeVersionslist of strings
Latest and past versions of this DPU Extension Service that have not been deleted and are available for deployment
statusenum
Status of the DPU Extension Service
Allowed values:
statusHistorylist of objects
History of the DPU Extension Service statuses
createddatetimeRead-only

Date/time when the DPU Extension Service was created

updateddatetimeRead-only

Date/time when the DPU Extension Service was last updated

Errors

403
Forbidden Error