Skip to content
/
Perform a test with a con...

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.

Download OpenAPI description
index.json
index.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
API endpoint for US West

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

API endpoint for EU Central

https://eu-central.api.greenlake.hpe.com/

API endpoint for AP Northeast

https://ap-northeast.api.greenlake.hpe.com/

Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/

accounts - v1beta1

Operations

activation-keys - v1beta1

Operations

activation-tokens - v1beta1

Operations

activities - v1beta2

Operations

ahs-files - v1beta1

Operations

secure-gateway-appliances - v1beta2

Operations

appliance-firmware-bundles - v1

Operations

appliance-firmware-bundles - v1beta1

Operations

approval-policy - v1beta2

Operations

approval-request - v1beta2

Operations

async-operations - v1

Operations

async-operations - v1beta1

Operations

energy-over-time - v1beta1

Operations

energy-by-entity - v1beta1

Operations

external-services - v1beta1

Operations

List all external services

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.

Security
Bearer
Query
filterstring

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.

CLASSEXAMPLES
Typesinteger, decimal, timestamp, string, boolean, null
Operationseq, ne, gt, ge, lt, le, in
Logicand, or, not

External Service can be filtered by:

  • serviceType

The following examples are not an exhaustive list of all possible filtering options.

Examples:

Return external services where a property equals a value. <property> eq <value>

filter=serviceType eq 'SERVICE_NOW'

Return external services where serviceType equals VMWARE_VCENTER. <property> eq <value>

filter=serviceType eq 'VMWARE_VCENTER'

Return external services where a property does not equal a value not <property> eq <value>

filter=not serviceType eq 'VMWARE_VCENTER'

Return external services with populated property. not <property> eq null

filter=not serviceType eq null

Return external services where property contains a value. contains(<property>, <value>)

filter=contains(serviceType,'SERVICE')

Return external services where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)

filter=not serviceType eq null and contains(serviceType,'SERVICE')

Return external services where property is one of multiple values. <property> in (<value>,<value>)

filter=serviceType in ('SERVICE_NOW','VMWARE_VCENTER')
Headers
Tenant-Acidstring(uuid)

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.

curl -i -X GET \
  https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
offsetinteger>= 0required

Zero-based resource offset

itemsArray of objects(externalServicesResponse-v1beta1)required
items[].​namestring or string[ 1 .. 256 ] characters

Name given to resource

items[].​serviceTypestring

Used for specifying the type of external service.

ValueDescription
SERVICE_NOWServiceNow integration
DSCCData Services Cloud Console integration
VMWARE_VCENTERVMware vCenter integration
Enum"SERVICE_NOW""DSCC""VMWARE_VCENTER"
items[].​authenticationTypestring

Used to specify which authentication method is used for authenticating the external service.

ValueDescription
OAUTHOAuth authentication (for SERVICE_NOW, DSCC)
BASICBasic authentication with username/password (for VMWARE_VCENTER)
Enum"OAUTH""BASIC"
items[].​descriptionstring or null or string or null<= 256 characters

An optional longer description of the external service

Example: "Service now configuration"
items[].​authentication(externalServicesAuthenticationResponse (object) or externalServicesAuthenticationBasicResponse (object))
One of:
One of:

Authentication credentials based on authenticationType

items[].​serviceData(externalServicesServiceDataServiceNow (object) or externalServicesServiceDataVMwareVCenter (object)) or (externalServicesServiceDataServiceNow (object) or object or externalServicesServiceDataVMwareVCenter (object))
One of:
One of:

Service data corresponding to the specified serviceType

items[].​statusstring

Status of the external service

Enum"ENABLED""SUSPENDED"
items[].​statestring

State of the external service

Enum"ENABLED""DISABLED"
items[].​idstring(uuid)read-only

Primary identifier for the external services resource given by the system.

Example: "b870f080-6448-48c5-b23a-d04f2d489174"
items[].​typestring

Type of the resource

Value "compute-ops-mgmt/external-service"
items[].​resourceUristring(uri-reference)

URI to the external-services itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta1/external-services/ff5798d5-b029-4452-b958-b33eabbe44d2"
items[].​generationinteger>= 1

Monotonically increasing update counter

items[].​createdAtstring(date-time)

Time of external-services configuration creation

items[].​updatedAtstring(date-time)

Time of the external-services configuration update

totalinteger>= 0

Total number of items in the collection that match the filter query, if one was provided in the request

Example: 12
Response
application/json
{
  "offset": 0,
  "count": 1,
  "total": 12,
  "items": [
    { … }
  ]
}

Create external services

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.

Supported Service Types

Service TypeDescription
SERVICE_NOWServiceNow integration for incident management
DSCCData Services Cloud Console integration
VMWARE_VCENTERHPE Compute Ops Management plug-in for VMware vCenter integration

ServiceNow Integration

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.

