Skip to content
Internal API Catalog
/
Data Services API
/
secrets

Data Services API (1.3.0)

Data Services API

Download OpenAPI description
index.json
index.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/

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

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

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

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

async-operations

Async Operations API

Operations

dual-auth-operations

Dual Authorization API

Operations

issues

Issues API

Operations

secret-assignments

Secret Assignment Management APIs

Operations

secrets

Secret Management APIs

Operations

Reports filtered secrets

Request

Reports the attributes and properties of the secrets owned by the customer. The response can be paged by using the limit and offset query parameters and filtered and sorted by using the filter and sort query parameters.

Query
filterstring(Filter)

An OData expression to filter responses by attribute. The OData logical operator "eq" is case-sensitive and supported for attributes "classifier", "label", "name", "service", "status" and "subclassifier". The OData function "contains()" is not case-sensitive and supported for attributes "label", "name" and "service". The OData logical operator "and" is supported for all attributes.

sortstring(Sort)

A response attribute to sort by, followed by a direction indicator ("asc" or "desc"). The attribute may be one of "assignmentsCount", "classifier", "createdAt", "createdBy", "id", "label", "lastUpdatedBy", "name", "service", "status", "subclassifier" or "updatedAt". Default: ascending.

offsetinteger(Offset)

The offset query parameter should be used in conjunction with limit for paging within a batched result set. The offset is the number of items from the beginning of the batched result set to the first item included in the response. Example: offset=30&limit=10

Default 0
limitinteger(Limit)<= 120

The limit query parameter should be used in conjunction with offset for paging within a batched result set. The limit is the maximum number of items to include in the response. Example: offset=30&limit=10

Default 20
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/secrets

Responses

Successful Response

Bodyapplication/json
countinteger(Count)required

Current results page count

itemsArray of objects(Items)required

Secret resource definitions

items[].​customerIdstring(Customerid)required

Identifier of the customer owning the resource

items[].​servicestring(Service)required

Name of the service originating the resource

items[].​idstring(uuid)(Id)required

Identifier of the resource

items[].​namestring(Name)required

Name of the resource

items[].​typestring(Type)required

Type of the resource

items[].​resourceUristring(Resourceuri)required

URI of the resource

items[].​generationinteger(Generation)required

Update generation number

items[].​updatedAtstring(date-time)(Updatedat)required

Timestamp of the last resource update

items[].​createdAtstring(date-time)(Createdat)required

Timestamp of the resource creation

items[].​domainobject(Domain)required

Resource domain definition

items[].​domain.​namestring(Name)required

Name of the resource domain

items[].​domain.​propertiesobject(Properties)

Resource domain properties

items[].​classifierobject(Classifier)required

Resource classifier definition

items[].​classifier.​namestring(Name)required

Name of the resource classifier

items[].​subclassifierobject(Subclassifier)required

Resource Subclassifier Definition (e.g. BASIC_AUTH)

items[].​subclassifier.​namestring(Name)required

Name of the resource subclassifier

items[].​subclassifier.​propertiesobject(Properties)

Resource subclassifier properties

items[].​statusstring(Status)required

Status of the resource

items[].​statusUpdatedAtstring(date-time)(Statusupdatedat)required

Timestamp of the last status update

items[].​assignmentsCountinteger(Assignmentscount)

Count of associated assignment resources

Default 0
items[].​groupsArray of objects(Groups)

Groups associated with the resource

items[].​labelstring(Label)

Consumer-defined label of the resource

nextstring(Next)

Cursor for next results page

offsetinteger(Offset)

Offset of current results page

totalinteger(Total)

Total results count

Response
application/json
{
  "count": 0,
  "items": [
    { … }
  ],
  "next": "string",
  "offset": 0,
  "total": 0
}

Adds a secret

Request

Adds a new secret using the provided specification.

Headers
x-envoy-external-addressstring(X-Envoy-External-Address)
Default
x-forwarded-forstring(X-Forwarded-For)
Default
Bodyapplication/jsonrequired
Any of:

Assigned Secret Specification

servicestring(Service)required

Name of the service originating the resource

namestring(Name)required

Name of the resource

secretAzureSPClientSecretDef (object) or BasicAuthSecretDef (object) or BearerAuthSecretDef (object) or CertificateSecretDef (object) or GenericSecretDef (object) or JsonWebTokenSecretDef (object) or OAuthClientSecretDef (object) or PasswordSecretDef (object) or PrivateKeySecretDef (object) or SSHKeypairSecretDef (object)(Secret)required

Secret definition

Any of:

