Skip to content
API reference
/
/
Get a single device by de...

HPE Flex Solutions (v1beta1)

This is the API reference document for the HPE Flex Solutions data service. It provides endpoints to view and manage Flex device and orders solutions.

Download OpenAPI description
flex-api.json
flex-api.yaml
Overview
License

HPE License

Languages
Servers

https://us-west.api.greenlake.hpe.com/

Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/flex/public/openapi/flex-service/v1beta1/flex-api/

Order Data

Operations

Device Data

Operations

Get and search for Device

Request

This endpoint allows you to retrieve and search for devices. You can filter, sort, and paginate the results.
Pagination: This endpoint supports offset-based pagination using limit and offset parameters.

Security
Bearer
Query
filterstring

Filter expressions consisting of simple comparison operations joined by logical operators.
For the v1beta1 API, the following fields are supported for filtering under the ODATA specification:

  • id
  • macAddress
  • serialNumber
  • resourceId
  • partNumber
  • name
  • type
  • model
  • make
  • billingAccountName
  • billingTier
Examples:

Match all devices with given selected filters

filter=macAddress in ('35:CA:68:8C:B0:51', '8A:26:D2:82:65:D0') and make eq 'HPE'

Match all devices with given selected filters

filter=resourceId eq '554c7740-355f-4ece-8334-3fe9ea9ee33e' and billingAccountName eq 'HPE Tech Care'
selectstring

Comma separated list of fields to be returned in the response. If not provided, all fields will be returned.
All fields are supported.

Example: select=serialNumber,type,make,orderEndDate,billingTier
sortstring

Comma separated list of fields to be sorted by in the response. The default sorting order is by resourceId in ascending order.

Example: sort=resourceId,model asc
offsetinteger>= 0

Zero-based resource offset to start the response from.

Default 0
Example: offset=10
limitinteger[ 0 .. 100 ]

Number of entities to return with a maximum of 100.

Default 20
Example: limit=30
curl -i -X GET \
  https://us-west.api.greenlake.hpe.com/flex/v1beta1/devices \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
itemsArray of objects(Device)required
items[].​idstring(uuid)required

ID of the Device

Example: "3b741a59-a22b-432f-b2cf-b72cc1a04c2d"
items[].​macAddressstringrequired

MAC address of the device

Example: "CA:35:DC:4F:5D:FE"
items[].​serialNumberstringrequired

Serial number of the device

Example: "CN134FD36"
items[].​resourceIdstring(uuid)required

Unique resource ID of the device

Example: "3b741a59-a22b-432f-b2cf-b72cc1a04c2d"
items[].​partNumberstringrequired

Part number of the device

Example: "JK130GT"
items[].​deviceTypestringrequired

The type of the device.

Enum"ALS""AP""BLE"
Example: "DHCI_STORAGE"
items[].​typestringrequired

type of resource

Example: "flex/devices"
items[].​createdAtstring(date-time)required

Date of creation of the resource

Example: "2023-01-01T00:00:00Z"
items[].​updatedAtstring(date-time)required

Date of last update of the resource

Example: "2023-01-01T00:00:00Z"
items[].​generationinteger(int32)required

Monotonically increasing update counter of the resource

Example: 1
items[].​modelstringrequired

The model of the device.

Example: "HPE Compute 6030X"
items[].​makestringrequired

The maker of the device

Example: "HPE"
items[].​tagsArray of objects(Tag)

The tags associated with the device.

items[].​namestring

Name of the device

Example: "custom-device-name"
items[].​billingAccountNamestring

Name of the associated billing account

Example: "Hewlett Packard Enterprises"
items[].​billingTierstring

Name of the associated distributor account

Example: "HPE Distributions"
countintegerrequired
totalintegerrequired
offsetintegerrequired
Response
application/json
{
  "items": [
    { … }
  ],
  "count": 0,
  "total": 0,
  "offset": 0
}

Get a single device by device resource ID

Request

This endpoint allows you to retrieve a device by device resourceID.

Security
Bearer
Path
idstringrequired

The unique identifier (UUID) of the device resource.

curl -i -X GET \
  'https://us-west.api.greenlake.hpe.com/flex/v1beta1/devices/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)required

ID of the Device

Example: "3b741a59-a22b-432f-b2cf-b72cc1a04c2d"
macAddressstringrequired

MAC address of the device

Example: "CA:35:DC:4F:5D:FE"
serialNumberstringrequired

Serial number of the device

Example: "CN134FD36"
resourceIdstring(uuid)required

Unique resource ID of the device

Example: "3b741a59-a22b-432f-b2cf-b72cc1a04c2d"
partNumberstringrequired

Part number of the device

Example: "JK130GT"
deviceTypestringrequired

The type of the device.

Enum"ALS""AP""BLE"
Example: "DHCI_STORAGE"
typestringrequired

type of resource

Example: "flex/devices"
createdAtstring(date-time)required

Date of creation of the resource

Example: "2023-01-01T00:00:00Z"
updatedAtstring(date-time)required

Date of last update of the resource

Example: "2023-01-01T00:00:00Z"
generationinteger(int32)required

Monotonically increasing update counter of the resource

Example: 1
modelstringrequired

The model of the device.

Example: "HPE Compute 6030X"
makestringrequired

The maker of the device

Example: "HPE"
tagsArray of objects(Tag)

The tags associated with the device.

namestring

Name of the device

Example: "custom-device-name"
billingAccountNamestring

Name of the associated billing account

Example: "Hewlett Packard Enterprises"
billingTierstring

Name of the associated distributor account

Example: "HPE Distributions"
Response
application/json
{
  "tags": [
    { … }
  ],
  "id": "3b741a59-a22b-432f-b2cf-b72cc1a04c2d",
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-01T00:00:00Z",
  "type": "flex/devices",
  "generation": 1,
  "macAddress": "CA:35:DC:4F:5D:FE",
  "serialNumber": "CN134FD36",
  "resourceId": "3b741a59-a22b-432f-b2cf-b72cc1a04c2d",
  "partNumber": "JK130GT",
  "name": "custom-device-name",
  "deviceType": "DHCI_STORAGE",
  "model": "HPE Compute 6030X",
  "make": "HPE",
  "billingAccountName": "Hewlett Packard Enterprises",
  "billingTier": "HPE Distributions"
}