Below events are independent of above events, and may be selected independently.

  • disconnectedEvent - Events that are generated for after waiting for configured hours of disconnectivity.
  • powerResetEvent - Events that are generated for power change events.

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

serviceEventIssuescriticalEventIssueswarningEventIssuesutilizationAlertspowerResetEventdisconnectedEvent
FalseFalseFalseTrueTrue/False[0/1/2/3]
TrueFalseFalseTrueTrue/False[0/1/2/3]
TrueFalseFalseFalseTrue/False[0/1/2/3]
TrueTrueFalseTrueTrue/False[0/1/2/3]
TrueTrueFalseFalseTrue/False[0/1/2/3]
TrueTrueTrueTrueTrue/False[0/1/2/3]
TrueTrueTrueFalseTrue/False[0/1/2/3]

Initial values

All values are initially false except serviceEventIssues with the result being that incidents will be created only for service events.

VMware vCenter Integration

When adding VMware vCenter as an external service for the HPE Compute Ops Management plug‑in for VMware vCenter integration, provide the following attributes:

  • vCenterUrl - The URL or IP address of the vCenter server
  • associatedGatewayUri - The URI of the associated secure gateway appliance
  • vCenterCertFingerprint - The SHA-256 fingerprint of the vCenter server certificate
  • authenticationType - Must be BASIC with username and password credentials
Security
Bearer
Headers
Content-Typestringrequired

Content-Type header must designate 'application/json' in order for the request to be performed.

Value "application/json"
Tenant-Acidstring(uuid)

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.

Bodyapplication/jsonrequired
namestring[ 1 .. 256 ] charactersrequired

Name given to resource

serviceTypestringrequired

Used for specifying the type of external service.

ValueDescription
SERVICE_NOWServiceNow integration
DSCCData Services Cloud Console integration
VMWARE_VCENTERVMware vCenter integration
Enum"SERVICE_NOW""DSCC""VMWARE_VCENTER"
authenticationTypestringrequired

Used to specify which authentication method is used for authenticating the external service.

ValueDescription
OAUTHOAuth authentication (for SERVICE_NOW, DSCC)
BASICBasic authentication with username/password (for VMWARE_VCENTER)
Enum"OAUTH""BASIC"
descriptionstring or null<= 256 charactersrequired

An optional longer description of the external service

Example: "Service now configuration"
authenticationexternalServicesAuthentication (object) or externalServicesAuthenticationBasic (object)required
One of:

Client credentials and refresh token details

object externalServicesAuthentication Recursive
serviceDataexternalServicesServiceDataServiceNow (object) or (externalServicesServiceDataDSCC (object or null or object or null)) or externalServicesServiceDataVMwareVCenter (object)required
One of:

Client URL information for authentication and incident creation

object externalServicesServiceDataServiceNow Recursive
statestring

State of the external service

Default "ENABLED"
Enum"ENABLED""DISABLED"
curl -i -X POST \
  https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "ServiceNow Integration",
    "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
    }
  }'

Responses

Successful Response

Headers
Locationstring(uri-reference)

The URI of the newly-created resource

Example: "/compute-ops-mgmt/v1beta1/external-services/b870f080-6448-48c5-b23a-d04f2d489174"
Bodyapplication/json
namestring[ 1 .. 256 ] characters

Name given to resource

serviceTypestring

Used for specifying the type of external service.

ValueDescription
SERVICE_NOWServiceNow integration
DSCCData Services Cloud Console integration
VMWARE_VCENTERVMware vCenter integration
Enum"SERVICE_NOW""DSCC""VMWARE_VCENTER"
authenticationTypestring

Used to specify which authentication method is used for authenticating the external service.

ValueDescription
OAUTHOAuth authentication (for SERVICE_NOW, DSCC)
BASICBasic authentication with username/password (for VMWARE_VCENTER)
Enum"OAUTH""BASIC"
descriptionstring or null<= 256 characters

An optional longer description of the external service

Example: "Service now configuration"
authenticationexternalServicesAuthenticationResponse (object) or externalServicesAuthenticationBasicResponse (object)
One of:

Client credentials and refresh token details

object externalServicesAuthenticationResponse Recursive
serviceDataexternalServicesServiceDataServiceNow (object) or (externalServicesServiceDataDSCC (object or null)) or externalServicesServiceDataVMwareVCenter (object)
One of:

Client URL information for authentication and incident creation

object externalServicesServiceDataServiceNow Recursive
statusstring

Status of the external service

Enum"ENABLED""SUSPENDED"
statestring

State of the external service

Enum"ENABLED""DISABLED"
idstring(uuid)read-only

Primary identifier for the external services resource given by the system.

Example: "b870f080-6448-48c5-b23a-d04f2d489174"
typestring

Type of the resource

Value "compute-ops-mgmt/external-service"
resourceUristring(uri-reference)