Azure Service Principal client secret definition

secret.​azureSPClientobject(Azurespclient)required

Azure Service Principal client secret properties

secret.​azureSPClient.​clientIdstring(Clientid)

Azure Service Principal client ID (aka application ID)

secret.​azureSPClient.​clientSecretstring(Clientsecret)

Azure Service Principal client secret

secret.​azureSPClient.​tenantIdstring(Tenantid)

Azure Service Principal tenant ID (aka directory ID)

assigneesArray of objects(Assignees)<= 120 itemsrequired
assignees[].​idstring(Id)required

Identity of the appliance

descriptionstring(Description)

Description for the resource

groupsArray of strings(Groups)

Groups to be associated with the resource

labelstring(Label)

Consumer-defined label for the resource

lifecycleEventKeystring(Lifecycleeventkey)

Key for resource lifecycle event messages

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/secrets \
  -H 'Content-Type: application/json' \
  -d '{
    "assignees": [
      {
        "id": "string"
      }
    ],
    "name": "string",
    "secret": {
      "azureSPClient": {}
    },
    "service": "string"
  }'

Responses

Successful Response

Bodyapplication/json
customerIdstring(Customerid)required

Identifier of the customer owning the resource

servicestring(Service)required

Name of the service originating the resource

idstring(uuid)(Id)required

Identifier of the resource

namestring(Name)required

Name of the resource

typestring(Type)required

Type of the resource

resourceUristring(Resourceuri)required

URI of the resource

generationinteger(Generation)required

Update generation number

updatedAtstring(date-time)(Updatedat)required

Timestamp of the last resource update

createdAtstring(date-time)(Createdat)required

Timestamp of the resource creation

domainobject(Domain)required

Resource domain definition

domain.​namestring(Name)required

Name of the resource domain

domain.​propertiesobject(Properties)

Resource domain properties

classifierobject(Classifier)required

Resource classifier definition

classifier.​namestring(Name)required

Name of the resource classifier

subclassifierobject(Subclassifier)required

Resource Subclassifier Definition (e.g. BASIC_AUTH)

subclassifier.​namestring(Name)required

Name of the resource subclassifier

subclassifier.​propertiesobject(Properties)

Resource subclassifier properties

statusstring(Status)required

Status of the resource

statusUpdatedAtstring(date-time)(Statusupdatedat)required

Timestamp of the last status update

assignmentsCountinteger(Assignmentscount)

Count of associated assignment resources

Default 0
groupsArray of objects(Groups)

Groups associated with the resource

labelstring(Label)

Consumer-defined label of the resource

