diff --git a/v1/html/index.html b/v1/html/index.html index 6e8e3b3..a105727 100644 --- a/v1/html/index.html +++ b/v1/html/index.html @@ -3000,7 +3000,7 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
[
  • {
    }
]

Create a new OS service image

Adds a new OS service image that can be referenced during host creation. If GreenLake Cloud Services IAM issued token is used for authentication, then it is required to pass either 'spaceid' header or 'Space' header. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers. Note that Hoster or BMaaS Access Owner role is required for this operation.

+
https://client.greenlake.hpe.com{basePath}/services

Response samples

Content type
application/json
[
  • {
    }
]

Create a new OS service image

Adds a new OS service image that can be referenced during host creation. If GreenLake Cloud Services IAM issued token is used for authentication, then it is required to pass either 'spaceid' header or 'Space' header. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers. Note that Hoster or BMaaS Access Owner role is required for this operation.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
spaceid
string
Example: 95688cf9-82ff-4e32-80fc-2b0b41648dab

GreenLake Cloud Services space ID

Space
string
Example: Default

GreenLake Cloud Services space name

X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

@@ -3012,7 +3012,7 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of the image",
  • "Category": "linux",
  • "Flavor": "ubuntu",
  • "Version": "20.04.5",
  • "Origin": "Custom",
  • "Timeout": 1000,
  • "DeviceLayouts": [
    ],
  • "PermittedProjects": [
    ],
  • "Files": [
    ],
  • "Info": [
    ],
  • "Approach": "vmedia",
  • "AssumedBootMethod": "na",
  • "NoSwitchLAG": false,
  • "BondMode": "none",
  • "FWBaselineID": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "UserDefinedSteps": {
    },
  • "Classifiers": [
    ]
}

Retrieve an OS service image

Returns a single OS service image object with its matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
https://client.greenlake.hpe.com{basePath}/services

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of the image",
  • "Category": "linux",
  • "Flavor": "ubuntu",
  • "Version": "20.04.5",
  • "Origin": "Custom",
  • "Timeout": 1000,
  • "DeviceLayouts": [
    ],
  • "PermittedProjects": [
    ],
  • "Files": [
    ],
  • "Info": [
    ],
  • "Approach": "vmedia",
  • "AssumedBootMethod": "na",
  • "NoSwitchLAG": false,
  • "BondMode": "none",
  • "FWBaselineID": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "UserDefinedSteps": {
    },
  • "Classifiers": [
    ]
}

Retrieve an OS service image

Returns a single OS service image object with its matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
serviceId
required
string

ID of OS service image to return

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

@@ -3022,7 +3022,7 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of the image",
  • "Category": "linux",
  • "Flavor": "ubuntu",
  • "Version": "20.04.5",
  • "Origin": "Custom",
  • "Timeout": 1000,
  • "DeviceLayouts": [
    ],
  • "PermittedProjects": [
    ],
  • "Files": [
    ],
  • "Info": [
    ],
  • "Approach": "vmedia",
  • "AssumedBootMethod": "na",
  • "NoSwitchLAG": false,
  • "BondMode": "none",
  • "FWBaselineID": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "UserDefinedSteps": {
    },
  • "Classifiers": [
    ]
}

Update an OS service image by its ID

Updates an OS service image with a matching ID. Note that Hoster or BMaaS Access Owner role is required for this operation under GreenLake Cloud Services. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
https://client.greenlake.hpe.com{basePath}/services/{serviceId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of the image",
  • "Category": "linux",
  • "Flavor": "ubuntu",
  • "Version": "20.04.5",
  • "Origin": "Custom",
  • "Timeout": 1000,
  • "DeviceLayouts": [
    ],
  • "PermittedProjects": [
    ],
  • "Files": [
    ],
  • "Info": [
    ],
  • "Approach": "vmedia",
  • "AssumedBootMethod": "na",
  • "NoSwitchLAG": false,
  • "BondMode": "none",
  • "FWBaselineID": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "UserDefinedSteps": {
    },
  • "Classifiers": [
    ]
}

Update an OS service image by its ID

Updates an OS service image with a matching ID. Note that Hoster or BMaaS Access Owner role is required for this operation under GreenLake Cloud Services. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
serviceId
required
string

ID of OS service image to update

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

@@ -3035,7 +3035,7 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of the image",
  • "Category": "linux",
  • "Flavor": "ubuntu",
  • "Version": "20.04.5",
  • "Origin": "Custom",
  • "Timeout": 1000,
  • "DeviceLayouts": [
    ],
  • "PermittedProjects": [
    ],
  • "Files": [
    ],
  • "Info": [
    ],
  • "Approach": "vmedia",
  • "AssumedBootMethod": "na",
  • "NoSwitchLAG": false,
  • "BondMode": "none",
  • "FWBaselineID": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "UserDefinedSteps": {
    },
  • "Classifiers": [
    ]
}

Delete an OS service image

Deletes the OS service image with the matching ID. Note that Hoster or BMaaS Access Owner role is required for this operation under GreenLake Cloud Services. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

+
https://client.greenlake.hpe.com{basePath}/services/{serviceId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of the image",
  • "Category": "linux",
  • "Flavor": "ubuntu",
  • "Version": "20.04.5",
  • "Origin": "Custom",
  • "Timeout": 1000,
  • "DeviceLayouts": [
    ],
  • "PermittedProjects": [
    ],
  • "Files": [
    ],
  • "Info": [
    ],
  • "Approach": "vmedia",
  • "AssumedBootMethod": "na",
  • "NoSwitchLAG": false,
  • "BondMode": "none",
  • "FWBaselineID": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "UserDefinedSteps": {
    },
  • "Classifiers": [
    ]
}

Delete an OS service image

Deletes the OS service image with the matching ID. Note that Hoster or BMaaS Access Owner role is required for this operation under GreenLake Cloud Services. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
serviceId
required
string

ID of OS service image to delete

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

@@ -3047,7 +3047,11 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}