URI to the external-services itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta1/external-services/ff5798d5-b029-4452-b958-b33eabbe44d2"
generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of external-services configuration creation

updatedAtstring(date-time)

Time of the external-services configuration update

Response
application/json
{
  "name": "ServiceNow Integration",
  "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
  },
  "id": "b870f080-6448-48c5-b23a-d04f2d489174",
  "type": "compute-ops-mgmt/external-service",
  "serviceType": "SERVICE_NOW",
  "authenticationType": "OAUTH",
  "status": "ENABLED",
  "state": "ENABLED",
  "resourceUri": "/compute-ops-mgmt/v1beta1/external-services/b870f080-6448-48c5-b23a-d04f2d489174",
  "generation": 1,
  "createdAt": "2026-01-10T10:00:00.000000Z",
  "updatedAt": "2026-01-10T10:00:00.000000Z"
}

Get an external-services item by ID

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.

Security
Bearer
Path
idstring(uuid)required
Headers
Tenant-Acidstring(uuid)

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.

curl -i -X GET \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
namestring[ 1 .. 256 ] characters

Name given to resource

serviceTypestring

Used for specifying the type of external service.

ValueDescription
SERVICE_NOWServiceNow integration
DSCCData Services Cloud Console integration
VMWARE_VCENTERVMware vCenter integration
Enum"SERVICE_NOW""DSCC""VMWARE_VCENTER"
authenticationTypestring

Used to specify which authentication method is used for authenticating the external service.

ValueDescription
OAUTHOAuth authentication (for SERVICE_NOW, DSCC)
BASICBasic authentication with username/password (for VMWARE_VCENTER)
Enum"OAUTH""BASIC"
descriptionstring or null<= 256 characters

An optional longer description of the external service

Example: "Service now configuration"
authenticationexternalServicesAuthenticationResponse (object) or externalServicesAuthenticationBasicResponse (object)
One of:

Client credentials and refresh token details

object externalServicesAuthenticationResponse Recursive
serviceDataexternalServicesServiceDataServiceNow (object) or (externalServicesServiceDataDSCC (object or null)) or externalServicesServiceDataVMwareVCenter (object)
One of:

Client URL information for authentication and incident creation

object externalServicesServiceDataServiceNow Recursive
statusstring

Status of the external service

Enum"ENABLED""SUSPENDED"
statestring

State of the external service

Enum"ENABLED""DISABLED"
idstring(uuid)read-only

Primary identifier for the external services resource given by the system.

Example: "b870f080-6448-48c5-b23a-d04f2d489174"
typestring

Type of the resource

Value "compute-ops-mgmt/external-service"
resourceUristring(uri-reference)

URI to the external-services itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta1/external-services/ff5798d5-b029-4452-b958-b33eabbe44d2"
generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of external-services configuration creation

updatedAtstring(date-time)

Time of the external-services configuration update

Response
application/json
{
  "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"
}

Delete an external-services item

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.

Security
Bearer
Path
idstring(uuid)required
Headers
Tenant-Acidstring(uuid)

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.

curl -i -X DELETE \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response
No content

Patch an external-services item

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.

Supported Service Types

Service TypeDescription
SERVICE_NOWServiceNow integration for incident management
DSCCData Services Cloud Console integration
VMWARE_VCENTERHPE Compute Ops Management plug-in for VMware vCenter integration

ServiceNow Integration

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

Below events are independent of above events, and may be selected independently.

  • disconnectedEvent - Events that are generated for after waiting for configured hours of disconnectivity.
  • powerResetEvent - Events that are generated for power change events.

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

serviceEventIssuescriticalEventIssueswarningEventIssuesutilizationAlertspowerResetEventdisconnectedEvent
FalseFalseFalseTrueTrue/False[0/1/2/3]
TrueFalseFalseTrueTrue/False[0/1/2/3]
TrueFalseFalseFalseTrue/False[0/1/2/3]
TrueTrueFalseTrueTrue/False[0/1/2/3]
TrueTrueFalseFalseTrue/False[0/1/2/3]
TrueTrueTrueTrueTrue/False[0/1/2/3]
TrueTrueTrueFalseTrue/False[0/1/2/3]

Initial values

All values are initially false except serviceEventIssues with the result being that incidents will be created only for service events.

VMware vCenter Integration

When updating the VMware vCenter external service, provide the following attributes:

  • name - The display name of the vCenter integration
  • vCenterUrl - The URL or IP address of the vCenter server
  • associatedGatewayUri - The URI of the associated secure gateway appliance
  • vCenterCertFingerprint - The SHA-256 fingerprint of the vCenter server certificate
  • authentication - Username and password credentials
Security
Bearer
Path
idstring(uuid)required
Headers
Content-Typestringrequired

Content-Type header must designate 'application/merge-patch+json' in order for the request to be performed.

