{ "openapi": "3.1.0", "info": { "title": "HPE GreenLake APIs for Device Management", "description": "With the HPE GreenLake APIs for Device Management you can view, manage, and onboard devices in your workspace. The API allows you to invoke any operation or task that is available through the HPE GreenLake edge-to-cloud platform user interface.", "version": "latest", "license": { "name": "HPE End User License Agreement", "url": "https://www.hpe.com/us/en/software/licensing.html" } }, "servers": [ { "url": "https://global.api.greenlake.hpe.com", "description": "Url hostname" } ], "security": [ { "Bearer": [] } ], "paths": { "/devices/v2beta1/devices/group": { "get": { "tags": [ "Devices - v2beta1" ], "operationId": "groupByDevicesV2beta1", "summary": "Get all devices grouped by given attribute", "description": "Returns devices grouped by the attribute specified in `group-by` (for example: `make`, `model`, or `source`). For date-based grouping fields, you can optionally apply `lower-threshold` and `upper-threshold` to define a date range. The response is paginated and includes each group value with its corresponding device count. Rate limits are enforced on this API. 300 requests per minute is supported per workspace. The API returns `429` if this threshold is breached.", "parameters": [ { "in": "query", "name": "group-by", "description": "The grouping operation supports the following fields:\n`make`, `source`, `category`, `manufacturedDate`, `currentSupportLevelEndDate`, `billingAccountId`, `billingTier`, `deviceType`, `ownership`, `isFlex` and `model`.\n`currentSupportLevelEndDate` groups on `warranty.currentSupportLevel.endDate` and uses that nested date value.\n", "required": true, "schema": { "type": "string" }, "example": "make" }, { "in": "query", "name": "filter", "description": "The filter expressions that are used to narrow down the devices before grouping.\nCombine multiple conditions using `and` or `or`.\nThe following examples are not an exhaustive list of all possible filtering options.\n", "required": false, "schema": { "type": "string" }, "examples": { "Filter by source (single)": { "description": "Filter all managed devices in the workspace", "value": "source eq 'MANAGED'" }, "Filter by source (multiple)": { "description": "Filter devices that are either MANAGED or DISCOVERED", "value": "source eq 'MANAGED' or source eq 'DISCOVERED'" }, "Filter by locationName": { "description": "Filter devices assigned to a specific location", "value": "locationName eq 'San Jose'" }, "Filter by locationName (multiple)": { "description": "Filter devices in either of two locations", "value": "locationName eq 'San Jose' or locationName eq 'Santa Clara'" }, "Combined filter": { "description": "Filter managed devices in a specific location", "value": "source eq 'MANAGED' and locationName eq 'San Jose'" }, "Filter by locationId": { "description": "Filter devices by their location resource ID", "value": "locationId eq 'loc-resource-id-abc123'" } } }, { "in": "query", "name": "lower-threshold", "description": "Lower bound for date-based grouping.

\nApplies only when `group-by` is a date field (`manufacturedDate` or `currentSupportLevelEndDate`).
\nIncludes devices where the grouped date is greater than or equal to this value.
\nUse with `upper-threshold` to group results into four buckets: `less_than_lower`, `lower_to_upper`, `greater_than_upper`, `missing`.
\n", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "2022-01-02T00:00:00Z" }, { "in": "query", "name": "upper-threshold", "description": "Upper bound for date-based grouping.

\nApplies only when `group-by` is a date field (`manufacturedDate` or `currentSupportLevelEndDate`).
\nIncludes devices where the grouped date is less than or equal to this value.
\nUse with `lower-threshold` to group results into four buckets: `less_than_lower`, `lower_to_upper`, `greater_than_upper`, `missing`.
\n", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "2026-01-02T00:00:00Z" }, { "in": "query", "name": "select", "description": "Returns distinct values for the specified field, without counts.
\nUse this as a distinct-only variant of `group-by` (for example, get unique `make` values).
\nValue for select field should be the same as group-by field. For example, if you are grouping by `make`, then `select` should also be `make` to get distinct makes in the response.
\nSupports the same fields as `group-by`.
\n", "required": false, "schema": { "type": "string" }, "example": "model" }, { "in": "query", "name": "offset", "required": false, "description": "Zero-based resource offset to start the response from.", "schema": { "type": "integer", "default": 0, "minimum": 0 }, "example": 10 }, { "in": "query", "name": "limit", "required": false, "description": "Number of entities to return. Maximum of 100.", "schema": { "type": "integer", "minimum": 0, "maximum": 100, "default": 10 }, "example": 20 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "count", "total", "offset" ], "properties": { "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/GroupByResponse" }, { "$ref": "#/components/schemas/GroupByResponseDistinct" } ] } }, "count": { "type": "integer", "example": 1 }, "total": { "type": "integer", "example": 1 }, "offset": { "type": "integer", "example": 0 } } }, "examples": { "groupByMakeExample": { "$ref": "#/components/examples/GroupByMakeExample" }, "groupByIsFlexExample": { "$ref": "#/components/examples/GroupByIsFlexExample" }, "groupBySourceExample": { "$ref": "#/components/examples/GroupBySourceExample" }, "groupByOwnershipExample": { "$ref": "#/components/examples/GroupByOwnershipExample" }, "groupByCategoryExample": { "$ref": "#/components/examples/GroupByCategoryExample" }, "groupByManufacturedDateExample": { "$ref": "#/components/examples/GroupByManufacturedDateExample" }, "groupBySelectMakeExample": { "$ref": "#/components/examples/GroupBySelectMakeExample" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request.", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "query.parameter", "subject": "group-by", "description": "Parameter group-by is missing." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized_request": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Token provided is invalid" } } ] } } } } } }, "403": { "description": "The operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden_request": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unprocessable_request": { "value": { "errorCode": "HPE_GL_UNPROCESSABLE_CONTENT", "message": "Unprocessable Content", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 422, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "content": "Could not process the content." } } ] } } } } } }, "429": { "description": "Too many requests", "headers": { "X-RateLimit-Limit": { "description": "The number of requests allowed in the current time window", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "The number of requests remaining in the current time window", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "The time at which the current rate limit window resets", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_request": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } } }, "/devices/v2beta1/devices/{id}": { "get": { "tags": [ "Devices - v2beta1" ], "summary": "Get device information", "description": "Get details on a specific device by passing its resourceId.

NOTE: You need view permissions for device management to invoke this API.

Rate limits are enforced on this API. 300 requests per minute is supported per workspace. The API returns `429` if this threshold is breached.", "operationId": "getDeviceByIdV2Beta1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "The unique identifier of the device." } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceDetail" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "path.parameter", "subject": "id", "description": "The device ID is not a valid UUID." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "The token provided is invalid." } } ] } } } } } }, "403": { "description": "The operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request.", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "404": { "description": "Device not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_not_found": { "value": { "errorCode": "HPE_GL_DM_DEVICE_ID_NOT_FOUND", "message": "Invalid input provided", "debugId": "cd5e4bfc-5111-41ff-a8ee-ba19a465e026", "httpStatusCode": 404, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.devicemanagement", "metadata": { "id": "ResourceId [00000000-0000-0000-0000-000000000000] not found" } } ] } } } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unprocessable_content": { "value": { "errorCode": "HPE_GL_UNPROCESSABLE_CONTENT", "message": "Unprocessable Content", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 422, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "content": "Could not process the content." } } ] } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_requests": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } } }, "/devices/v2beta1/devices": { "get": { "tags": [ "Devices - v2beta1" ], "summary": "Get all devices in a workspace", "description": "With this API, you can:

NOTE: You need view permissions for Devices and Subscription service to invoke this API.

Rate limits are enforced on this API. 300 requests per minute is supported per workspace. The API returns `429` if this threshold is breached.", "operationId": "getDevicesV2beta1", "parameters": [ { "name": "filter", "in": "query", "description": "Filter expressions consisting of simple comparison operations joined\nby logical operators.
\n| CLASS | EXAMPLES |\n|---------------------|----------------------------------------------------|\n| Types | integer, decimal, timestamp, string, boolean, null |\n| Comparison | eq, ne, gt, ge, lt, le, in |\n| Logical Expressions | and, or, not |\n\nThe following examples are not an exhaustive list of all possible filtering options.\n", "required": false, "schema": { "type": "string" }, "examples": { "equals": { "summary": "Filter with equality check", "description": "Return devices where a property equals a value.\nExample syntax, \\ eq \\.\n", "value": "serialNumber eq 'STIAPL6404'" }, "not": { "summary": "Filter on an inverted query", "description": "Return devices where a property does not equal a value.\nExample syntax, not \\ eq \\.\n", "value": "not serialNumber eq 'STIAPL6404'" }, "ge": { "summary": "Filter with greater or equal check", "description": "Return devices where a property is greater or equal to a value.\nExample syntax, \\ ge \\.\n", "value": "createdAt ge '2024-01-18T19:53:51.480Z'" }, "le": { "summary": "Filter with lesser or equal check", "description": "Return devices where a property is lesser or equal to a value.\nExample syntax, \\ le \\.\n", "value": "updatedAt le '2024-02-18T19:53:51.480Z'" }, "conjunction": { "summary": "Filter on multiple strict conditionals", "description": "Return devices that exactly satisfy multiple filter queries.\nExample syntax, \\ eq \\ and \\ eq \\.\n", "value": "deviceType eq 'STORAGE' and partNumber eq 'RTICXL6413'" }, "disjunction": { "summary": "Filter on multiple non strict conditionals", "description": "Return devices that exactly satisfy one of multiple filter queries.\nExample syntax, \\ eq \\ or \\ eq \\.\n", "value": "serialNumber eq 'STIAPL6404' or partNumber eq 'RTICXL6413'" }, "alternatives": { "summary": "Filter for a value to have one of multiple possibilities", "description": "Return devices where a property is one of multiple values.\nExample syntax, \\ in \\,\\.\n", "value": "deviceType in 'COMPUTE', 'STORAGE'" }, "make": { "summary": "Filter on device make", "description": "Return devices of a specific make.\nExample syntax, make eq \\.\n", "value": "make eq 'HPE'" }, "category": { "summary": "Filter on device category", "description": "Return devices of a specific category.\nExample syntax, category eq \\.\n", "value": "category eq 'NETWORK'" }, "manufacturedDate": { "summary": "Filter example on device manufactured date", "description": "Return devices manufactured on or after specific date.\nExample syntax, manufacturedDate ge \\.\n", "value": "manufacturedDate ge '2022-01-18T19:53:51.480Z'" }, "currentSupportLevelEndDate": { "summary": "Filter example on device current support level end date", "description": "Return devices whose current support level end date is on or before specific date.\nExample syntax, currentSupportLevelEndDate le \\.\n", "value": "currentSupportLevelEndDate le '2024-02-18T19:53:51.480Z'" }, "source": { "summary": "Filter on device source", "description": "Return devices of a specific source.\nExample syntax, source eq \\.\n", "value": "source eq 'MANAGED'" }, "isFlex": { "summary": "Filter on whether device is on a flex subscription", "description": "Return devices that are on a flex subscription or not.\nExample syntax, isFlex eq true|false.\n", "value": "isFlex eq true" }, "billingTier": { "summary": "Filter on device billing tier", "description": "Return devices of a specific billing tier.\nExample syntax, billingTier eq \\.\n", "value": "billingTier eq 'TIER_1'" }, "nullFilter": { "summary": "Filter on null values", "description": "Return devices where a property is null or not null.\nExample syntax, \\ eq null or \\ ne null.\n", "value": "manufacturedDate eq null" }, "managementMsp": { "summary": "Filter on MSP managed devices", "description": "Return devices where management is MSP.\nExample syntax, management eq \\.\n", "value": "management eq 'MSP'" }, "managementTenant": { "summary": "Filter on Tenant managed devices", "description": "Return devices where management is TENANT.\nExample syntax, management eq \\.\n", "value": "management eq 'TENANT'" }, "managementNull": { "summary": "Filter on devices with no management type", "description": "Return devices where management is null (Enterprise Organization).\nExample syntax, management eq null.\n", "value": "management eq null" }, "inUseWorkspaceId": { "summary": "Filter on in-use workspace ID", "description": "Return devices assigned to a specific workspace.\nExample syntax, inUseWorkspaceId eq \\.\n", "value": "inUseWorkspaceId eq '011c7060ea2611f087d652e71933ec87'" }, "managementMspWithInUseWorkspace": { "summary": "Filter MSP devices in a specific workspace (MOI)", "description": "Return MSP managed devices assigned to a specific workspace.\nExample syntax, management eq \\ and inUseWorkspaceId eq \\.\n", "value": "management eq 'MSP' and inUseWorkspaceId eq '131846d43af111f08e4ebe50c5e8c005'" }, "managementMspNoInUseWorkspace": { "summary": "Filter MSP devices not assigned to any workspace", "description": "Return MSP managed devices where inUseWorkspaceId is null.\nExample syntax, management eq \\ and inUseWorkspaceId eq null.\n", "value": "management eq 'MSP' and inUseWorkspaceId eq null" } } }, { "name": "sort", "in": "query", "description": "A comma separated list of sort expressions. A sort expression is a property name optionally followed by a direction indicator `asc` or `desc`. The default is ascending order.", "required": false, "schema": { "type": "string" }, "example": "serialNumber,partNumber desc" }, { "name": "select", "explode": false, "in": "query", "description": "A comma separated list of select properties to display in the response. The default is that all properties are returned.", "required": false, "style": "form", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "example": "serialNumber,macAddress" }, { "name": "limit", "in": "query", "description": "Specifies the number of results to be returned. The default value is 100 and the maximum is 500.", "required": false, "schema": { "maximum": 500, "minimum": 1, "type": "integer", "format": "int64", "default": 100 } }, { "name": "offset", "in": "query", "description": "Specifies the zero-based resource offset to start the response from. The default value is 0.", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesGetResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "query.parameter", "subject": "limit", "description": "Must be a numeric value which is 1 or greater." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Token provided is invalid" } } ] } } } } } }, "403": { "description": "The operation is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unprocessable_content": { "value": { "errorCode": "HPE_GL_UNPROCESSABLE_CONTENT", "message": "Unprocessable Content", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 422, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "content": "Could not process the content." } } ] } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_requests": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } }, "post": { "tags": [ "Devices - v2beta1" ], "summary": "Add devices", "description": "Add one or more devices to a workspace. This API endpoint provides an asynchronous response and returns `202 Accepted` if basic input validations are successful. The location header in the response provides the URI to invoke to fetch the progress of the device addition task. For details about the status fetch URL, refer to the API endpoint [Get progress or status of async operations in devices](#operation/getDevicesAsyncOperationResourceV1).

NOTE: You need create permissions for the Devices and Subscription service to call this API endpoint.

Rate limits are enforced, and 50 requests per minute are supported per workspace. The API endpoint returns `429` if this threshold is breached.", "operationId": "postDevicesV2beta1", "parameters": [ { "name": "dry-run", "in": "query", "description": "The `dry-run` query parameter is used to perform the resource update operation (`POST`, `PUT`, `PATCH`, `DELETE`) and return a response as if the operation had completed, but without actually creating, updating, or deleting the resource. This allows you to test if the request would succeed before making the change. If set to `true`, the request is validated but not executed.", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesPostRequestV2Beta1" }, "examples": { "network": { "summary": "Adding network devices into a workspace", "value": { "serialNumber": "SN12345678", "macAddress": "00:1B:44:11:3A:B7", "deviceType": "NETWORK", "tags": { "environment": "production" }, "location": { "id": "8cd9ad69-a8e5-4529-97ea-804b2c88d123" } } }, "compute": { "summary": "Adding compute devices into a workspace", "value": { "serialNumber": "SN87654321", "partNumber": "PN87654321", "deviceType": "COMPUTE", "tags": { "environment": "staging" }, "location": { "id": "8cd9ad69-a8e5-4529-97ea-804b2c88d456" } } }, "storage": { "summary": "Adding storage devices into a workspace", "value": { "serialNumber": "SN11223344", "partNumber": "PN11223344", "deviceType": "STORAGE", "tags": { "environment": "development" }, "location": { "id": "8cd9ad69-a8e5-4529-97ea-804b2c88d789" } } }, "network_with_location": { "summary": "Add network devices with location information to a workspace", "value": { "serialNumber": "SN12345678", "macAddress": "00:1B:44:11:3A:B7", "deviceType": "NETWORK", "location": { "id": "8cd9ad69-a8e5-4529-97ea-804b2c88d123" } } }, "network_with_contact": { "summary": "Add network devices with workspace contact information to a workspace", "value": { "serialNumber": "SN12345678", "macAddress": "00:1B:44:11:3A:B7", "deviceType": "NETWORK", "tags": { "environment": "production" }, "location": { "id": "8cd9ad69-a8e5-4529-97ea-804b2c88d123" }, "contact": { "type": "WORKSPACE-USER", "workspaceUser": { "id": "8cd9ad69-a8e5-4529-97ea-804b2c88d123" } } } }, "network_without_contact": { "summary": "Adding network devices with a non-workspace contact to a workspace", "value": { "serialNumber": "SN12345678", "macAddress": "00:1B:44:11:3A:B7", "deviceType": "NETWORK", "tags": { "environment": "production" }, "location": { "id": "8cd9ad69-a8e5-4529-97ea-804b2c88d123" }, "contact": { "type": "NON-WORKSPACE-USER", "nonWorkspaceUser": { "email": "non.workspaceuser@gmail.com", "firstName": "John", "lastName": "Doe", "phoneNumber": "+1-555-123-4567" } } } } } } }, "required": true }, "responses": { "202": { "description": "Request accepted", "content": {}, "headers": { "Location": { "$ref": "#/components/headers/LocationHeaderV1" } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "field", "subject": "serialNumber", "description": "serial number is blank." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Token provided is invalid" } } ] } } } } } }, "403": { "description": "The operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unprocessable_content": { "value": { "errorCode": "HPE_GL_UNPROCESSABLE_CONTENT", "message": "Unprocessable Content", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 422, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "content": "Could not process the content." } } ] } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_requests": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } }, "patch": { "tags": [ "Devices - v2beta1" ], "summary": "Update devices", "description": "Update devices by passing one or more device IDs.

The API supports Device operations such as:
API supports updating location and tags for all types of devices, discovered and managed
Supports updating missing warranty information like warranty/currentSupportLevel/endDate, warranty/currentSupportLevel/serviceLevel for discovered devices.

The API supports earlier Device operations such as:
  • Assigning and unassigning devices to and from a service.
  • Adding, updating and removing tags to devices.
  • Archiving and un-archiving the devices.
The API endpoint supports subscription operations of applying and removing subscriptions to and from devices.\n

To remove an application, set the id under application to null and region to null. Set an empty array to the attribute subscription to remove a subscription. For each tag provided in the request body:
  • Tags are created and inserted into the specified devices if the provided tags do not map to null and are not already present.
  • Tags are updated with the provided if the provided tag key is already present in a device, but the provided value differs from the existing value.
  • Tags are removed from devices when a tag key is mapped to a null tag value. The tags are removed from any devices with a matching tag with the same key.
The endpoint only supports either a device or a subscription operation per API call. For example, you cannot assign devices to an application and assign subscriptions to devices in a single API call. You can achieve this with two separate API calls. However, a single API call can perform device operations together; for example, assigning an application and adding tags can be performed.

The archive device operation is incompatible with any other device operation in the same API call. For example, you cannot remove an application and archive a device using the same API call.

This is an asynchronous API endpoint and it returns the 202 Accepted response code and a Location header containing the URI of the asynchronous operation that can be used to track progress. For details about the status fetch URL, refer to the API Get progress or status of async operations in devices.

NOTE: You need edit permissions for the Devices and Subscription service to initiate this API call. Rate limits are enforced, and 40 requests per minute are supported per workspace. The API returns 429 if this threshold is breached.", "operationId": "patchDevicesV2beta1", "parameters": [ { "name": "id", "explode": true, "in": "query", "description": "Array of device resource IDs. Maximum twenty five devices per request.", "required": true, "style": "form", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": "05fc0c47-e517-5709-976e-c0b726977477&id=08a42d07-b144-5602-9a82-7927d6e44616" }, { "name": "dry-run", "in": "query", "description": "The `dry-run` query parameter is used to perform the resource update operation (`POST`, `PUT`, `PATCH`, `DELETE`) and return a response as if the operation had completed, but without actually creating, updating, or deleting the resource. This allows you to test if the request would succeed before making the change. If set to `true`, the request is validated but not executed.", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDevicesRequestV2" }, "examples": { "UpdateLocation": { "$ref": "#/components/examples/UpdateLocation" }, "UpdateTags": { "$ref": "#/components/examples/UpdateTags" }, "UpdateSupportDetails": { "$ref": "#/components/examples/UpdateSupportDetails" }, "UpdateThirdPartyDevice": { "$ref": "#/components/examples/UpdateThirdPartyDevice" }, "CreateNewTags": { "$ref": "#/components/examples/CreateNewTags" }, "UpdateExistingTagsWithNewTagValues": { "$ref": "#/components/examples/UpdateExistingTagsWithNewTagValues" }, "DeleteExistingTags": { "$ref": "#/components/examples/DeleteExistingTags" }, "UpdateAndDeleteExistingTags": { "$ref": "#/components/examples/UpdateAndDeleteExistingTags" }, "CreateNewTagsAndAssignApplication": { "$ref": "#/components/examples/CreateNewTagsAndAssignApplication" }, "UpdateExistingTagsAndUnassignApplication": { "$ref": "#/components/examples/UpdateExistingTagsAndUnassignApplication" }, "AssignApplication": { "$ref": "#/components/examples/AssignApplication" }, "UnassignApplication": { "$ref": "#/components/examples/UnassignApplication" }, "ArchiveDevice": { "$ref": "#/components/examples/ArchiveDevice" }, "UnarchiveDevice": { "$ref": "#/components/examples/UnarchiveDevice" }, "AssignSubscription": { "$ref": "#/components/examples/AssignSubscription" }, "UnassignSubscription": { "$ref": "#/components/examples/UnassignSubscription" }, "AssignLocation": { "$ref": "#/components/examples/AssignLocation" }, "UnassignLocation": { "$ref": "#/components/examples/UnassignLocation" }, "AssignWorkspaceUserContact": { "$ref": "#/components/examples/AssignWorkspaceUserContact" }, "AssignNonWorkspaceUserContact": { "$ref": "#/components/examples/AssignNonWorkspaceUserContact" }, "UnassignUserContact": { "$ref": "#/components/examples/UnassignContact" } } } }, "required": true }, "responses": { "202": { "description": "Request accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/LocationHeaderV1" } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "query.parameter", "subject": "id", "description": "device ID is not a valid UUID." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Token provided is invalid" } } ] } } } } } }, "403": { "description": "The operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unprocessable_content": { "value": { "errorCode": "HPE_GL_UNPROCESSABLE_CONTENT", "message": "Unprocessable Content", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 422, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "content": "Could not process the content." } } ] } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_requests": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } } }, "/devices/v1/devices": { "get": { "tags": [ "Devices - v1" ], "summary": "Get all devices in a workspace", "description": "With this API, you can:
  • Retrieve a list of all devices in a workspace.
  • Filter devices based on conditional expressions.

NOTE: You need view permissions for Devices and Subscription service to invoke this API.

Rate limits are enforced on this API. 160 requests per minute is supported per workspace. The API returns `429` if this threshold is breached.", "operationId": "getDevicesV1", "parameters": [ { "name": "filter", "in": "query", "description": "Filter expressions consisting of simple comparison operations joined\nby logical operators.
\n| CLASS | EXAMPLES |\n|---------------------|----------------------------------------------------|\n| Types | integer, decimal, timestamp, string, boolean, null |\n| Comparison | eq, ne, gt, ge, lt, le, in |\n| Logical Expressions | and, or, not |\n\nThe following examples are not an exhaustive list of all possible filtering options.\n", "required": false, "schema": { "type": "string" }, "examples": { "equals": { "summary": "Filter with equality check", "description": "Return devices where a property equals a value.\nExample syntax, \\ eq \\.\n", "value": "serialNumber eq 'STIAPL6404'" }, "not": { "summary": "Filter on an inverted query", "description": "Return devices where a property does not equal a value.\nExample syntax, not \\ eq \\.\n", "value": "not serialNumber eq 'STIAPL6404'" }, "ge": { "summary": "Filter with greater or equal check", "description": "Return devices where a property is greater or equal to a value.\nExample syntax, \\ ge \\.\n", "value": "createdAt ge ''2024-01-18T19:53:51.480Z''" }, "le": { "summary": "Filter with lesser or equal check", "description": "Return devices where a property is lesser or equal to a value.\nExample syntax, \\ ge \\.\n", "value": "updatedAt le '2024-02-18T19:53:51.480Z'" }, "conjunction": { "summary": "Filter on multiple strict conditionals", "description": "Return devices that exactly satisfy multiple filter queries.\nExample syntax, \\ eq \\ and \\ eq \\.\n", "value": "deviceType eq 'STORAGE' and partNumber eq 'RTICXL6413'" }, "disjunction": { "summary": "Filter on multiple non strict conditionals", "description": "Return devices that exactly satisfy one of multiple filter queries.\nExample syntax, \\ eq \\ or \\ eq \\.\n", "value": "serialNumber eq 'STIAPL6404' or partNumber eq 'RTICXL6413'" }, "alternatives": { "summary": "Filter for a value to have one of multiple possibilities", "description": "Return devices where a property is one of multiple values.\nExample syntax, \\ in \\,\\.\n", "value": "deviceType in 'COMPUTE', 'STORAGE'" }, "make": { "summary": "Filter on device make", "description": "Return devices of a specific make.\nExample syntax, make eq \\.\n", "value": "make eq 'HPE'" }, "category": { "summary": "Filter on device category", "description": "Return devices of a specific category.\nExample syntax, category eq \\.\n", "value": "category eq 'NETWORK'" }, "manufacturedDate": { "summary": "Filter example on device manufactured date", "description": "Return devices manufactured on or after specific date.\nExample syntax, manufacturedDate ge \\.\n", "value": "manufacturedDate ge '2022-01-18T19:53:51.480Z'" }, "currentSupportLevelEndDate": { "summary": "Filter example on device current support level end date", "description": "Return devices whose current support level end date is on or before specific date.\nExample syntax, currentSupportLevelEndDate le \\.\n", "value": "currentSupportLevelEndDate le '2024-02-18T19:53:51.480Z'" }, "source": { "summary": "Filter on device source", "description": "Return devices of a specific source.\nExample syntax, source eq \\.\n", "value": "source eq 'MANAGED'" }, "isFlex": { "summary": "Filter on whether device is on a flex subscription", "description": "Return devices that are on a flex subscription or not.\nExample syntax, isFlex eq true|false.\n", "value": "isFlex eq true" }, "billingTier": { "summary": "Filter on device billing tier", "description": "Return devices of a specific billing tier.\nExample syntax, billingTier eq \\.\n", "value": "billingTier eq 'TIER_1'" }, "nullFilter": { "summary": "Filter on null values", "description": "Return devices where a property is null or not null.\nExample syntax, \\ eq null or \\ ne null.\n", "value": "manufacturedDate eq null" }, "managementMsp": { "summary": "Filter on MSP managed devices", "description": "Return devices where management is MSP.\nExample syntax, management eq \\.\n", "value": "management eq 'MSP'" }, "managementTenant": { "summary": "Filter on Tenant managed devices", "description": "Return devices where management is TENANT.\nExample syntax, management eq \\.\n", "value": "management eq 'TENANT'" }, "managementNull": { "summary": "Filter on devices with no management type", "description": "Return devices where management is null (Enterprise Organization).\nExample syntax, management eq null.\n", "value": "management eq null" }, "inUseWorkspaceId": { "summary": "Filter on in-use workspace ID", "description": "Return devices assigned to a specific workspace.\nExample syntax, inUseWorkspaceId eq \\.\n", "value": "inUseWorkspaceId eq '011c7060ea2611f087d652e71933ec87'" }, "managementMspWithInUseWorkspace": { "summary": "Filter MSP devices in a specific workspace (MOI)", "description": "Return MSP managed devices assigned to a specific workspace.\nExample syntax, management eq \\ and inUseWorkspaceId eq \\.\n", "value": "management eq 'MSP' and inUseWorkspaceId eq '131846d43af111f08e4ebe50c5e8c005'" }, "managementMspNoInUseWorkspace": { "summary": "Filter MSP devices not assigned to any workspace", "description": "Return MSP managed devices where inUseWorkspaceId is null.\nExample syntax, management eq \\ and inUseWorkspaceId eq null.\n", "value": "management eq 'MSP' and inUseWorkspaceId eq null" } } }, { "name": "filter-tags", "in": "query", "description": "Filter expressions consisting of simple comparison operations joined\nby logical operators to be applied on the assigned tags or their\nvalues.
\n| CLASS | EXAMPLES |\n|---------------------|-----------------|\n| Types | string |\n| Comparison | eq, ne, in |\n| Logical Expressions | and, or, not |\n", "required": false, "schema": { "type": "string" }, "examples": { "equals": { "summary": "Filter with equality check", "description": "Return devices where a tag key is equal to a tag value.\nExample syntax, \\ eq \\.\n", "value": "'city' eq 'London'" }, "not": { "summary": "Filter on an inverted query", "description": "Return devices where a tag key does not equal a tag value.\nExample syntax, not \\ eq \\.\n", "value": "not 'city' eq 'Tokyo'" }, "conjunction": { "summary": "Filter on multiple strict conditionals", "description": "Return devices that exactly satisfy multiple filter queries applied to tag keys.\nExample syntax, \\ eq \\ and \\ eq \\.\n", "value": "'city' eq 'London' and 'street' eq 'Piccadilly'" }, "disjunction": { "summary": "Filter on multiple non-strict conditionals", "description": "Return devices that satisfy any of multiple filter queries applied to tag keys.\nExample syntax, \\ eq \\ or \\ eq \\.\n", "value": "'street' eq 'Oxford Street' or 'street' eq 'Piccadilly'" }, "alternatives": { "summary": "Filter for a value to have one of multiple possibilities", "description": "Return devices containing the tag key and at least one of the specified values.\nExample syntax, \\ in \\,\\.\n", "value": "'street' in 'Regent Street', 'Oxford Street', 'Piccadilly'" } } }, { "name": "sort", "in": "query", "description": "A comma separated list of sort expressions. A sort expression is a property name optionally followed by a direction indicator `asc` or `desc`. The default is ascending order.", "required": false, "schema": { "type": "string" }, "example": "serialNumber,macAddress desc" }, { "name": "select", "explode": false, "in": "query", "description": "A comma separated list of select properties to display in the response. The default is that all properties are returned.", "required": false, "style": "form", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "example": "serialNumber,macAddress" }, { "name": "limit", "in": "query", "description": "Specifies the number of results to be returned. The default value is 2000.", "required": false, "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int64", "default": 2000 } }, { "name": "offset", "in": "query", "description": "Specifies the zero-based resource offset to start the response from. The default value is 0.", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesGetResponse" }, "examples": { "devices_workspace_user_response": { "summary": "Devices response with workspace user details", "value": { "items": [ { "id": "64343c3c-3016-4234-baee-765651aa4bb3", "macAddress": "21:01:18:21:12:22", "serialNumber": "AX17PR347J", "partNumber": "BHD31D9J", "type": "devices/device", "deviceType": "ALS", "assignedState": "ASSIGNED_TO_ACTIVATE_CONFIG", "createdAt": "2024-02-13T09:00:22.920Z", "updatedAt": "2024-02-13T19:30:32.920Z", "model": "COMPUTE", "make": "HPE", "category": "COMPUTE", "manufacturedDate": "2024-01-10T00:00:00Z", "ownership": "MANAGED", "source": "MANAGED", "isFlex": true, "archived": false, "application": { "id": "0892c36d-40df-4f26-923b-76b5d213b420", "resourceUri": "/service-catalog/v1beta1/service-managers/0892c36d-40df-4f26-923b-76b5d213b420" }, "region": "us-west", "tags": { "property1": "string", "property2": "string" }, "subscription": { "id": "3292c36d-30ef-4f26-823b-76b5d213b670", "key": "SIEIAASTEST018ID", "tier": "ENHANCED_PROLIANT", "startTime": "2024-02-13T19:30:32.920Z", "endTime": "2024-02-13T19:30:32.920Z", "resourceUri": "/subscriptions/v1beta1/subscriptions/3292c36d-30ef-4f26-823b-76b5d213b670" }, "tenantWorkspaceId": "3292c36d30ef4f26823b76b5d213b670", "location": { "id": "57f2b22e-7923-497b-8120-fd2b94579f13", "city": "New York", "state": "NY", "country": "USA", "latitude": 40.7128, "longitude": -74.006, "postalCode": "10001", "locationName": "Main Office", "streetAddress": "123 Main St", "locationSource": "GPS", "resourceUri": "/locations/v1beta1/locations/57f2b22e-7923-497b-8120-fd2b94579f13" }, "warranty": { "country": "string", "currentSupportLevel": { "serviceLevel": "string", "serviceLevelRank": 0, "contractLevel": "string", "contractLevelRank": 0, "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2026-06-01T00:00:00.000Z" }, "supportLevels": [ { "serviceLevel": "string", "serviceLevelRank": 0, "contractLevel": "string", "contractLevelRank": 0, "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2026-06-01T00:00:00.000Z" } ] }, "billingAccountId": "123456789012", "billingAccountName": "Contoso Billing", "billingTier": "Premium", "contact": { "type": "WORKSPACE-USER", "workspaceUser": { "id": "4a2e4102-5c05-4713-8fc8-4e82f9704e53", "resourceUri": "/identity/v1/users/4a2e4102-5c05-4713-8fc8-4e82f9704e53" } }, "management": "MSP", "inUseWorkspace": { "id": "3292c36d30ef4f26823b76b5d213b670", "resourceUri": "/workspaces/v1/workspaces/3292c36d30ef4f26823b76b5d213b670", "type": "workspaces/workspace" } } ], "count": 1, "offset": 0, "total": 1 } }, "device_non_workspace_user_response": { "summary": "Devices response with non-workspace user details", "value": { "items": [ { "id": "64343c3c-3016-4234-baee-765651aa4bb3", "macAddress": "21:01:18:21:12:22", "serialNumber": "AX17PR347J", "partNumber": "BHD31D9J", "type": "devices/device", "deviceType": "ALS", "assignedState": "ASSIGNED_TO_ACTIVATE_CONFIG", "createdAt": "2024-02-13T09:00:22.920Z", "updatedAt": "2024-02-13T19:30:32.920Z", "model": "COMPUTE", "make": "HPE", "category": "COMPUTE", "manufacturedDate": "2024-01-10T00:00:00Z", "ownership": "MANAGED", "source": "MANAGED", "isFlex": true, "archived": false, "application": { "id": "0892c36d-40df-4f26-923b-76b5d213b420", "resourceUri": "/service-catalog/v1beta1/service-managers/0892c36d-40df-4f26-923b-76b5d213b420" }, "region": "us-west", "tags": { "property1": "string", "property2": "string" }, "subscription": { "id": "3292c36d-30ef-4f26-823b-76b5d213b670", "key": "SIEIAASTEST018ID", "tier": "ENHANCED_PROLIANT", "startTime": "2024-02-13T19:30:32.920Z", "endTime": "2024-02-13T19:30:32.920Z", "resourceUri": "/subscriptions/v1beta1/subscriptions/3292c36d-30ef-4f26-823b-76b5d213b670" }, "tenantWorkspaceId": "3292c36d30ef4f26823b76b5d213b670", "location": { "id": "57f2b22e-7923-497b-8120-fd2b94579f13", "city": "New York", "state": "NY", "country": "USA", "latitude": 40.7128, "longitude": -74.006, "postalCode": "10001", "locationName": "Main Office", "streetAddress": "123 Main St", "locationSource": "GPS", "resourceUri": "/locations/v1beta1/locations/57f2b22e-7923-497b-8120-fd2b94579f13" }, "warranty": { "country": "string", "currentSupportLevel": { "serviceLevel": "string", "serviceLevelRank": 0, "contractLevel": "string", "contractLevelRank": 0, "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2026-06-01T00:00:00.000Z" }, "supportLevels": [ { "serviceLevel": "string", "serviceLevelRank": 0, "contractLevel": "string", "contractLevelRank": 0, "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2026-06-01T00:00:00.000Z" } ] }, "billingAccountId": "123456789012", "billingAccountName": "Contoso Billing", "billingTier": "Premium", "contact": { "type": "NON-WORKSPACE-USER", "nonWorkspaceUser": { "email": "nonworkspace.user@gmail.com", "firstName": "John", "lastName": "Doe", "phoneNumber": "+1-555-123-4567" } }, "management": "MSP", "inUseWorkspace": { "id": "3292c36d30ef4f26823b76b5d213b670", "resourceUri": "/workspaces/v1/workspaces/3292c36d30ef4f26823b76b5d213b670", "type": "workspaces/workspace" } } ], "count": 1, "offset": 0, "total": 1 } }, "device_consolidate_msp_response": { "summary": "Devices response with Consolidated MSP View", "value": { "items": [ { "id": "08788812-4302-5094-932e-5637a22242a8", "macAddress": "00:99:00:99:81:00", "serialNumber": "TEST_BAPI_AP_0080770", "partNumber": "JW242AR", "type": "devices/device", "deviceType": "IAP", "subscriptionCategory": null, "createdAt": "2025-11-18T06:44:48.358Z", "updatedAt": "2026-01-14T04:36:14.679Z", "model": "IAP-225-US", "make": "HPE", "category": "NETWORK", "ownership": "MANAGED", "manufacturedDate": null, "archived": false, "deviceName": null, "secondaryName": null, "application": null, "region": null, "tags": { "test": "abc" }, "location": { "id": "6336ac6a-945d-4143-8c0a-8e5144058989", "resourceUri": "/locations/v1/locations/6336ac6a-945d-4143-8c0a-8e5144058989", "locationName": "location-1", "streetAddress": "Bengaluru", "city": "bengaluru", "state": "karnataka", "country": "India", "postalCode": "560061", "latitude": 13.12662, "longitude": 77.61329, "locationSource": "SDI" }, "subscription": null, "tenantWorkspaceId": null, "warranty": null, "assignedState": "UNASSIGNED", "dedicatedPlatformWorkspace": null, "contact": { "type": "WORKSPACE-USER", "workspaceUser": { "id": "4a2e4102-5c05-4713-8fc8-4e82f9704e53", "resourceUri": "/identity/v1/users/4a2e4102-5c05-4713-8fc8-4e82f9704e53" } }, "billingAccountName": null, "billingTier": null, "billingAccountId": null, "management": "MSP", "inUseWorkspace": null }, { "id": "128760c1-a63f-5b7b-a8be-390355e2713d", "macAddress": "01:02:17:A1:B5:E6", "serialNumber": "ECVTEST1205255", "partNumber": "EGDECONNECTPARTTEST", "type": "devices/device", "deviceType": "SD_WAN_GW", "subscriptionCategory": null, "createdAt": "2025-05-13T14:03:14.298Z", "updatedAt": "2026-01-22T12:31:02.048Z", "model": "EDGE CONNECT VIRTUAL", "make": "HPE", "category": "NETWORK", "ownership": "MANAGED", "manufacturedDate": "2025-01-01T20:14:04.000Z", "archived": false, "deviceName": null, "secondaryName": null, "application": { "id": "df5b41c4-7c35-4158-af63-302042b9911b", "resourceUri": "/service-catalog/v1beta1/service-managers/df5b41c4-7c35-4158-af63-302042b9911b" }, "region": "us-west", "tags": null, "location": { "id": "bb90750f-08ad-4026-a94c-7926ce2a450f", "resourceUri": "/locations/v1/locations/bb90750f-08ad-4026-a94c-7926ce2a450f", "locationName": "test-location", "streetAddress": "Electronic City", "city": "Bengaluru", "state": "Karnataka", "country": "India", "postalCode": "560100", "latitude": 12.84548, "longitude": 77.67239, "locationSource": "SDI" }, "subscription": null, "tenantWorkspaceId": "131846d4-3af1-11f0-8e4e-be50c5e8c005", "warranty": null, "assignedState": "ASSIGNED_TO_SERVICE", "dedicatedPlatformWorkspace": null, "contact": null, "billingAccountName": null, "billingTier": null, "billingAccountId": null, "management": "MSP", "inUseWorkspace": { "id": "131846d43af111f08e4ebe50c5e8c005", "resourceUri": "/workspaces/v1/workspaces/131846d43af111f08e4ebe50c5e8c005", "type": "workspaces/workspace" } }, { "id": "5e121d72-f0f1-5f2e-91b3-c306fdc990f0", "macAddress": "02:19:11:A1:C2:E4", "serialNumber": "ECVT10092000B", "partNumber": "S6M37A", "type": "devices/device", "deviceType": "SD_WAN_GW", "subscriptionCategory": null, "createdAt": "2025-10-29T11:09:33.512Z", "updatedAt": "2026-01-12T09:30:16.229Z", "model": "EC-V", "make": "HPE", "category": "NETWORK", "ownership": "MANAGED", "manufacturedDate": "2025-05-01T20:14:04.000Z", "archived": false, "deviceName": null, "secondaryName": null, "application": { "id": "df5b41c4-7c35-4158-af63-302042b9911b", "resourceUri": "/service-catalog/v1beta1/service-managers/df5b41c4-7c35-4158-af63-302042b9911b" }, "region": "us-west", "tags": { "test": "abc" }, "location": null, "subscription": null, "tenantWorkspaceId": null, "warranty": null, "assignedState": "ASSIGNED_TO_SERVICE", "dedicatedPlatformWorkspace": null, "contact": null, "billingAccountName": null, "billingTier": null, "billingAccountId": null, "management": "TENANT", "inUseWorkspace": { "id": "ea0bd9f26ce811f091f91efe899b8583", "resourceUri": "/workspaces/v1/workspaces/ea0bd9f26ce811f091f91efe899b8583", "type": "workspaces/workspace" } } ], "count": 3, "offset": 0, "total": 3 } }, "device_consolidate_enterprise_org_response": { "summary": "Devices response with Consolidated Enterprise Organization View", "value": { "items": [ { "id": "bde53e90-dc81-5eaf-8b0a-16cee7654670", "macAddress": "02:19:11:A1:E2:E1", "serialNumber": "TEST060120261", "partNumber": "S6M37A", "type": "devices/device", "deviceType": "SD_WAN_GW", "subscriptionCategory": null, "createdAt": "2026-01-06T11:27:52.197Z", "updatedAt": "2026-01-14T08:48:40.468Z", "model": "EC-V", "make": "HPE", "category": "NETWORK", "ownership": "MANAGED", "manufacturedDate": "2025-05-01T20:14:04.000Z", "archived": false, "deviceName": null, "secondaryName": null, "application": null, "region": null, "tags": { "test": "abc" }, "location": { "id": "e4ad2f0f-c725-4852-bac4-62d635ac46f6", "resourceUri": "/locations/v1/locations/e4ad2f0f-c725-4852-bac4-62d635ac46f6", "locationName": "loc-1", "streetAddress": "bengaluru", "city": "bengaluru", "state": "bengaluru", "country": "India", "postalCode": "560061", "latitude": 13.12662, "longitude": 77.61329, "locationSource": "SDI" }, "subscription": null, "tenantWorkspaceId": null, "warranty": null, "assignedState": "UNASSIGNED", "dedicatedPlatformWorkspace": null, "contact": null, "billingAccountName": null, "billingTier": null, "billingAccountId": null, "management": null, "inUseWorkspace": { "id": "011c7060ea2611f087d652e71933ec87", "resourceUri": "/workspaces/v1/workspaces/011c7060ea2611f087d652e71933ec87", "type": "workspaces/workspace" } }, { "id": "c0820a27-295b-5984-84b4-43180c831b15", "macAddress": "02:19:11:A1:E2:E9", "serialNumber": "TEST06012026", "partNumber": "S6M37A", "type": "devices/device", "deviceType": "SD_WAN_GW", "subscriptionCategory": null, "createdAt": "2026-01-06T05:16:43.233Z", "updatedAt": "2026-01-14T08:44:08.403Z", "model": "EC-V", "make": "HPE", "category": "NETWORK", "ownership": "MANAGED", "manufacturedDate": "2025-05-01T20:14:04.000Z", "archived": false, "deviceName": null, "secondaryName": null, "application": null, "region": null, "tags": null, "location": { "id": "eaa45500-b681-48f2-925b-ce1e9aa339ae", "resourceUri": "/locations/v1/locations/eaa45500-b681-48f2-925b-ce1e9aa339ae", "locationName": "loc-1", "streetAddress": "bengaluru", "city": "bengaluru", "state": "bengaluru", "country": "India", "postalCode": "560061", "latitude": 13.12662, "longitude": 77.61329, "locationSource": "SDI" }, "subscription": null, "tenantWorkspaceId": null, "warranty": null, "assignedState": "UNASSIGNED", "dedicatedPlatformWorkspace": null, "contact": null, "billingAccountName": null, "billingTier": null, "billingAccountId": null, "management": null, "inUseWorkspace": { "id": "341f5236db2e11f0b5d246c440094996", "resourceUri": "/workspaces/v1/workspaces/341f5236db2e11f0b5d246c440094996", "type": "workspaces/workspace" } } ], "count": 2, "offset": 0, "total": 2 } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "query.parameter", "subject": "limit", "description": "Must be a numeric value which is 0 or greater." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Token provided is invalid" } } ] } } } } } }, "403": { "description": "The operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unprocessable_content": { "value": { "errorCode": "HPE_GL_UNPROCESSABLE_CONTENT", "message": "Unprocessable Content", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 422, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "content": "Could not process the content." } } ] } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_requests": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } }, "post": { "tags": [ "Devices - v1" ], "summary": "Add devices", "description": "Add one or more devices to a workspace. This API provides an asynchronous response and will always return `202 Accepted` if basic input validations are successful. The location header in the response provides the URI to be invoked for fetching the progress of the device addition task. For details about the status fetch URL, refer to the API [Get progress or status of async operations in devices](#operation/getDevicesAsyncOperationResourceV1).

NOTE: You need edit permissions for the Devices and Subscription service to invoke this API.

Rate limits are enforced on this API. 50 requests per minute is supported per workspace. The API returns `429` if this threshold is breached.", "operationId": "postDevicesV1", "parameters": [ { "name": "dry-run", "in": "query", "description": "The `dry-run` query parameter is used to perform the resource update operation (`POST`, `PUT`, `PATCH`, `DELETE`) and return a response as if the operation had completed, but without actually creating, updating, or deleting the resource. This allows you to test if the request would succeed before making the change. If set to `true`, the request is validated but not executed.", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "Accepts a maximum of five devices per request, combining the count of network, compute, and storage devices.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesPostRequest" } } }, "required": true }, "responses": { "202": { "description": "Request accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/LocationHeaderV1" } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "field", "subject": "serialNumber", "description": "serial number is blank." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Token provided is invalid" } } ] } } } } } }, "403": { "description": "The operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unprocessable_content": { "value": { "errorCode": "HPE_GL_UNPROCESSABLE_CONTENT", "message": "Unprocessable Content", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 422, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "content": "Could not process the content." } } ] } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_requests": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } }, "patch": { "tags": [ "Devices - v1" ], "summary": "Update devices", "description": "Update devices by passing one or more device IDs. The API currently supports:
  • Assigning and unassigning devices to and from a service.
  • Applying and removing subscriptions to and from devices.
