Return external services where a property equals a value. <property> eq <value>
HPE Compute Ops Management API (latest)
HPE Compute Operations Management provides a Restful API to customers who want to manage their devices programmatically or through a command line. The API enables customers to invoke operations or tasks such as list devices, see device details, device health, and manage their device's firmware.
UPDATED API ENDPOINTS
Compute Ops Management now supports the HPE GreenLake API endpoints (<region>.api.greenlake.hpe.com
). The Guide contains more information about this change.
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/
https://us-west.api.greenlake.hpe.com/
https://eu-central.api.greenlake.hpe.com/
https://ap-northeast.api.greenlake.hpe.com/
Request
Get the list of external services configured
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
Limit the resources operated on by an endpoint or when used with a multiple-GET endpoint, return only the subset of resources that match the filter. The filter grammar is a subset of OData 4.0.
NOTE: The filter query parameter must use URL encoding. Most clients do this automatically with inputs provided to them specifically as query parameters. Encoding must be done manually for any query parameters provided as part of the URL.
The reserved characters !
#
$
&
'
(
)
*
+
,
/
:
;
=
?
@
[
]
must be encoded with percent encoded equivalents. Server IDs contain a +
, which must be encoded as %2B
.
For example: the value P06760-B21+2M212504P8
must be encoded as P06760-B21%2B2M212504P8
when it is used in a query parameter.
CLASS | EXAMPLES |
---|---|
Types | integer, decimal, timestamp, string, boolean, null |
Operations | eq, ne, gt, ge, lt, le, in |
Logic | and, or, not |
External Service can be filtered by:
- serviceType
The following examples are not an exhaustive list of all possible filtering options.
Return external services where a property does not equal a value not <property> eq <value>
Return external services with populated property. not <property> eq null
Return external services where property contains a value. contains(<property>, <value>)
Return external services where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)
Return external services where property is one of multiple values. <property> in (<value>,<value>)
Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.
In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts
API to determine the application customer IDs for your tenant accounts.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/external-services
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X GET \
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/external-services \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
Successful Response
Used for specifying the type of external service.
Value | Description |
---|---|
SERVICE_NOW | ServiceNow integration |
DSCC | Data Services Cloud Console integration |
Used to specify which authentication method is used for authenticating the external service.
An optional longer description of the external service
Client credentials and refresh token details
Service data corresponding to the specified serviceType
Client URL information for authentication and incident creation
Primary identifier for the external services resource given by the system.
URI to the external-services itself (i.e. a self link)
{ "offset": 0, "count": 1, "total": 12, "items": [ { … } ] }
Request
Create configuration for external service
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
Purpose
When an external configuration is configured on Compute Ops Management, these attributes will be used to set the scope of events for which incidents will be created on the external service.
Incident scope selections are made such that each selection increases the scope of the set of events that will be included. The order of event selections from minimum to maximum scope are
serviceEventIssues
- Events that are marked as service events. These events may have severity levels of 'warning' or 'critical'criticalEventIssues
- Events that are not service events but have a severity level of 'critical'warningEventIssues
- Events that are not service events but have a severity level of 'warning'
Below software events are independent of above events, but either one of the above or below option must be selected.
utilizationAlerts
- Events that are generated for breaching configured power utilization threshold.
Note that healthNotification
is not part of the event notification set and may be set independently.
Since each selection builds on the previous one, there exists a hierarchy between selections that must be maintained. The table below shows which notification combinations are valid. All other combinations will result in an HTTP 400 error
serviceEventIssues | criticalEventIssues | warningEventIssues | utilizationAlerts |
---|---|---|---|
False | False | False | True |
True | False | False | True |
True | False | False | False |
True | True | False | True |
True | True | False | False |
True | True | True | True |
True | True | True | False |
Initial values
All values are initially false except serviceEventIssues with the result being that incidents will be created only for service events.
Content-Type header must designate 'application/json' in order for the request to be performed.
Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.
In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts
API to determine the application customer IDs for your tenant accounts.
Used for specifying the type of external service.
Value | Description |
---|---|
SERVICE_NOW | ServiceNow integration |
DSCC | Data Services Cloud Console integration |
Used to specify which authentication method is used for authenticating the external service.
An optional longer description of the external service
Client credentials and refresh token details
ID of the client external web service
Password for the client external web service
Service data corresponding to the specified serviceType
Client URL information for authentication and incident creation
Authentication URL using which access token is generated
Incident URL is the endpoint used to create incidents on the external service
The number of days after which the refresh token will expire.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/external-services
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X POST \
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/external-services \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"serviceType": "SERVICE_NOW",
"authenticationType": "OAUTH",
"description": "Service now configuration",
"authentication": {},
"serviceData": {}
}'
Successful Response
Used for specifying the type of external service.
Value | Description |
---|---|
SERVICE_NOW | ServiceNow integration |
DSCC | Data Services Cloud Console integration |
Used to specify which authentication method is used for authenticating the external service.
An optional longer description of the external service
Client credentials and refresh token details
Service data corresponding to the specified serviceType
Client URL information for authentication and incident creation
Primary identifier for the external services resource given by the system.
URI to the external-services itself (i.e. a self link)
{ "name": "string", "serviceType": "SERVICE_NOW", "authenticationType": "OAUTH", "description": "Service now configuration", "authentication": { "clientId": "d8c5b0be28a66110300669bf6457a7d1", "clientSecret": "**********", "refreshToken": "**********" }, "serviceData": { "oauthUrl": "https://example.service-now.com/oauth_token.do", "incidentUrl": "https://example.service-now.com/api/now/import/u_demo_incident_inbound_api", "refreshTokenExpiryInDays": 150, "incidentCreationScope": { … } }, "status": "ENABLED", "state": "ENABLED", "id": "b870f080-6448-48c5-b23a-d04f2d489174", "type": "compute-ops-mgmt/external-service", "resourceUri": "/compute-ops-mgmt/v1beta1/external-services/ff5798d5-b029-4452-b958-b33eabbe44d2", "generation": 1, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }
Request
Get a specific external-services item by external-services id.
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.
In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts
API to determine the application customer IDs for your tenant accounts.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/external-services/{id}
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X GET \
'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/external-services/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
Successful Response
Used for specifying the type of external service.
Value | Description |
---|---|
SERVICE_NOW | ServiceNow integration |
DSCC | Data Services Cloud Console integration |
Used to specify which authentication method is used for authenticating the external service.
An optional longer description of the external service
Client credentials and refresh token details
Service data corresponding to the specified serviceType
Client URL information for authentication and incident creation
Primary identifier for the external services resource given by the system.
URI to the external-services itself (i.e. a self link)
{ "name": "string", "serviceType": "SERVICE_NOW", "authenticationType": "OAUTH", "description": "Service now configuration", "authentication": { "clientId": "d8c5b0be28a66110300669bf6457a7d1", "clientSecret": "**********", "refreshToken": "**********" }, "serviceData": { "oauthUrl": "https://example.service-now.com/oauth_token.do", "incidentUrl": "https://example.service-now.com/api/now/import/u_demo_incident_inbound_api", "refreshTokenExpiryInDays": 150, "incidentCreationScope": { … } }, "status": "ENABLED", "state": "ENABLED", "id": "b870f080-6448-48c5-b23a-d04f2d489174", "type": "compute-ops-mgmt/external-service", "resourceUri": "/compute-ops-mgmt/v1beta1/external-services/ff5798d5-b029-4452-b958-b33eabbe44d2", "generation": 1, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }
Request
Delete an external-services item.
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.
In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts
API to determine the application customer IDs for your tenant accounts.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/external-services/{id}
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X DELETE \
'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/external-services/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
Request
Partially update an external-services item
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
Purpose
When an external configuration is configured on Compute Ops Management, these attributes will be used to set the scope of events for which incidents will be created on the external service.
Incident scope selections are made such that each selection increases the scope of the set of events that will be included. The order of event selections from minimum to maximum scope are
serviceEventIssues
- Events that are marked as service events. These events may have severity levels of 'warning' or 'critical'criticalEventIssues
- Events that are not service events but have a severity level of 'critical'warningEventIssues
- Events that are not service events but have a severity level of 'warning'
Below software events are independent of above events, but either one of the above or below option must be selected.
utilizationAlerts
- Events that are generated for breaching configured power utilization threshold
Note that healthNotification
is not part of the event notification set and may be set independently.
Since each selection builds on the previous one, there exists a hierarchy between selections that must be maintained. The table below shows which notification combinations are valid. All other combinations will result in an HTTP 400 error
serviceEventIssues | criticalEventIssues | warningEventIssues | utilizationAlerts |
---|---|---|---|
False | False | False | True |
True | False | False | True |
True | False | False | False |
True | True | False | True |
True | True | False | False |
True | True | True | True |
True | True | True | False |
Initial values
All values are initially false except serviceEventIssues with the result being that incidents will be created only for service events.
Content-Type header must designate 'application/merge-patch+json' in order for the request to be performed.
Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.
In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts
API to determine the application customer IDs for your tenant accounts.
An optional longer description of the external service
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/external-services/{id}
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X PATCH \
'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/external-services/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/merge-patch+json' \
-d '{}'
Successful Response
Used for specifying the type of external service.
Value | Description |
---|---|
SERVICE_NOW | ServiceNow integration |
DSCC | Data Services Cloud Console integration |
Used to specify which authentication method is used for authenticating the external service.
An optional longer description of the external service
Client credentials and refresh token details
Service data corresponding to the specified serviceType
Client URL information for authentication and incident creation
Primary identifier for the external services resource given by the system.
URI to the external-services itself (i.e. a self link)
{ "name": "string", "serviceType": "SERVICE_NOW", "authenticationType": "OAUTH", "description": "Service now configuration", "authentication": { "clientId": "d8c5b0be28a66110300669bf6457a7d1", "clientSecret": "**********", "refreshToken": "**********" }, "serviceData": { "oauthUrl": "https://example.service-now.com/oauth_token.do", "incidentUrl": "https://example.service-now.com/api/now/import/u_demo_incident_inbound_api", "refreshTokenExpiryInDays": 150, "incidentCreationScope": { … } }, "status": "ENABLED", "state": "ENABLED", "id": "b870f080-6448-48c5-b23a-d04f2d489174", "type": "compute-ops-mgmt/external-service", "resourceUri": "/compute-ops-mgmt/v1beta1/external-services/ff5798d5-b029-4452-b958-b33eabbe44d2", "generation": 1, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }
Request
Used for performing a test to verify the integration of the configured external service. An activity will be generated as a result of this test and indicates the success or failure of this test.
For external service with serviceType as SERVICE_NOW, this endpoint will generate a test incident for ServiceNow.
For external service with serviceType as DSCC, this endpoint will test the integration connection to Data Services Cloud Console. This endpoint is available even if the configured Data Services Cloud Console integration is disabled.
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.
In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts
API to determine the application customer IDs for your tenant accounts.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/external-services/{id}/test
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}/test
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}/test
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}/test
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X POST \
'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/external-services/{id}/test' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'