Value "application/merge-patch+json"
Tenant-Acidstring(uuid)

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.

Bodyapplication/merge-patch+jsonrequired
namestring[ 1 .. 256 ] characters

Name given to resource

descriptionstring or null<= 256 characters

An optional longer description of the external service

Example: "Service now configuration"
statestring

State of the external service

Enum"ENABLED""DISABLED"
authenticationexternalServicesAuthentication (object) or externalServicesAuthenticationBasic (object)
One of:

Client credentials and refresh token details

object externalServicesAuthentication Recursive
serviceDataexternalServicesServiceDataServiceNow (object) or (externalServicesServiceDataDSCC (object or null or object or null)) or externalServicesServiceDataVMwareVCenter (object)
One of:

Client URL information for authentication and incident creation

object externalServicesServiceDataServiceNow Recursive 
curl -i -X PATCH \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "name": "ServiceNow Integration",
    "description": "Updated service now configuration",
    "state": "ENABLED",
    "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": 200
    }
  }'

Responses

Successful Response

Bodyapplication/json
namestring[ 1 .. 256 ] characters

Name given to resource

serviceTypestring

Used for specifying the type of external service.

ValueDescription
SERVICE_NOWServiceNow integration
DSCCData Services Cloud Console integration
VMWARE_VCENTERVMware vCenter integration
Enum"SERVICE_NOW""DSCC""VMWARE_VCENTER"
authenticationTypestring

Used to specify which authentication method is used for authenticating the external service.

ValueDescription
OAUTHOAuth authentication (for SERVICE_NOW, DSCC)
BASICBasic authentication with username/password (for VMWARE_VCENTER)
Enum"OAUTH""BASIC"
descriptionstring or null<= 256 characters

An optional longer description of the external service

Example: "Service now configuration"
authenticationexternalServicesAuthenticationResponse (object) or externalServicesAuthenticationBasicResponse (object)
One of:

Client credentials and refresh token details

object externalServicesAuthenticationResponse Recursive
serviceDataexternalServicesServiceDataServiceNow (object) or (externalServicesServiceDataDSCC (object or null)) or externalServicesServiceDataVMwareVCenter (object)
One of:

Client URL information for authentication and incident creation

object externalServicesServiceDataServiceNow Recursive
statusstring

Status of the external service

Enum"ENABLED""SUSPENDED"
statestring

State of the external service

Enum"ENABLED""DISABLED"
idstring(uuid)read-only

Primary identifier for the external services resource given by the system.

Example: "b870f080-6448-48c5-b23a-d04f2d489174"
typestring

Type of the resource

Value "compute-ops-mgmt/external-service"
resourceUristring(uri-reference)

URI to the external-services itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta1/external-services/ff5798d5-b029-4452-b958-b33eabbe44d2"
generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of external-services configuration creation

updatedAtstring(date-time)

Time of the external-services configuration update

Response
application/json
{
  "name": "ServiceNow Integration",
  "description": "Updated 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": 200
  },
  "id": "b870f080-6448-48c5-b23a-d04f2d489174",
  "type": "compute-ops-mgmt/external-service",
  "serviceType": "SERVICE_NOW",
  "authenticationType": "OAUTH",
  "status": "ENABLED",
  "state": "ENABLED",
  "resourceUri": "/compute-ops-mgmt/v1beta1/external-services/b870f080-6448-48c5-b23a-d04f2d489174",
  "generation": 5,
  "createdAt": "2026-01-10T10:00:00.000000Z",
  "updatedAt": "2026-01-15T14:30:00.000000Z"
}

Perform a test with a configured external service

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.

Security
Bearer
Path
idstring(uuid)required
Headers
Tenant-Acidstring(uuid)

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.

curl -i -X POST \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/external-services/{id}/test' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response
No content

filters - v1beta1

Operations

firmware-bundles - v1

Operations

firmware-bundles - v1beta2

Operations

groups - v1

Operations

groups - v1beta3

Operations

groups - v1beta2

Operations

job-templates - v1beta2

Operations

jobs - v1

Operations

jobs - v1beta3

Operations

jobs - v1beta2

Operations

metrics-configurations - v1

Operations

oneview-appliances - v1beta1

Operations

oneview-settings - v1beta1

Operations

oneview-server-templates - v1beta1

Operations

reports - v1beta2

Operations

schedules - v1beta2

Operations

server-locations - v1beta1

Operations

server-settings - v1beta1

Operations

settings - v1

Operations

settings - v1beta1

Operations

servers - v1

Operations

servers - v1beta2

Operations

server-warranty - v1beta2

Operations

user-preferences - v1

Operations

user-preferences - v1beta1

Operations

utilization-over-time - v1beta1

Operations

utilization-by-entity - v1beta1

Operations

webhooks - v1beta1

Operations