To remove an application, set the `id` under `application` to `null` and 'region' to `null`. Set an empty array to the attribute `subscription` to remove a subscription.

Only one operation is supported in a single API call. For example, you cannot assign devices to an application and assign subscriptions to devices in a single API invocation. You can achieve this with two API calls.

This API provides an asynchronous response and returns `202 Accepted` if basic input validations are successful. The location header in the response provides the URI to be invoked for fetching the progress of the device update task. For details about the status fetch URL, refer to the API [Get progress or status of async operations in devices](#operation/getDevicesAsyncOperationResourceV1).

NOTE: You need edit permissions for the Devices and Subscription service to invoke this API.

Rate limits are enforced on this API. 40 requests per minute is supported per workspace. The API returns `429` if this threshold is breached.", "operationId": "patchDevicesV1", "parameters": [ { "name": "id", "explode": true, "in": "query", "description": "Array of device resource IDs. Maximum five devices per request.", "required": true, "style": "form", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": "05fc0c47-e517-5709-976e-c0b726977477&id=08a42d07-b144-5602-9a82-7927d6e44616" }, { "name": "dry-run", "in": "query", "description": "The `dry-run` query parameter is used to perform the resource update operation (`POST`, `PUT`, `PATCH`, `DELETE`) and return a response as if the operation had completed, but without actually creating, updating, or deleting the resource. This allows you to test if the request would succeed before making the change. If set to `true`, the request is validated but not executed.", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDevicesRequest" } } }, "required": true }, "responses": { "202": { "description": "Request accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/LocationHeaderV1" } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "query.parameter", "subject": "id", "description": "device ID is not a valid UUID." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Token provided is invalid" } } ] } } } } } }, "403": { "description": "The operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unprocessable_content": { "value": { "errorCode": "HPE_GL_UNPROCESSABLE_CONTENT", "message": "Unprocessable Content", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 422, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "content": "Could not process the content." } } ] } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_requests": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } } }, "/devices/v1/devices/{id}": { "get": { "tags": [ "Devices - v1" ], "summary": "Get device information", "description": "Get details on a specific device by passing its resourceId.