Response
application/json
{
  "assignmentsCount": 0,
  "classifier": {
    "name": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "domain": {
    "name": "string",
    "properties": {}
  },
  "generation": 0,
  "groups": [
    { … }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "label": "string",
  "name": "string",
  "resourceUri": "string",
  "service": "string",
  "status": "string",
  "statusUpdatedAt": "2019-08-24T14:15:22Z",
  "subclassifier": {
    "name": "string",
    "properties": {}
  },
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Removes a secret

Request

Removes the specified secret. All associated assignments will also be removed.

Path
idstring(uuid)(Id)required

UUID of the secret

Query
safeboolean(Safe)

Enable delete-lock safety checking

Default false
Headers
x-envoy-external-addressstring(X-Envoy-External-Address)
Default
x-forwarded-forstring(X-Forwarded-For)
Default 
curl -i -X DELETE \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/secrets/{id}'

Responses

Successful Response

Response
No content

Reports a specific secret

Request

Reports the attributes and properties of the specified secret.

Path
idstring(uuid)(Id)required

UUID of the secret

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/secrets/{id}'

Responses

Successful Response

Bodyapplication/json
customerIdstring(Customerid)required

Identifier of the customer owning the resource

servicestring(Service)required

Name of the service originating the resource

idstring(uuid)(Id)required

Identifier of the resource

namestring(Name)required

Name of the resource

typestring(Type)required

Type of the resource

resourceUristring(Resourceuri)required

URI of the resource

generationinteger(Generation)required

Update generation number

updatedAtstring(date-time)(Updatedat)required

Timestamp of the last resource update

createdAtstring(date-time)(Createdat)required

Timestamp of the resource creation

domainobject(Domain)required

Resource domain definition

domain.​namestring(Name)required

Name of the resource domain

domain.​propertiesobject(Properties)

Resource domain properties

classifierobject(Classifier)required

Resource classifier definition

classifier.​namestring(Name)required

Name of the resource classifier

subclassifierobject(Subclassifier)required

Resource Subclassifier Definition (e.g. BASIC_AUTH)

subclassifier.​namestring(Name)required

Name of the resource subclassifier

subclassifier.​propertiesobject(Properties)

Resource subclassifier properties

statusstring(Status)required

Status of the resource

statusUpdatedAtstring(date-time)(Statusupdatedat)required

Timestamp of the last status update

assignmentsCountinteger(Assignmentscount)

Count of associated assignment resources

Default 0
groupsArray of objects(Groups)

Groups associated with the resource

labelstring(Label)

Consumer-defined label of the resource

Response
application/json
{
  "assignmentsCount": 0,
  "classifier": {
    "name": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "domain": {
    "name": "string",
    "properties": {}
  },
  "generation": 0,
  "groups": [
    { … }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "label": "string",
  "name": "string",
  "resourceUri": "string",
  "service": "string",
  "status": "string",
  "statusUpdatedAt": "2019-08-24T14:15:22Z",
  "subclassifier": {
    "name": "string",
    "properties": {}
  },
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Changes a secret

Request

Changes an existing secret using the provided redefinition.

Path
idstring(uuid)(Id)required

UUID of the secret

Headers
x-envoy-external-addressstring(X-Envoy-External-Address)
Default
x-forwarded-forstring(X-Forwarded-For)
Default
Body
required
Any of:

Secret Redefinition

secretAzureSPClientSecretRedef (object) or BasicAuthSecretRedef (object) or BearerAuthSecretRedef (object) or CertificateSecretRedef (object) or GenericSecretRedef (object) or JsonWebTokenSecretRedef (object) or OAuthClientSecretRedef (object) or PasswordSecretRedef (object) or PrivateKeySecretRedef (object) or SSHKeypairSecretRedef (object)(Secret)required

Secret redefinition

Any of:

Azure Service Principal client secret redefinition

secret.​azureSPClientobject(Azurespclient)required

Azure Service Principal client secret properties

secret.​azureSPClient.​clientIdstring(Clientid)

Azure Service Principal client ID (aka application ID)

secret.​azureSPClient.​clientSecretstring(Clientsecret)

Azure Service Principal client secret

secret.​azureSPClient.​tenantIdstring(Tenantid)

Azure Service Principal tenant ID (aka directory ID)

descriptionstring(Description)

Description for the resource

groupsArray of strings(Groups)

Groups to be associated with the resource

curl -i -X PATCH \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/secrets/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "secret": {
      "azureSPClient": {}
    }
  }'

Responses

Successful Response

Bodyapplication/json
customerIdstring(Customerid)required

Identifier of the customer owning the resource

servicestring(Service)required

Name of the service originating the resource

idstring(uuid)(Id)required

Identifier of the resource

namestring(Name)required

Name of the resource

typestring(Type)required

Type of the resource

resourceUristring(Resourceuri)required

URI of the resource

generationinteger(Generation)required

Update generation number

updatedAtstring(date-time)(Updatedat)required

Timestamp of the last resource update

createdAtstring(date-time)(Createdat)required

Timestamp of the resource creation

domainobject(Domain)required

Resource domain definition

domain.​namestring(Name)required

Name of the resource domain

domain.​propertiesobject(Properties)

Resource domain properties

classifierobject(Classifier)required

Resource classifier definition

classifier.​namestring(Name)required

Name of the resource classifier

subclassifierobject(Subclassifier)required

Resource Subclassifier Definition (e.g. BASIC_AUTH)

subclassifier.​namestring(Name)required

Name of the resource subclassifier

subclassifier.​propertiesobject(Properties)

Resource subclassifier properties

statusstring(Status)required

Status of the resource

statusUpdatedAtstring(date-time)(Statusupdatedat)required

Timestamp of the last status update

assignmentsCountinteger(Assignmentscount)

Count of associated assignment resources

Default 0
groupsArray of objects(Groups)

Groups associated with the resource

labelstring(Label)

Consumer-defined label of the resource

Response
application/json
{
  "assignmentsCount": 0,
  "classifier": {
    "name": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "domain": {
    "name": "string",
    "properties": {}
  },
  "generation": 0,
  "groups": [
    { … }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "label": "string",
  "name": "string",
  "resourceUri": "string",
  "service": "string",
  "status": "string",
  "statusUpdatedAt": "2019-08-24T14:15:22Z",
  "subclassifier": {
    "name": "string",
    "properties": {}
  },
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

settings

Settings API

Operations

software-releases

Software Releases

Operations

storage-locations

storage-locations API.

Operations

tags

Tags APIs

Operations