NOTE: You need view permissions for device management to invoke this API.

Rate limits are enforced on this API. 40 requests per minute is supported per workspace. The API returns `429` if this threshold is breached.", "operationId": "getDeviceByIdV1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "The unique identifier of the device." } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceDetail" }, "examples": { "device_workspace_user_response": { "summary": "Device response with workspace user details", "value": { "id": "64343c3c-3016-4234-baee-765651aa4bb3", "macAddress": "21:01:18:21:12:22", "serialNumber": "AX17PR347J", "partNumber": "BHD31D9J", "type": "devices/device", "deviceType": "ALS", "assignedState": "ASSIGNED_TO_ACTIVATE_CONFIG", "createdAt": "2024-02-13T09:00:22.920Z", "updatedAt": "2024-02-13T19:30:32.920Z", "model": "COMPUTE", "make": "HPE", "category": "COMPUTE", "manufacturedDate": "2024-01-10T00:00:00Z", "ownership": "MANAGED", "source": "MANAGED", "isFlex": true, "archived": false, "application": { "id": "0892c36d-40df-4f26-923b-76b5d213b420", "resourceUri": "/service-catalog/v1beta1/service-managers/0892c36d-40df-4f26-923b-76b5d213b420" }, "region": "us-west", "tags": { "property1": "string", "property2": "string" }, "subscription": { "id": "3292c36d-30ef-4f26-823b-76b5d213b670", "key": "SIEIAASTEST018ID", "tier": "ENHANCED_PROLIANT", "startTime": "2024-02-13T19:30:32.920Z", "endTime": "2024-02-13T19:30:32.920Z", "resourceUri": "/subscriptions/v1beta1/subscriptions/3292c36d-30ef-4f26-823b-76b5d213b670" }, "tenantWorkspaceId": "3292c36d30ef4f26823b76b5d213b670", "location": { "id": "57f2b22e-7923-497b-8120-fd2b94579f13", "city": "New York", "state": "NY", "country": "USA", "latitude": 40.7128, "longitude": -74.006, "postalCode": "10001", "locationName": "Main Office", "streetAddress": "123 Main St", "locationSource": "GPS", "resourceUri": "/locations/v1beta1/locations/57f2b22e-7923-497b-8120-fd2b94579f13" }, "warranty": { "country": "string", "currentSupportLevel": { "serviceLevel": "string", "serviceLevelRank": 0, "contractLevel": "string", "contractLevelRank": 0, "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2026-06-01T00:00:00.000Z" }, "supportLevels": [ { "serviceLevel": "string", "serviceLevelRank": 0, "contractLevel": "string", "contractLevelRank": 0, "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2026-06-01T00:00:00.000Z" } ] }, "billingAccountId": "123456789", "billingAccountName": "1235-ABCD", "billingTier": "ENHANCED_PROLIANT", "contact": { "type": "WORKSPACE-USER", "WorkspaceUser": { "id": "4a2e4102-5c05-4713-8fc8-4e82f9704e53", "resourceUri": "/identity/v1/users/4a2e4102-5c05-4713-8fc8-4e82f9704e53" } }, "management": "MSP", "inUseWorkspace": { "id": "3292c36d30ef4f26823b76b5d213b670", "resourceUri": "/workspaces/v1/workspaces/3292c36d30ef4f26823b76b5d213b670", "type": "workspaces/workspace" } } }, "device_non_workspace_response": { "summary": "Device response with non-workspace user details", "value": { "id": "64343c3c-3016-4234-baee-765651aa4bb3", "macAddress": "21:01:18:21:12:22", "serialNumber": "AX17PR347J", "partNumber": "BHD31D9J", "type": "devices/device", "deviceType": "ALS", "assignedState": "ASSIGNED_TO_ACTIVATE_CONFIG", "createdAt": "2024-02-13T09:00:22.920Z", "updatedAt": "2024-02-13T19:30:32.920Z", "model": "COMPUTE", "make": "HPE", "category": "COMPUTE", "manufacturedDate": "2024-01-10T00:00:00Z", "ownership": "MANAGED", "source": "MANAGED", "isFlex": true, "archived": false, "application": { "id": "0892c36d-40df-4f26-923b-76b5d213b420", "resourceUri": "/service-catalog/v1beta1/service-managers/0892c36d-40df-4f26-923b-76b5d213b420" }, "region": "us-west", "tags": { "property1": "string", "property2": "string" }, "subscription": { "id": "3292c36d-30ef-4f26-823b-76b5d213b670", "key": "SIEIAASTEST018ID", "tier": "ENHANCED_PROLIANT", "startTime": "2024-02-13T19:30:32.920Z", "endTime": "2024-02-13T19:30:32.920Z", "resourceUri": "/subscriptions/v1beta1/subscriptions/3292c36d-30ef-4f26-823b-76b5d213b670" }, "tenantWorkspaceId": "3292c36d30ef4f26823b76b5d213b670", "location": { "id": "57f2b22e-7923-497b-8120-fd2b94579f13", "city": "New York", "state": "NY", "country": "USA", "latitude": 40.7128, "longitude": -74.006, "postalCode": "10001", "locationName": "Main Office", "streetAddress": "123 Main St", "locationSource": "GPS", "resourceUri": "/locations/v1beta1/locations/57f2b22e-7923-497b-8120-fd2b94579f13" }, "warranty": { "country": "string", "currentSupportLevel": { "serviceLevel": "string", "serviceLevelRank": 0, "contractLevel": "string", "contractLevelRank": 0, "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2026-06-01T00:00:00.000Z" }, "supportLevels": [ { "serviceLevel": "string", "serviceLevelRank": 0, "contractLevel": "string", "contractLevelRank": 0, "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2026-06-01T00:00:00.000Z" } ] }, "billingAccountId": "123456789", "billingAccountName": "1235-ABCD", "billingTier": "ENHANCED_PROLIANT", "contact": { "type": "NON-WORKSPACE-USER", "nonWorkspaceUser": { "email": "nonworkspace.user@gmail.com", "firstName": "John", "lastName": "Doe", "phoneNumber": "+1-555-123-4567" } }, "management": "MSP", "inUseWorkspace": { "id": "3292c36d30ef4f26823b76b5d213b670", "resourceUri": "/workspaces/v1/workspaces/3292c36d30ef4f26823b76b5d213b670", "type": "workspaces/workspace" } } }, "device_msp_response": { "summary": "Device response for MSP workspace (inUseWorkspace is null)", "value": { "id": "08788812-4302-5094-932e-5637a22242a8", "macAddress": "00:99:00:99:81:00", "serialNumber": "TEST_BAPI_AP_0080770", "partNumber": "JW242AR", "type": "devices/device", "deviceType": "IAP", "subscriptionCategory": null, "createdAt": "2025-11-18T06:44:48.358Z", "updatedAt": "2026-01-14T04:36:14.679Z", "model": "IAP-225-US", "make": "HPE", "category": "NETWORK", "ownership": "MANAGED", "manufacturedDate": null, "archived": false, "deviceName": null, "secondaryName": null, "application": null, "region": null, "tags": { "test": "abc" }, "location": { "id": "6336ac6a-945d-4143-8c0a-8e5144058989", "resourceUri": "/locations/v1/locations/6336ac6a-945d-4143-8c0a-8e5144058989", "locationName": "location-1", "streetAddress": "Bengaluru", "city": "bengaluru", "state": "karnataka", "country": "India", "postalCode": "560061", "latitude": 13.12662, "longitude": 77.61329, "locationSource": "SDI" }, "subscription": null, "tenantWorkspaceId": null, "warranty": null, "assignedState": "UNASSIGNED", "dedicatedPlatformWorkspace": null, "contact": { "type": "WORKSPACE-USER", "workspaceUser": { "id": "4a2e4102-5c05-4713-8fc8-4e82f9704e53", "resourceUri": "/identity/v1/users/4a2e4102-5c05-4713-8fc8-4e82f9704e53" } }, "billingAccountName": null, "billingTier": null, "billingAccountId": null, "management": "MSP", "inUseWorkspace": null } }, "device_moi_response": { "summary": "Device response for MSP-Owned Inventory (MOI) tenant", "value": { "id": "128760c1-a63f-5b7b-a8be-390355e2713d", "macAddress": "01:02:17:A1:B5:E6", "serialNumber": "ECVTEST1205255", "partNumber": "EGDECONNECTPARTTEST", "type": "devices/device", "deviceType": "SD_WAN_GW", "subscriptionCategory": null, "createdAt": "2025-05-13T14:03:14.298Z", "updatedAt": "2026-01-22T12:31:02.048Z", "model": "EDGE CONNECT VIRTUAL", "make": "HPE", "category": "NETWORK", "ownership": "MANAGED", "manufacturedDate": "2025-01-01T20:14:04.000Z", "archived": false, "deviceName": null, "secondaryName": null, "application": { "id": "df5b41c4-7c35-4158-af63-302042b9911b", "resourceUri": "/service-catalog/v1beta1/service-managers/df5b41c4-7c35-4158-af63-302042b9911b" }, "region": "us-west", "tags": null, "location": { "id": "bb90750f-08ad-4026-a94c-7926ce2a450f", "resourceUri": "/locations/v1/locations/bb90750f-08ad-4026-a94c-7926ce2a450f", "locationName": "test-location", "streetAddress": "Electronic City", "city": "Bengaluru", "state": "Karnataka", "country": "India", "postalCode": "560100", "latitude": 12.84548, "longitude": 77.67239, "locationSource": "SDI" }, "subscription": null, "tenantWorkspaceId": "131846d4-3af1-11f0-8e4e-be50c5e8c005", "warranty": null, "assignedState": "ASSIGNED_TO_SERVICE", "dedicatedPlatformWorkspace": null, "contact": null, "billingAccountName": null, "billingTier": null, "billingAccountId": null, "management": "MSP", "inUseWorkspace": { "id": "131846d43af111f08e4ebe50c5e8c005", "resourceUri": "/workspaces/v1/workspaces/131846d43af111f08e4ebe50c5e8c005", "type": "workspaces/workspace" } } }, "device_coi_response": { "summary": "Device response for Customer-Owned Inventory (COI) tenant", "value": { "id": "5e121d72-f0f1-5f2e-91b3-c306fdc990f0", "macAddress": "02:19:11:A1:C2:E4", "serialNumber": "ECVT10092000B", "partNumber": "S6M37A", "type": "devices/device", "deviceType": "SD_WAN_GW", "subscriptionCategory": null, "createdAt": "2025-10-29T11:09:33.512Z", "updatedAt": "2026-01-12T09:30:16.229Z", "model": "EC-V", "make": "HPE", "category": "NETWORK", "ownership": "MANAGED", "manufacturedDate": "2025-05-01T20:14:04.000Z", "archived": false, "deviceName": null, "secondaryName": null, "application": { "id": "df5b41c4-7c35-4158-af63-302042b9911b", "resourceUri": "/service-catalog/v1beta1/service-managers/df5b41c4-7c35-4158-af63-302042b9911b" }, "region": "us-west", "tags": { "test": "abc" }, "location": null, "subscription": null, "tenantWorkspaceId": null, "warranty": null, "assignedState": "ASSIGNED_TO_SERVICE", "dedicatedPlatformWorkspace": null, "contact": null, "billingAccountName": null, "billingTier": null, "billingAccountId": null, "management": "TENANT", "inUseWorkspace": { "id": "ea0bd9f26ce811f091f91efe899b8583", "resourceUri": "/workspaces/v1/workspaces/ea0bd9f26ce811f091f91efe899b8583", "type": "workspaces/workspace" } } }, "device_enterprise_parent_response": { "summary": "Device response for Enterprise Organization parent workspace", "value": { "id": "bde53e90-dc81-5eaf-8b0a-16cee7654670", "macAddress": "02:19:11:A1:E2:E1", "serialNumber": "TEST060120261", "partNumber": "S6M37A", "type": "devices/device", "deviceType": "SD_WAN_GW", "subscriptionCategory": null, "createdAt": "2026-01-06T11:27:52.197Z", "updatedAt": "2026-01-14T08:48:40.468Z", "model": "EC-V", "make": "HPE", "category": "NETWORK", "ownership": "MANAGED", "manufacturedDate": "2025-05-01T20:14:04.000Z", "archived": false, "deviceName": null, "secondaryName": null, "application": null, "region": null, "tags": { "test": "abc" }, "location": { "id": "e4ad2f0f-c725-4852-bac4-62d635ac46f6", "resourceUri": "/locations/v1/locations/e4ad2f0f-c725-4852-bac4-62d635ac46f6", "locationName": "loc-1", "streetAddress": "bengaluru", "city": "bengaluru", "state": "bengaluru", "country": "India", "postalCode": "560061", "latitude": 13.12662, "longitude": 77.61329, "locationSource": "SDI" }, "subscription": null, "tenantWorkspaceId": null, "warranty": null, "assignedState": "UNASSIGNED", "dedicatedPlatformWorkspace": null, "contact": null, "billingAccountName": null, "billingTier": null, "billingAccountId": null, "management": null, "inUseWorkspace": { "id": "011c7060ea2611f087d652e71933ec87", "resourceUri": "/workspaces/v1/workspaces/011c7060ea2611f087d652e71933ec87", "type": "workspaces/workspace" } } }, "device_enterprise_child_response": { "summary": "Device response for Enterprise Organization child workspace", "value": { "id": "c0820a27-295b-5984-84b4-43180c831b15", "macAddress": "02:19:11:A1:E2:E9", "serialNumber": "TEST06012026", "partNumber": "S6M37A", "type": "devices/device", "deviceType": "SD_WAN_GW", "subscriptionCategory": null, "createdAt": "2026-01-06T05:16:43.233Z", "updatedAt": "2026-01-14T08:44:08.403Z", "model": "EC-V", "make": "HPE", "category": "NETWORK", "ownership": "MANAGED", "manufacturedDate": "2025-05-01T20:14:04.000Z", "archived": false, "deviceName": null, "secondaryName": null, "application": null, "region": null, "tags": null, "location": { "id": "eaa45500-b681-48f2-925b-ce1e9aa339ae", "resourceUri": "/locations/v1/locations/eaa45500-b681-48f2-925b-ce1e9aa339ae", "locationName": "loc-1", "streetAddress": "bengaluru", "city": "bengaluru", "state": "bengaluru", "country": "India", "postalCode": "560061", "latitude": 13.12662, "longitude": 77.61329, "locationSource": "SDI" }, "subscription": null, "tenantWorkspaceId": null, "warranty": null, "assignedState": "UNASSIGNED", "dedicatedPlatformWorkspace": null, "contact": null, "billingAccountName": null, "billingTier": null, "billingAccountId": null, "management": null, "inUseWorkspace": { "id": "341f5236db2e11f0b5d246c440094996", "resourceUri": "/workspaces/v1/workspaces/341f5236db2e11f0b5d246c440094996", "type": "workspaces/workspace" } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "query.parameter", "subject": "id", "description": "Device ID is not a valid UUID." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Token provided is invalid" } } ] } } } } } }, "403": { "description": "The operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request.", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "404": { "description": "Device not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_not_found": { "value": { "errorCode": "HPE_GL_DM_DEVICE_ID_NOT_FOUND", "message": "Invalid input provided", "debugId": "05b5ecd8-415b-4312-a18a-ad4c19db06dd", "httpStatusCode": 404, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.devicemanagement", "metadata": { "id": "ResourceId [00000000-0000-0000-0000-000000000000] not found" } } ] } } } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unprocessable_content": { "value": { "errorCode": "HPE_GL_UNPROCESSABLE_CONTENT", "message": "Unprocessable Content", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 422, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "content": "Could not process the content." } } ] } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_requests": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } } }, "/devices/v1/async-operations/{id}": { "get": { "tags": [ "Devices - v1" ], "summary": "Get progress or status of async operations in devices", "description": "The add and update device APIs are asynchronous. Use this API to find the status of the asynchronous add and update operations.

An asynchronous resource tracks the status of an asynchronous operation. An asynchronous resource that has reached a terminal state (`SUCCEEDED`, `FAILED`, `TIMEOUT`) will no longer be accessible 24 hours after reaching the terminal state.

The `TIMEOUT` state indicates that the operation was in an `INITIALIZED` or `RUNNING` state for a period greater than the timeout set. If an asynchronous operation resource coming from an asynchronous request consists of multiple devices, a breakdown of succeeded devices and failed devices, if there are any, will be returned as the response. In this case, the device serial number identifies each device.

NOTE: You need view permissions for the Devices and Subscription service to invoke this API.

Rate limits are enforced on this API. 90 requests per minute is supported per workspace. The API returns `429` if this threshold is breached.", "operationId": "getDevicesAsyncOperationResourceV1", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of an asynchronous API operation.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncOperationResource" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "query.parameter", "subject": "id", "description": "Async ID is not provided." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.unauthorized", "issues": [ { "source": "hpe.greenlake.devicemanagement", "subject": "Unauthorized", "description": "Authentication error - the token was expired." } ] } ] } } } } } }, "403": { "description": "The operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_not_found": { "value": { "errorCode": "HPE_GL_ERROR_NOT_FOUND", "message": "Not Found", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 404, "errorDetails": [ { "type": "hpe.greenlake.not_found", "issues": [ { "source": "hpe.greenlake.devicemanagement", "subject": "Internal Server Error", "description": "Device ID not found" } ] } ] } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_requests": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } } }, "/devices/v1beta1/devices": { "get": { "deprecated": true, "tags": [ "Devices - v1beta1" ], "summary": "Get all devices in a workspace", "description": "With this API, you can:
  • Retrieve a list of all devices in a workspace.
  • Filter devices based on conditional expressions.

NOTE: You need view permissions for Devices and Subscription service to invoke this API.

Rate limits are enforced on this API. 160 requests per minute is supported per workspace. API will result in `429` if this threshold is breached.", "operationId": "getDevices", "parameters": [ { "name": "filter", "in": "query", "description": "Filter expressions consisting of simple comparison operations joined\nby logical operators.
\n| CLASS | EXAMPLES |\n|---------------------|----------------------------------------------------|\n| Types | integer, decimal, timestamp, string, boolean, null |\n| Comparison | eq, ne, gt, ge, lt, le, in |\n| Logical Expressions | and, or, not |\n\nThe following examples are not an exhaustive list of all possible filtering options.\n", "required": false, "schema": { "type": "string" }, "examples": { "equals": { "summary": "Filter with equality check", "description": "Return devices with where a property equals a value.\n\\ eq \\\n", "value": "serialNumber eq 'STIAPL6404'" }, "not": { "summary": "Filter on an inverted query", "description": "Return devices where a property does not equal a value\nnot \\ eq \\\n", "value": "not serialNumber eq 'STIAPL6404'" }, "ge": { "summary": "Filter with greater or equal check", "description": "Return devices with where a property greater or equal a value.\n\\ ge \\\n", "value": "createdAt ge ''2024-01-18T19:53:51.480Z''" }, "le": { "summary": "Filter with lesser or equal check", "description": "Return devices with where a property lesser or equal a value.\n\\ ge \\\n", "value": "updatedAt le '2024-02-18T19:53:51.480Z'" }, "conjunction": { "summary": "Filter on multiple strict conditionals", "description": "Return devices where property is populated and property contains value.\n\\ eq \\ and \\ eq \\\n", "value": "deviceType eq 'STORAGE' and partNumber eq 'RTICXL6413'" }, "disjunction": { "summary": "Filter on multiple non strict conditionals", "description": "Return devices where property is populated and property contains value.\n\\ eq \\ or \\ eq \\\n", "value": "serialNumber eq 'STIAPL6404' or partNumber eq 'RTICXL6413'" }, "alternatives": { "summary": "Filter for a value to have one of multiple possibilities", "description": "Return devices where property is one of multiple values.\n\\ in \\,\\\n", "value": "deviceType in 'COMPUTE', 'STORAGE'" } } }, { "name": "filter-tags", "in": "query", "description": "Filter expressions consisting of simple comparison operations joined\nby logical operators to be applied on the assigned tags or their\nvalues.
\n| CLASS | EXAMPLES |\n|---------------------|-----------------|\n| Types | string |\n| Comparison | eq, ne, in |\n| Logical Expressions | and, or, not |\n", "required": false, "schema": { "type": "string" }, "examples": { "equals": { "summary": "Filter with equality check", "description": "Return devices with where a tag key equal a tag value.\n\\ eq \\\n", "value": "'city' eq 'London'" }, "not": { "summary": "Filter on an inverted query", "description": "Return devices with where a tag key does not equal a tag value.\nnot \\ eq \\\n", "value": "not 'city' eq 'Tokyo'" }, "conjunction": { "summary": "Filter on multiple strict conditionals", "description": "Return devices containing the tag key and the corresponding value.\n\\ eq \\ and \\ eq \\\n", "value": "'city' eq 'London' and 'street' eq 'Piccadilly'" }, "disjunction": { "summary": "Filter on multiple non strict conditionals", "description": "Return devices containing the tag key and the corresponding value.\n\\ eq \\ or \\ eq \\\n", "value": "'street' eq 'Oxford Street' or 'street' eq 'Piccadilly'" }, "alternatives": { "summary": "Filter for a value to have one of multiple possibilities", "description": "Return devices containing the tag key and at least one of the specified values.\n\\ in \\,\\\n", "value": "'street' in 'Regent Street', 'Oxford Street', 'Piccadilly'" } } }, { "name": "sort", "in": "query", "description": "A comma separated list of sort expressions. A sort expression is a property name optionally followed by a direction indicator 'asc' or 'desc'. The default is ascending order.", "required": false, "schema": { "type": "string" }, "example": "serialNumber,macAddress desc" }, { "name": "select", "explode": false, "in": "query", "description": "A comma separated list of select properties to display in the response. The default is that all properties are returned.", "required": false, "style": "form", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "example": "serialNumber,macAddress" }, { "name": "limit", "in": "query", "description": "Specifies the number of results to be returned. The default value is 2000.", "required": false, "schema": { "maximum": 2000, "minimum": 1, "type": "integer", "format": "int64", "default": 2000 } }, { "name": "offset", "in": "query", "description": "Specifies the zero-based resource offset to start the response from. The default value is 0.", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 } } ], "responses": { "200": { "description": "Successful response", "headers": { "Deprecation": { "description": "Wed, 15 Jan 2025 23:59:59 GMT\n", "schema": { "type": "string" } }, "Sunset": { "description": "Tue, 15 Apr 2025 23:59:59 GMT\n", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesGetResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "query.parameter", "subject": "limit", "description": "Must be a numeric value which is 0 or greater." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Token provided is invalid" } } ] } } } } } }, "403": { "description": "The operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unprocessable_content": { "value": { "errorCode": "HPE_GL_UNPROCESSABLE_CONTENT", "message": "Unprocessable Content", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 422, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "content": "Could not process the content." } } ] } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_requests": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } }, "post": { "deprecated": true, "tags": [ "Devices - v1beta1" ], "summary": "Add devices", "description": "Add one or more devices to a workspace. This API provides an asynchronous response and will always return `202 Accepted` if basic input validations are successful. The location header in the response provides the URI to be invoked for fetching the progress of the device addition task. For details about the status fetch URL, refer to the API [Get progress or status of async operations in devices](#operation/getDevicesAsyncOperationResource).

NOTE: You need edit permissions for the Devices and Subscription service to invoke this API.

Rate limits are enforced on this API. 25 requests per minute is supported per workspace. API will result in `429` if this threshold is breached.", "operationId": "postDevices", "requestBody": { "description": "Accepts a maximum of five devices per request, combining the count of network, compute, and storage devices.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesPostRequest" } } }, "required": true }, "responses": { "202": { "description": "Request accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } }, "headers": { "Deprecation": { "description": "Wed, 15 Jan 2025 23:59:59 GMT\n", "schema": { "type": "string" } }, "Sunset": { "description": "Tue, 15 Apr 2025 23:59:59 GMT\n", "schema": { "type": "string" } }, "Location": { "$ref": "#/components/headers/LocationHeader" } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "field", "subject": "serialNumber", "description": "serial number is blank." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Token provided is invalid" } } ] } } } } } }, "403": { "description": "The operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unprocessable_content": { "value": { "errorCode": "HPE_GL_UNPROCESSABLE_CONTENT", "message": "Unprocessable Content", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 422, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "content": "Could not process the content." } } ] } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_requests": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } }, "patch": { "deprecated": true, "tags": [ "Devices - v1beta1" ], "summary": "Update devices", "description": "Update devices by passing one or more device IDs. The API currently supports:
  • Assigning and unassigning devices to and from a service.
  • Applying and removing subscriptions to and from devices.
To remove an application, set the `id` under `application` to `null` and 'region' to `null`. Set an empty array to the attribute `subscription` to remove a subscription.

Only one operation is supported in a single API call. For example, you cannot assign devices to an application and assign subscriptions to devices in a single API invocation. You can achieve this with two API calls.

This API provides an asynchronous response and returns `202 Accepted` if basic input validations are successful. The location header in the response provides the URI to be invoked for fetching the progress of the device update task. For details about the status fetch URL, refer to the API [Get progress or status of async operations in devices](#operation/getDevicesAsyncOperationResource).

NOTE: You need edit permissions for the Devices and Subscription service to invoke this API.

Rate limits are enforced on this API. Five requests per minute is supported per workspace. API will result in `429` if this threshold is breached.", "operationId": "patchDevices", "parameters": [ { "name": "id", "explode": true, "in": "query", "description": "Array of device resource IDs. Maximum five devices per request.", "required": true, "style": "form", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": "05fc0c47-e517-5709-976e-c0b726977477&id=08a42d07-b144-5602-9a82-7927d6e44616" } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDevicesRequest" } } }, "required": true }, "responses": { "202": { "description": "Request accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncResponse" } } }, "headers": { "Deprecation": { "description": "Wed, 15 Jan 2025 23:59:59 GMT\n", "schema": { "type": "string" } }, "Sunset": { "description": "Tue, 15 Apr 2025 23:59:59 GMT\n", "schema": { "type": "string" } }, "Location": { "$ref": "#/components/headers/LocationHeader" } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "query.parameter", "subject": "id", "description": "device ID is not a valid UUID." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Token provided is invalid" } } ] } } } } } }, "403": { "description": "The operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unprocessable_content": { "value": { "errorCode": "HPE_GL_UNPROCESSABLE_CONTENT", "message": "Unprocessable Content", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 422, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "content": "Could not process the content." } } ] } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_requests": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } } }, "/devices/v1beta1/devices/{id}": { "get": { "deprecated": true, "tags": [ "Devices - v1beta1" ], "summary": "Get device information", "description": "Get details on a specific device by passing its resourceId.

NOTE: You need view permissions for device management to invoke this API.

Rate limits are enforced on this API. 40 requests per minute is supported per workspace. API will result in `429` if this threshold is breached.", "operationId": "getDeviceById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "The unique identifier of the device." } } ], "responses": { "200": { "description": "Successful response", "headers": { "Deprecation": { "description": "Wed, 15 Jan 2025 23:59:59 GMT\n", "schema": { "type": "string" } }, "Sunset": { "description": "Tue, 15 Apr 2025 23:59:59 GMT\n", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceDetail" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "query.parameter", "subject": "id", "description": "Device ID is not a valid UUID." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Token provided is invalid" } } ] } } } } } }, "403": { "description": "The operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request.", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unprocessable_content": { "value": { "errorCode": "HPE_GL_UNPROCESSABLE_CONTENT", "message": "Unprocessable Content", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 422, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "content": "Could not process the content." } } ] } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_requests": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } } }, "/devices/v1beta1/async-operations/{id}": { "get": { "deprecated": true, "tags": [ "Devices - v1beta1" ], "summary": "Get progress or status of async operations in devices", "description": "The add and update device APIs are asynchronous. Use this API to find the status of the asynchronous add and update operations.

An asynchronous resource tracks the status of an asynchronous operation. An asynchronous resource that has reached a terminal state (`SUCCEEDED`, `FAILED`, `TIMEOUT`) will no longer be accessible 24 hours after reaching the terminal state.

The `TIMEOUT` state indicates that the operation was in an `INITIALIZED` or `RUNNING` state for a period greater than the timeout set. If an asynchronous operation resource coming from an asynchronous request consists of multiple devices, a breakdown of succeeded devices and failed devices, if there are any, will be returned as the response. In this case, the device serial number identifies each device.

NOTE: You need view permissions for the Devices and Subscription service to invoke this API.

Rate limits are enforced on this API. 90 requests per minute is supported per workspace. API will result in `429` if this threshold is breached.", "operationId": "getDevicesAsyncOperationResource", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of an asynchronous API operation.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful response", "headers": { "Deprecation": { "description": "Wed, 15 Jan 2025 23:59:59 GMT\n", "schema": { "type": "string" } }, "Sunset": { "description": "Tue, 15 Apr 2025 23:59:59 GMT\n", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncOperationResource" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeBadRequestError" }, "examples": { "error_bad_request": { "value": { "errorCode": "HPE_GL_ERROR_BAD_REQUEST", "message": "Bad Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 400, "errorDetails": [ { "type": "hpe.greenlake.bad_request", "issues": [ { "source": "query.parameter", "subject": "id", "description": "Async ID is not provided." } ] } ] } } } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_unauthorized": { "value": { "errorCode": "HPE_GL_ERROR_UNAUTHORIZED", "message": "Unauthorized Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 401, "errorDetails": [ { "type": "hpe.greenlake.unauthorized", "issues": [ { "source": "hpe.greenlake.devicemanagement", "subject": "Unauthorized", "description": "Authentication error - the token was expired." } ] } ] } } } } } }, "403": { "description": "The operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_forbidden": { "value": { "errorCode": "HPE_GL_ERROR_FORBIDDEN", "message": "Forbidden Request", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 403, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "access_token": "Permission is denied to perform requested operation." } } ] } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_not_found": { "value": { "errorCode": "HPE_GL_ERROR_NOT_FOUND", "message": "Not Found", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 404, "errorDetails": [ { "type": "hpe.greenlake.not_found", "issues": [ { "source": "hpe.greenlake.devicemanagement", "subject": "Internal Server Error", "description": "Device ID not found" } ] } ] } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeGeneralError" }, "examples": { "error_too_many_requests": { "value": { "errorCode": "HPE_GL_ERROR_TOO_MANY_REQUESTS", "message": "Too Many Requests", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 429, "errorDetails": [ { "type": "hpe.greenlake.metadata", "source": "hpe.greenlake.subscriptionmanagement", "metadata": { "apiRateLimit": "Too Many Requests. Rate limit has exceeded a predefined value." } } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HpeGreenLakeServerError" }, "examples": { "error_internal_server_error": { "value": { "errorCode": "HPE_GL_ERROR_INTERNAL_SERVER_ERROR", "message": "Internal Server Error", "debugId": "abbeeb59-12cb-49a3-9ce5-55edba12213f", "httpStatusCode": 500, "errorDetails": [ { "type": "hpe.greenlake.retry_info", "retryAfterSeconds": 30 } ] } } } } } } } } } }, "components": { "securitySchemes": { "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "headers": { "LocationHeader": { "schema": { "type": "string", "example": "/devices/v1beta1/async-operations/22d6fbfb-d253-4455-984a-356da827e5fc" }, "description": "The URI of the accepted asynchronous operation resource" }, "LocationHeaderV1": { "schema": { "type": "string", "example": "/devices/v1/async-operations/22d6fbfb-d253-4455-984a-356da827e5fc" }, "description": "The URI of the accepted asynchronous operation resource" } }, "schemas": { "GroupByResponseDistinct": { "type": "object", "description": "Response schema for group by API with distinct values of the specified attribute.", "required": [ "field" ], "additionalProperties": false, "properties": { "field": { "type": "string", "description": "Group by an attribute." } } }, "GroupByResponse": { "type": "object", "description": "Response schema for group by API which includes the count of devices in each group.", "required": [ "field", "count" ], "additionalProperties": false, "properties": { "field": { "type": "string", "description": "Group by attribute, dynamic value Example make, source, manufacturedDate etc" }, "count": { "type": "integer", "description": "Count of devices in the group", "example": 10 } } }, "AsyncResponse": { "required": [ "code", "status", "transactionId" ], "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "description": "Three digit HTTP status code." }, "status": { "type": "string", "enum": [ "100 CONTINUE", "101 SWITCHING_PROTOCOLS", "102 PROCESSING", "103 CHECKPOINT", "200 OK", "201 CREATED", "202 ACCEPTED", "203 NON_AUTHORITATIVE_INFORMATION", "204 NO_CONTENT", "205 RESET_CONTENT", "206 PARTIAL_CONTENT", "207 MULTI_STATUS", "208 ALREADY_REPORTED", "226 IM_USED", "300 MULTIPLE_CHOICES", "301 MOVED_PERMANENTLY", "302 FOUND", "302 MOVED_TEMPORARILY", "303 SEE_OTHER", "304 NOT_MODIFIED", "305 USE_PROXY", "307 TEMPORARY_REDIRECT", "308 PERMANENT_REDIRECT", "400 BAD_REQUEST", "401 UNAUTHORIZED", "402 PAYMENT_REQUIRED", "403 FORBIDDEN", "404 NOT_FOUND", "405 METHOD_NOT_ALLOWED", "406 NOT_ACCEPTABLE", "407 PROXY_AUTHENTICATION_REQUIRED", "408 REQUEST_TIMEOUT", "409 CONFLICT", "410 GONE", "411 LENGTH_REQUIRED", "412 PRECONDITION_FAILED", "413 PAYLOAD_TOO_LARGE", "413 REQUEST_ENTITY_TOO_LARGE", "414 URI_TOO_LONG", "414 REQUEST_URI_TOO_LONG", "415 UNSUPPORTED_MEDIA_TYPE", "416 REQUESTED_RANGE_NOT_SATISFIABLE", "417 EXPECTATION_FAILED", "418 I_AM_A_TEAPOT", "419 INSUFFICIENT_SPACE_ON_RESOURCE", "420 METHOD_FAILURE", "421 DESTINATION_LOCKED", "422 UNPROCESSABLE_ENTITY", "423 LOCKED", "424 FAILED_DEPENDENCY", "425 TOO_EARLY", "426 UPGRADE_REQUIRED", "428 PRECONDITION_REQUIRED", "429 TOO_MANY_REQUESTS", "431 REQUEST_HEADER_FIELDS_TOO_LARGE", "451 UNAVAILABLE_FOR_LEGAL_REASONS", "500 INTERNAL_SERVER_ERROR", "501 NOT_IMPLEMENTED", "502 BAD_GATEWAY", "503 SERVICE_UNAVAILABLE", "504 GATEWAY_TIMEOUT", "505 HTTP_VERSION_NOT_SUPPORTED", "506 VARIANT_ALSO_NEGOTIATES", "507 INSUFFICIENT_STORAGE", "508 LOOP_DETECTED", "509 BANDWIDTH_LIMIT_EXCEEDED", "510 NOT_EXTENDED", "511 NETWORK_AUTHENTICATION_REQUIRED" ], "description": "Three digit HTTPS status code and message." }, "transactionId": { "type": "string", "format": "uuid", "example": "22d6fbfb-d253-4455-984a-356da827e5fc", "description": "The unique identifier of the transaction." } } }, "DevicesPostRequestV2Beta1": { "type": "object", "required": [ "serialNumber", "deviceType" ], "properties": { "tags": { "type": "object", "additionalProperties": { "type": "object", "minProperties": 1, "maxProperties": 50, "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 128, "description": "A tag key is the name used to refer to the tag." }, "value": { "type": "string", "minLength": 0, "maxLength": 256, "description": "A tag value is a value applied to the tag key." } } } }, "serialNumber": { "type": "string", "description": "The serial number of the device." }, "macAddress": { "type": "string", "description": "The media access control (MAC) address of the device. This is required for claiming `NETWORK` devices." }, "partNumber": { "type": "string", "description": "The part number of the device. This is required for claiming `COMPUTE` or `STORAGE` devices." }, "deviceType": { "type": "string", "description": "The type of device.", "enum": [ "COMPUTE", "NETWORK", "STORAGE" ] }, "location": { "type": "object", "description": "The location ID of the device.", "properties": { "id": { "type": "string" } } }, "contact": { "$ref": "#/components/schemas/RequestContact" } } }, "DevicesPostRequest": { "required": [ "compute", "network", "storage" ], "type": "object", "properties": { "network": { "type": "array", "items": { "$ref": "#/components/schemas/RequestNetwork" } }, "compute": { "type": "array", "items": { "$ref": "#/components/schemas/RequestCompute" } }, "storage": { "type": "array", "items": { "$ref": "#/components/schemas/RequestStorage" } } } }, "RequestCompute": { "required": [ "partNumber", "serialNumber" ], "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "object", "minProperties": 1, "maxProperties": 50, "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 128, "description": "A tag key is the name used to refer to the tag." }, "value": { "oneOf": [ { "type": "string", "minLength": 0, "maxLength": 256, "description": "A tag value is a value applied to the tag key." }, { "type": "null", "description": "A tag value of null indicates a tag is to be deleted." } ] } } } }, "serialNumber": { "type": "string", "description": "The serial number of the device." }, "partNumber": { "type": "string", "description": "Identifier of a product component or part." } } }, "RequestNetwork": { "required": [ "macAddress", "serialNumber" ], "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "object", "minProperties": 1, "maxProperties": 50, "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 128, "description": "A tag key is the name used to refer to the tag." }, "value": { "oneOf": [ { "type": "string", "minLength": 0, "maxLength": 256, "description": "A tag value is a value applied to the tag key." }, { "type": "null", "description": "A tag value of null indicates that the tag is to be deleted." } ] } } } }, "serialNumber": { "type": "string", "description": "The serial number of the device." }, "macAddress": { "type": "string", "description": "The media access control (MAC) address of the device." } } }, "RequestStorage": { "required": [ "serialNumber", "partNumber" ], "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "object", "minProperties": 1, "maxProperties": 50, "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 128, "description": "A tag key is the name used to refer to the tag." }, "value": { "oneOf": [ { "type": "string", "minLength": 0, "maxLength": 256, "description": "A tag value is a value applied to the tag key." }, { "type": "null", "description": "A tag value of null indicates a tag is to be deleted." } ] } } } }, "serialNumber": { "type": "string", "description": "The serial number of the device." }, "partNumber": { "type": "string", "description": "The part number of the device." } } }, "PatchDevicesRequestV2": { "type": "object", "properties": { "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/RequestSubscription" } }, "application": { "$ref": "#/components/schemas/RequestApplication" }, "region": { "type": "string", "description": "The region of the application the device is provisioned in." }, "tenantWorkspaceId": { "type": "string", "description": "The platform customer ID of the tenant." }, "archived": { "type": "boolean" }, "tags": { "type": "object", "description": "Provide a map of `tags` to create or delete for the given `DeviceID` (or multiple `DeviceID`'s). Tags are saved with the character casing preserved (uppercase, lowercase, mixed, and so on). For example, adding a new tag with the key `Location` will fail if the Device already has a tag with the key `LOCATION` as they are considered the same key. Tag keys and tag values can comprise letters, numbers, spaces (represented in UTF-8), and only the characters: `_`, `.`, `:`, `=`, `+`, `-`, and `@`. **NOTE:** Do not store sensitive data, such as personally identifiable information, in tags.", "additionalProperties": { "type": "object", "minProperties": 1, "maxProperties": 50, "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 128, "description": "A tag key is the name used to refer to the tag." }, "value": { "oneOf": [ { "type": "string", "minLength": 0, "maxLength": 256, "description": "A tag value is a value applied to the tag key." }, { "type": "null", "description": "A tag value of null indicates a tag is to be deleted." } ] } } } }, "location": { "type": "object", "description": "The location of the device.", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier of the location.", "example": "4b2da819-be18-4793-befb-ab42866eadec" } } }, "warranty/currentSupportLevel": { "type": "object", "description": "Current support level details to update for the device warranty.", "properties": { "serviceLevel": { "type": "string", "description": "Support service level name." }, "endDate": { "type": "string", "format": "date-time", "description": "Support end date in ISO 8601 UTC format." } } }, "contact": { "$ref": "#/components/schemas/RequestContact" } } }, "PatchDevicesRequest": { "type": "object", "properties": { "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/RequestSubscription" } }, "application": { "$ref": "#/components/schemas/RequestApplication" }, "region": { "type": "string", "description": "The region of the application the device is provisioned in." }, "tenantPlatformCustomerId": { "type": "string", "description": "The platform customer ID of the tenant." } } }, "RequestApplication": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "0892c36d-40df-4f26-923b-76b5d213b420", "description": "The unique identifier of the application." } } }, "RequestSubscription": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the subscription." } } }, "RequestContact": { "type": "object", "description": "The contact information for the device.", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "WORKSPACE-USER", "NON-WORKSPACE-USER" ] }, "workspaceUser": { "type": "object", "description": "Details for workspace users, that is, users already added to the workspace.", "properties": { "id": { "type": "string", "description": "The unique identifier of the workspace user." } } }, "nonWorkspaceUser": { "type": "object", "description": "Details for non-workspace users.", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "description": "The email address of the non-workspace user." }, "firstName": { "type": "string", "description": "The first name of the non-workspace user." }, "lastName": { "type": "string", "description": "The last name of the non-workspace user." }, "phoneNumber": { "type": "string", "description": "The phone number of the non-workspace user." } } } } }, "AsyncOperationResource": { "type": "object", "required": [ "id", "type" ], "properties": { "status": { "type": "string", "enum": [ "INITIALIZED", "RUNNING", "FAILED", "SUCCEEDED", "TIMEDOUT", "PAUSED" ], "description": "The current status of an asynchronous operation." }, "startedAt": { "type": "string", "format": "date-time", "description": "Date and time the asynchronous operation began in UTC format." }, "endedAt": { "type": "string", "format": "date-time", "description": "Date and time the asynchronous operation ended in UTC format." }, "progressPercent": { "type": "integer", "format": "int32", "description": "A number that indicates how close to completion the asynchronous operation is." }, "suggestedPollingIntervalSeconds": { "type": "integer", "format": "int32", "description": "The suggested time to wait (in minutes) before calling the operation again." }, "timeoutMinutes": { "type": "integer", "format": "int32", "description": "The number of minutes it took for the operation to time out." }, "result": { "type": "object", "description": "An array that provides information on successful or unsuccessful operations." }, "resultType": { "type": "string", "description": "Relates individual devices to a result type. A result type declares if an operation was successful or unsuccessful." }, "id": { "type": "string", "format": "uuid", "example": "3292c36d-30ef-4f26-823b-76b5d213b670", "description": "The unique identifier of the device." }, "type": { "type": "string", "description": "The type of the resource", "example": "devices/asyncOperation" } } }, "DeviceDetail": { "required": [ "id", "partNumber", "serialNumber", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "64343c3c-3016-4234-baee-765651aa4bb3", "description": "The unique identifier of the device." }, "macAddress": { "pattern": "^([0-9a-fA-F]{2})(:[0-9a-fA-F]{2}){5}$", "type": "string", "example": "21:01:18:21:12:22", "description": "The media access control (MAC) address of the device" }, "serialNumber": { "type": "string", "example": "AX17PR347J", "description": "The serial number of the device." }, "partNumber": { "type": "string", "example": "BHD31D9J", "description": "Identifier of the a device component or part." }, "type": { "type": "string", "example": "devices/device", "description": "The type of the resource." }, "deviceType": { "type": "string", "enum": [ "ALS", "AP", "BLE", "COMPUTE", "CONTROLLER", "DHCI_COMPUTE", "DHCI_STORAGE", "EINAR", "EINR", "GATEWAY", "IAP", "LTE_MODEM", "MC", "STORAGE", "SWITCH", "NW_THIRD_PARTY", "PCE", "SD_WAN_GW", "OPSRAMP_SAAS", "SD_SAAS", "SENSOR", "BRIDGES", "UNKNOWN" ], "description": "The category (type) the device belongs to." }, "assignedState": { "type": "string", "enum": [ "ASSIGNED_TO_ACTIVATE_CONFIG", "ASSIGNED_TO_DEDICATED_PLATFORM", "ASSIGNED_TO_SERVICE", "UNASSIGNED" ], "description": "The current assignment state of the device.\n- `ASSIGNED_TO_ACTIVATE_CONFIG`—The device was moved to the custom activate configuration.\n- `ASSIGNED_TO_DEDICATED_PLATFORM`—The device is used in a dedicated platform workspace.\n- `ASSIGNED_TO_SERVICE`—The device is assigned to a service.\n- `UNASSIGNED`—The device is available for service provisioning.\n" }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-02-13T09:00:22.920Z", "description": "The date and time the device was created in UTC (RFC 3339 format)." }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-02-13T19:30:32.920Z", "description": "The date and time the device was last updated in UTC (RFC 3339 format)." }, "model": { "type": "string", "example": "COMPUTE", "description": "Hardware model of the device" }, "make": { "type": "string", "example": "HPE", "description": "The manufacturer of the device." }, "category": { "type": "string", "enum": [ "NETWORK", "STORAGE", "COMPUTE" ], "example": "NETWORK", "description": "The computed category of the device based on the device type, for example, Network, Storage, or Compute." }, "manufacturedDate": { "type": "string", "format": "date-time", "example": "2024-02-13T19:30:32.920Z", "description": "The date the device was manufactured in UTC (RFC 3339 format)." }, "ownership": { "type": "string", "enum": [ "MANAGED", "FLEX", "DISCOVERED" ], "description": "The ownership of the device based on how the device was added to the inventory." }, "source": { "type": "string", "enum": [ "MANAGED", "DISCOVERED" ], "description": "The source of device based on how it was added to the inventory." }, "isFlex": { "type": "boolean", "example": false, "description": "A boolean that indicates whether the device has a Flex subscription or not." }, "archived": { "type": "boolean", "example": false, "description": "A boolean that indicates whether the device has been archived or not. Archived devices are no longer in service." }, "deviceName": { "type": "string", "example": "iLO Hostname", "description": "Hostname of the device" }, "secondaryName": { "type": "string", "example": "OS Hostname", "description": "Secondary hostname of the device" }, "application": { "$ref": "#/components/schemas/ResponseApplication" }, "region": { "type": "string", "example": "us-west", "description": "The region of the application the device is provisioned in" }, "tags": { "type": "object", "additionalProperties": { "type": "string", "description": "A tag is a form of metadata applied to any resource and primarily used to categorize resources." } }, "subscription": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseSubscription" } }, "tenantWorkspaceId": { "type": "string", "example": "3292c36d30ef4f26823b76b5d213b670", "description": "The unique identifier of the tenant workspace belonging to an MSP. This field is populated only for MSP-owned inventory tenants (the MSP owns the devices and subscriptions and also manages the workspace on behalf of their customers)." }, "location": { "$ref": "#/components/schemas/ResponseLocation" }, "warranty": { "$ref": "#/components/schemas/ResponseWarranty" }, "subscriptionCategory": { "type": "string", "example": "ProLiant", "description": "The platform subscription category assigned to the device. This field is populated only for Compute devices." }, "dedicatedPlatformWorkspace": { "$ref": "#/components/schemas/ResponseDedicatedPlatform" }, "billingAccountId": { "type": "string", "example": "12345-67890-ABCD", "description": "The billing account ID associated with the Flex device." }, "billingAccountName": { "type": "string", "example": "12345-67890-ABCD", "description": "The billing account name associated with the Flex device." }, "billingTier": { "type": "string", "example": "Premium", "description": "The billing tier associated with the Flex device" }, "contact": { "$ref": "#/components/schemas/ResponseContact", "description": "The contact details associated with the device.\nDepending on the contact type, only the relevant fields will be populated.\n- `WORKSPACE-USER`—The contact is a workspace user. In this case, the `id` and `resourceUri` fields are populated to reference the workspace user identity.\n- `NON-WORKSPACE-USER`—The contact is not a workspace user. In this case, the `email`, `firstName`, `lastName`, and `phoneNumber` fields are provided for direct contact information.\n" }, "management": { "anyOf": [ { "type": "string", "enum": [ "MSP", "TENANT" ] }, { "type": "null" } ], "description": "Indicates whether the device is managed by an MSP or a tenant. Null indicates an enterprise organization device (not MSP/tenant-managed)." }, "inUseWorkspace": { "anyOf": [ { "$ref": "#/components/schemas/ResponseInUseWorkspaceId" }, { "type": "null" } ], "description": "The workspace the device belongs to. Null for MSP account types. For other account types (MOI, COI, Enterprise Org Standalone), this field indicates the workspace the device is currently in use by." } } }, "DevicesGetResponse": { "type": "object", "required": [ "items", "count" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceDetail" } }, "count": { "type": "integer", "format": "int32", "example": 10, "description": "Number of items returned" }, "offset": { "type": "integer", "format": "int32", "example": 0, "description": "Zero-based resource offset" }, "total": { "type": "integer", "format": "int32", "example": 100, "description": "Total number of items in the collection that match the filter query, if one was provided in the request" } } }, "ResponseApplication": { "required": [ "id", "resourceUri" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "0892c36d-40df-4f26-923b-76b5d213b420", "description": "Identifier of the application provisioned on the device" }, "resourceUri": { "type": "string", "description": "URI to the application", "example": "/service-catalog/v1beta1/service-managers/0892c36d-40df-4f26-923b-76b5d213b420" } } }, "ResponseSubscription": { "required": [ "id", "resourceUri" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "3292c36d-30ef-4f26-823b-76b5d213b670", "description": "Unique identifier of the subscription assigned to the device" }, "key": { "type": "string", "description": "The unique identifier of a subscription.", "example": "SIEIAASTEST018ID" }, "tier": { "type": "string", "description": "Tier of the assigned subscription", "enum": [ "BASIC_AP", "BASIC_SWITCH", "SPECIAL", "FOUNDATION_70XX", "ADVANCE_70XX", "FOUNDATION_7005", "ADVANCE_7005", "FOUNDATION_72XX", "ADVANCE_72XX", "ADVANCE_90XX_SEC", "FOUNDATION_BASE_90XX_SEC", "FOUNDATION_90XX_SEC", "SDWAN_SECURITY", "DEVICE_PROFILING", "VGW_500M", "VGW_2G", "VGW_4G", "ANALYTICS", "NETWORK_ACCESS_CONTROL", "FOUNDATION_AP", "ADVANCED_AP", "BRIDGE", "FOUNDATION_BRIDGE", "FOUNDATION_WLAN_GW", "FOUNDATION_SWITCH_6100", "FOUNDATION_SWITCH_6200", "FOUNDATION_SWITCH_6300", "FOUNDATION_SWITCH_6400", "FOUNDATION_SWITCH_8400", "FOUNDATION_SWITCH_8XXX_9XXX_10XXX", "ADVANCED_SWITCH_6100", "ADVANCED_SWITCH_6200", "ADVANCED_SWITCH_6300", "ADVANCED_SWITCH_6400", "ADVANCED_SWITCH_8400", "ADVANCED_SWITCH_8XXX_9XXX_10XXX", "ADVANCED_PROLIANT", "FOUNDATION_PROLIANT", "STANDARD_PROLIANT", "ENHANCED_PROLIANT", "FOUNDATION_SDFLEX", "STANDARD_SDFLEX", "ENHANCED_SDFLEX", "FOUNDATION_EDGELINE", "STANDARD_EDGELINE", "ENHANCED_EDGELINE", "FOUNDATION_VM_BACKUP", "STANDARD_VM_BACKUP", "ENHANCED_VM_BACKUP", "FOUNDATION_ZERTO", "FOUNDATION_ZERTO_LEGACY", "NO_TIER_ZERTO", "FOUNDATION_SFM", "STANDARD_OVOPSMGMT", "ENHANCED_OVOPSMGMT", "FOUNDATION_ALLETRA", "STANDARD_ALLETRA", "ENHANCED_ALLETRA", "ADVANCED_ALLETRA_4K", "STANDARD_ALLETRA_4K", "ENHANCED_ALLETRA_4K", "MCP_BAAS", "MCV_BAAS", "MCB_BAAS", "BCP_BAAS", "BCV_BAAS", "BCB_BAAS", "GPP_BAAS", "GPV_BAAS", "GPB_BAAS", "GPP_HCIAAS", "GPB_HCIAAS", "GPV_HCIAAS", "EVP_HCIAAS", "EVB_HCIAAS", "EPP_HCIAAS", "EPB_HCIAAS", "BCP_HCIAAS", "BCV_HCIAAS", "BCB_HCIAAS", "AFP_HCIAAS", "AFB_HCIAAS", "AFV_HCIAAS", "HFP_HCIAAS", "HFB_HCIAAS", "HFV_HCIAAS", "FOUNDATION_BLOCK_STORAGE", "FOUNDATION_HCI_MANAGER", "FOUNDATION_CARE_EMBEDDED", "FOUNDATION_CARE_PLUS_EMBEDDED", "FOUNDATION_NW_THIRD_PARTY", "ADVANCED_NW_THIRD_PARTY", "WLAN_ADVANCED_90XX_SEC", "WLAN_ADVANCED_92XX_SEC", "FOUNDATION_92XX_SEC", "ADVANCED_92XX_SEC", "WLAN_ADVANCED_90XX_70XX", "WLAN_ADVANCED_92XX_72XX", "WLAN_ADVANCED_91XX", "WLAN_ADVANCED_91XX_SEC", "FOUNDATION_91XX", "FOUNDATION_91XX_SEC", "ADVANCED_91XX", "ADVANCED_91XX_SEC", "SMALL_VM_BACKUP", "MEDIUM_VM_BACKUP", "LARGE_VM_BACKUP", "XLARGE_VM_BACKUP", "PRIVATE_CLOUD_ENTERPRISE", "STA", "STB", "STC", "ES", "PR", "ET", "ST", "FOUNDATION_MLDE", "FOUNDATION_SENSOR_CLOUD", "FOUNDATION_SENSOR_LTE", "FOUNDATION_ZEBRA_AGENT_CLOUD", "FOUNDATION_AGENT_CLOUD", "SDWAN_FO_EC_HUB", "SDWAN_AD_EC_HUB", "FOUNDATION_STORAGE", "FOUNDATION_EZMERAL_K8S", "ONPREM_SERVICE", "FOUNDATION_SUPER_COMPUTING", "HPE_ALLETRA_STORAGE_MP_B10000_SOFTWARE_AND_SUPPORT_SAAS", "CENTRAL_OPSRAMP_EXTENSION", "OPSRAMP_INTEGRATIONS", "UNKNOWN" ], "example": "ENHANCED_PROLIANT" }, "startTime": { "type": "string", "format": "date-time", "example": "2024-02-13T09:00:22.920Z", "description": "The start date and time of the subscription in UTC (RFC 3339 format)." }, "endTime": { "type": "string", "format": "date-time", "example": "2024-02-13T19:30:32.920Z", "description": "The end date and time of the subscription in UTC (RFC 3339 format)." }, "resourceUri": { "type": "string", "description": "URI to the the subscription", "example": "/subscriptions/v1beta1/subscriptions/3292c36d-30ef-4f26-823b-76b5d213b670" } } }, "ResponseInUseWorkspaceId": { "required": [ "id", "type", "resourceUri" ], "type": "object", "properties": { "id": { "type": "string", "example": "3292c36d30ef4f26823b76b5d213b670", "description": "The unique identifier of the workspace." }, "resourceUri": { "type": "string", "description": "Full path of the workspace resource", "example": "/workspaces/v1/workspaces/3292c36d30ef4f26823b76b5d213b670" }, "type": { "type": "string", "example": "workspaces/workspace", "description": "The type of the resource." } } }, "ResponseLocation": { "required": [ "id", "resourceUri" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "57f2b22e-7923-497b-8120-fd2b94579f13", "description": "Identifier of the location of the device" }, "city": { "type": "string", "example": "New York", "description": "City of the location" }, "state": { "type": "string", "example": "NY", "description": "State of the location" }, "country": { "type": "string", "example": "USA", "description": "Country of the location" }, "latitude": { "type": "number", "format": "double", "example": 40.7128, "description": "Latitude coordinate" }, "longitude": { "type": "number", "format": "double", "example": -74.006, "description": "Longitude coordinate" }, "postalCode": { "type": "string", "example": 10001, "description": "Postal code of the location" }, "locationName": { "type": "string", "example": "Main Office", "description": "Name of the location" }, "streetAddress": { "type": "string", "example": "123 Main St", "description": "Street address of the location" }, "locationSource": { "type": "string", "example": "GPS", "description": "Source of the location information" }, "resourceUri": { "type": "string", "description": "URI to the location of the device", "example": "/locations/v1beta1/locations/57f2b22e-7923-497b-8120-fd2b94579f13" } } }, "ResponseWarranty": { "type": "object", "description": "The warranty information for the device.", "properties": { "country": { "type": "string" }, "currentSupportLevel": { "$ref": "#/components/schemas/ResponseSupportLevel" }, "supportLevels": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseSupportLevel" } } } }, "ResponseSupportLevel": { "type": "object", "description": "The support levels are ranked to differentiate and display the support provided to customers.", "properties": { "serviceLevel": { "type": "string", "description": "The value used for differentiation." }, "serviceLevelRank": { "type": "integer", "description": "The rank of the support level. The lower the rank, the better the level." }, "contractLevel": { "type": "string", "description": "Sub-categorizes the support level for display to the customer." }, "contractLevelRank": { "type": "integer", "description": "The rank of the contract level within the support level. The lower the rank, the better the level." }, "startDate": { "type": "string", "format": "date-time", "example": "2024-06-01T00:00:00.000Z", "description": "The start date of the support level in UTC (RFC 3339 format)." }, "endDate": { "type": "string", "format": "date-time", "example": "2026-06-01T00:00:00.000Z", "description": "The end date of the support level in UTC (RFC 3339 format)." } } }, "ResponseDedicatedPlatform": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "a482ff61-1e0e-4818-920b-4cbc017208ee", "description": "Unique identifier of the dedicated platform workspace" } } }, "ResponseContact": { "type": "object", "description": "Contact details for the device.", "properties": { "type": { "type": "string", "enum": [ "WORKSPACE-USER", "NON-WORKSPACE-USER" ], "description": "Indicates if the contact is a workspace user or not.", "example": "NON-WORKSPACE-USER" }, "email": { "type": "string", "format": "email", "description": "The email address of the contact.", "example": "nonworkspace.user@gmail.com" }, "firstName": { "type": "string", "description": "The first name of the contact.", "example": "John" }, "lastName": { "type": "string", "description": "The last name of the contact.", "example": "Doe" }, "phoneNumber": { "type": "string", "description": "The phone number for the contact.", "example": "+1-555-123-4567" }, "id": { "type": "string", "format": "uuid", "description": "The unique identifier of the workspace user contact.", "example": "4a2e4102-5c05-4713-8fc8-4e82f9704e53" }, "resourceUri": { "type": "string", "description": "Resource URI for the workspace user contact.", "example": "/identity/v1/users/4a2e4102-5c05-4713-8fc8-4e82f9704e53" } } }, "GeneralErrorDetail": { "type": "object", "required": [ "type", "source", "metadata" ], "properties": { "type": { "type": "string", "description": "The type of error." }, "source": { "type": "string", "description": "The source of the error." }, "metadata": { "type": "object", "description": "Additional key pairs.", "additionalProperties": { "type": "object" } } } }, "HpeGreenLakeGeneralError": { "type": "object", "required": [ "httpStatusCode", "errorCode", "message", "debugId" ], "properties": { "httpStatusCode": { "type": "integer", "format": "int32", "description": "HTTP equivalent status code" }, "errorCode": { "type": "string", "description": "Unique machine-friendly identifier for the error" }, "message": { "type": "string", "description": "A unique machine-friendly, but human-readable identifier for the error" }, "debugId": { "type": "string", "description": "Unique identifier for the instance of this error" }, "errorDetails": { "type": "array", "items": { "$ref": "#/components/schemas/GeneralErrorDetail" } } } }, "BadRequestErrorDetail": { "type": "object", "required": [ "type", "issues" ], "properties": { "type": { "type": "string", "description": "The type of error details." }, "issues": { "type": "array", "description": "An array of request issues.", "items": { "$ref": "#/components/schemas/ErrorIssue" } } } }, "ErrorIssue": { "type": "object", "properties": { "source": { "type": "string", "description": "The part of the request with an issue." }, "subject": { "type": "string", "description": "The issue key." }, "description": { "type": "string", "description": "An explanation of the issue." } } }, "HpeGreenLakeBadRequestError": { "type": "object", "required": [ "httpStatusCode", "errorCode", "message", "debugId" ], "properties": { "httpStatusCode": { "type": "integer", "format": "int32", "description": "HTTP equivalent status code" }, "errorCode": { "type": "string", "description": "Unique machine-friendly identifier for the error" }, "message": { "type": "string", "description": "A unique machine-friendly, but human-readable identifier for the error" }, "debugId": { "type": "string", "description": "Unique identifier for the instance of this error" }, "errorDetails": { "type": "array", "items": { "$ref": "#/components/schemas/BadRequestErrorDetail" } } } }, "HpeGreenLakeServerError": { "type": "object", "required": [ "httpStatusCode", "errorCode", "message", "debugId" ], "properties": { "httpStatusCode": { "type": "integer", "format": "int32", "description": "HTTP equivalent status code" }, "errorCode": { "type": "string", "description": "Unique machine-friendly identifier for the error" }, "message": { "type": "string", "description": "A unique machine-friendly, but human-readable identifier for the error" }, "debugId": { "type": "string", "description": "Unique identifier for the instance of this error" }, "errorDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ServerErrorDetail" } } } }, "ServerErrorDetail": { "type": "object", "required": [ "type", "retryAfterSeconds" ], "properties": { "type": { "type": "string" }, "retryAfterSeconds": { "type": "integer", "format": "int32" } } } }, "examples": { "GroupByMakeExample": { "summary": "Group devices by make", "description": "Devices are grouped by the `make` attribute, and the count of devices for each make is returned.", "value": { "items": [ { "make": "HPE", "count": 25 }, { "make": "CISCO", "count": 15 }, { "make": "DELL", "count": 10 } ], "count": 3, "total": 3, "offset": 0 } }, "GroupByManufacturedDateExample": { "summary": "Group devices by manufactured date", "description": "Devices are grouped by the `manufacturedDate` attribute, with upper and lower threshold applied. Returns four buckets", "value": { "items": [ { "manufacturedDate": "less_than_lower", "count": 5 }, { "manufacturedDate": "lower_to_upper", "count": 20 }, { "manufacturedDate": "greater_than_upper", "count": 10 }, { "manufacturedDate": "missing", "count": 5 } ], "count": 4, "total": 4, "offset": 0 } }, "GroupByOwnershipExample": { "summary": "Group devices by ownership", "description": "Devices are grouped by the `ownership` attribute, and the count of devices for each ownership type is returned.", "value": { "items": [ { "ownership": "MANAGED", "count": 30 }, { "ownership": "FLEX", "count": 15 }, { "ownership": "DISCOVERED", "count": 5 } ], "count": 3, "total": 3, "offset": 0 } }, "GroupBySourceExample": { "summary": "Group devices by source", "description": "Devices are grouped by the `source` attribute, and the count of devices for each source type is returned.", "value": { "items": [ { "source": "MANAGED", "count": 30 }, { "source": "DISCOVERED", "count": 5 } ], "count": 2, "total": 2, "offset": 0 } }, "GroupByIsFlexExample": { "summary": "Group devices by isFlex", "description": "Devices are grouped by the `isFlex` attribute, and the count of flex and non-flex devices is returned.", "value": { "items": [ { "isFlex": "true", "count": 30 }, { "isFlex": "false", "count": 5 } ], "count": 2, "total": 2, "offset": 0 } }, "GroupByCategoryExample": { "summary": "Group devices by category", "description": "Devices are grouped by the `category` attribute, and the count of devices for each category is returned.", "value": { "items": [ { "category": "NETWORK", "count": 20 }, { "category": "STORAGE", "count": 15 }, { "category": "COMPUTE", "count": 15 } ], "count": 3, "total": 3, "offset": 0 } }, "GroupBySelectMakeExample": { "summary": "Group devices by select to give distinct makes", "description": "Devices are grouped by the selected `make` attributes, and distinct values are returned.", "value": { "items": [ { "make": "HPE" }, { "make": "CISCO" }, { "make": "DELL" } ], "count": 3, "total": 3, "offset": 0 } }, "UpdateLocation": { "summary": "Update the location of a device", "description": "The location of the device is updated to the location with the ID `57f2b22e-7923-497b-8120-fd2b94579f13`.", "value": { "location": { "id": "57f2b22e-7923-497b-8120-fd2b94579f13" } } }, "UpdateSupportDetails": { "summary": "Update the support information of a device", "description": "The support level of the device is updated to `Proactive Care` and the support end date is updated to `2024-12-31T23:59:59Z`.", "value": { "warranty/currentSupportLevel": { "serviceLevel": "Proactive Care", "endDate": "2024-12-31T23:59:59Z" } } }, "UpdateThirdPartyDevice": { "summary": "Update a third-party device", "description": "Update missing details such as tags, location and warranty information.", "value": { "warranty/currentSupportLevel": { "serviceLevel": "Proactive Care", "endDate": "2024-12-31T23:59:59Z" }, "tags": { "location": "Los Angeles", "Setup Option": "Simplified" }, "location": { "id": "57f2b22e-7923-497b-8120-fd2b94579f13" } } }, "UpdateTags": { "summary": "Update tags for a device", "description": "The `purchase month` tag is updated with `April 2023`, and the `Setup Option` tag is updated with `Default`.", "value": { "tags": { "purchase month": "April 2023", "Setup Option": "Default" } } }, "CreateNewTags": { "summary": "Create new tags for a device", "description": "The `location` tag is created with `San Jose`, the `purchase month` tag is created with `April 2023` , and the `Setup Option` tag is created with `Default`.", "value": { "tags": { "location": "San Jose", "purchase month": "April 2023", "Setup Option": "Default" } } }, "UpdateExistingTagsWithNewTagValues": { "summary": "Update existing tags with new values", "description": "The `location` tag is updated with `Los Angeles` and the `Setup Option` tag is updated with `Simplified`.", "value": { "tags": { "location": "Los Angeles", "Setup Option": "Simplified" } } }, "DeleteExistingTags": { "summary": "Remove existing tags from a device", "description": "The `purchase month` tag is removed.", "value": { "tags": { "purchase month": null } } }, "UpdateAndDeleteExistingTags": { "summary": "Update existing tags with new values and remove existing tags", "description": "The `location` tag is updated with `San Francisco` and the `Setup Option` tag is removed.", "value": { "tags": { "location": "San Francisco", "Setup Option": null } } }, "CreateNewTagsAndAssignApplication": { "summary": "Create new tags and assign an application to a device", "description": "The `location` tag is created with `San Jose`, the `purchase month` tag is created with `April 2023`, and the `Setup Option` tag is created with `Default`. The application with the ID `0892c36d-40df-4f26-923b-76b5d213b420` is assigned to the device.", "value": { "tags": { "location": "San Jose", "purchase month": "April 2023", "Setup Option": "Default" }, "application": { "id": "0892c36d-40df-4f26-923b-76b5d213b420" } } }, "UpdateExistingTagsAndUnassignApplication": { "summary": "Update existing tags with new values and remove an application from a device", "description": "The `location` tag is updated with `Los Angeles` and the `Setup Option` tag is updated with `Simplified`. The application is removed from the device.", "value": { "tags": { "location": "Los Angeles", "Setup Option": "Simplified" }, "application": { "id": null } } }, "AssignApplication": { "summary": "Assign an application to a device", "description": "The application with the ID `0892c36d-40df-4f26-923b-76b5d213b420` is assigned to the device.", "value": { "application": { "id": "0892c36d-40df-4f26-923b-76b5d213b420" } } }, "UnassignApplication": { "summary": "Remove an application from a device", "description": "The application is removed from the device.", "value": { "application": { "id": null } } }, "ArchiveDevice": { "summary": "Archive a device", "description": "The device is archived.", "value": { "archived": true } }, "UnarchiveDevice": { "summary": "Unarchive a device", "description": "The device is unarchived.", "value": { "archived": false } }, "AssignSubscription": { "summary": "Assign a subscription to a device", "description": "The subscription with the ID `3292c36d-30ef-4f26-823b-76b5d213b670` is assigned to the device.", "value": { "subscription": [ { "id": "3292c36d-30ef-4f26-823b-76b5d213b670" } ] } }, "UnassignSubscription": { "summary": "Unassign a subscription from a device", "description": "The subscription is unassigned from the device.", "value": { "subscription": [] } }, "AssignLocation": { "summary": "Assign a location to a device", "description": "The location with the ID `57f2b22e-7923-497b-8120-fd2b94579f13` is assigned as the location for the device.", "value": { "location": { "id": "57f2b22e-7923-497b-8120-fd2b94579f13" } } }, "UnassignLocation": { "summary": "Unassign a location from a device", "description": "The location is unassigned from the device.", "value": { "location": {} } }, "AssignWorkspaceUserContact": { "summary": "Assign a workspace user contact", "description": "The workspace user with the ID `4a2e4102-5c05-4713-8fc8-4e82f9704e53` is assigned as the contact for the device.", "value": { "contact": { "type": "WORKSPACE-USER", "workspaceUser": { "id": "4a2e4102-5c05-4713-8fc8-4e82f9704e53" } } } }, "AssignNonWorkspaceUserContact": { "summary": "Assign a non-workspace user contact", "description": "A non-workspace user contact is assigned to the device with the email", "value": { "contact": { "type": "NON-WORKSPACE-USER", "nonWorkspaceUser": { "email": "non.workspaceuser@gmail.com", "firstName": "John", "lastName": "Doe", "phoneNumber": "+1-555-123-4567" } } } }, "UnassignContact": { "summary": "Unassign a contact from a device", "description": "The contact is unassigned from the device.", "value": { "contact": {} } } } } }